Update location-retrieval with add maxSurface management
#262
Conversation
Add `maxSurface` management
🦙 MegaLinter status: ✅ SUCCESS
See detailed report in MegaLinter reports MegaLinter is graciously provided by |
| @@ -525,6 +545,13 @@ components: | |||
| status: 422 | |||
| code: LOCATION_RETRIEVAL.UNABLE_TO_FULFILL_MAX_AGE | |||
| message: "Unable to provide expected freshness for location" | |||
| LOCATION_RETRIEVAL_422_UNABLE_TO_FULFILL_MAX_SURFACE: | |||
There was a problem hiding this comment.
If the calculated area violates both age and surface conditions, is the implementer free to choose which 422 code to return ?
As an implementation note, we could recommend to check the age condition first because area comparison can require more computation than age comparison.
There was a problem hiding this comment.
Good point. I've added a note: if both maxAge and maxSurface requirements fail, the system can either send back one or the other error code.
I agree on your recommendation but not sure if we have to add in the yaml as it is more for the system than the client.
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. `
Fix linting error
|
|
||
| maxSurface: | ||
| type: integer | ||
| minimum: 1 |
There was a problem hiding this comment.
Not sure what would be realistically the minimum that a "best" implemention may provide, but likely above 100 m2. We may set 1 here and let implementations provide the minimum supported separately.
There was a problem hiding this comment.
As we allow a min radius of 1 probably we cannot have a min of 100m2. Probably good to add an note indicating that implementations will provide minimum.
Co-authored-by: Jose Luis Urien <[email protected]>
Add a note for maxSurface minimum allowed.
Co-authored-by: Jose Luis Urien <[email protected]>
| * **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). |
There was a problem hiding this comment.
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).
What type of PR is this?
Add one of the following kinds:
What this PR does / why we need it:
add
maxSurfacemanagementWhich issue(s) this PR fixes:
Fixes #255
Special notes for reviewers:
Changelog input
Additional documentation
This section can be blank.