Skip to content

Update location-retrieval with add maxSurface management#262

Merged
jlurien merged 8 commits intomainfrom
bigludo7/maxSurface
Jan 15, 2025
Merged

Update location-retrieval with add maxSurface management#262
jlurien merged 8 commits intomainfrom
bigludo7/maxSurface

Conversation

@bigludo7
Copy link
Collaborator

@bigludo7 bigludo7 commented Oct 1, 2024

What type of PR is this?

Add one of the following kinds:

  • enhancement/feature

What this PR does / why we need it:

add maxSurface management

Which issue(s) this PR fixes:

Fixes #255

Special notes for reviewers:

Changelog input

 release-note
- Add management of maxSurface in request.

Additional documentation

This section can be blank.

docs

Add `maxSurface` management
@github-actions
Copy link

github-actions bot commented Oct 1, 2024

🦙 MegaLinter status: ✅ SUCCESS

Descriptor Linter Files Fixed Errors Elapsed time
✅ ACTION actionlint 2 0 0.02s
✅ OPENAPI spectral 3 0 4.95s
✅ REPOSITORY git_diff yes no 0.01s
✅ REPOSITORY secretlint yes no 0.77s
✅ YAML yamllint 3 0 0.73s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by OX Security

Fixing linting + adding precision as suggested by @alpaycetin74: 
`Note: if both `maxAge` and `maxSurface` requirements fail, the system can either send back one or the other error code.  `
jlurien
jlurien previously approved these changes Oct 7, 2024
Copy link
Collaborator

@jlurien jlurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with minor correction and comment

Co-authored-by: Jose Luis Urien <joseluis.urienpinedo@telefonica.com>
Add a note for maxSurface minimum allowed.
bigludo7 and others added 2 commits December 17, 2024 09:39
Co-authored-by: Jose Luis Urien <joseluis.urienpinedo@telefonica.com>
* **Max Surface**: Maximum surface in square meters which is accepted by the client for the location retrieval.

* absence of `maxSurface` means that "any surface size" is acceptable for the client.
* API implementation could specify in the documentation the `maxSurface` minimum acceptable (for exemple minimun of 10000 square meters allowed).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to propose a minor rewording here, and fixing some typos:
API implementation could specify the minimum acceptable maxSurface in the documentation (for example a minimum of 10000 square meters are allowed).

@bigludo7 bigludo7 self-assigned this Dec 18, 2024
jlurien
jlurien previously approved these changes Jan 13, 2025
Copy link
Collaborator

@jlurien jlurien left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With suggestion

Co-authored-by: Jose Luis Urien <joseluis.urienpinedo@telefonica.com>
@jlurien jlurien merged commit 30ee7c1 into main Jan 15, 2025
1 check passed
@bigludo7 bigludo7 deleted the bigludo7/maxSurface branch January 15, 2025 20:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Spring25 Meta-release Spring25

Projects

None yet

Development

Successfully merging this pull request may close these issues.

How to understand the response parameter area in the device retrieval API

3 participants