Bbox improvements #50
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
m-mohr
requested changes
Nov 3, 2020
api-spec.md
Outdated
| @@ -135,7 +135,7 @@ This Link should look like: | |||
|
|
|||
| Unless otherwise noted by **Path-only**, these filters are passed as query string parameters, form parameters, or JSON | |||
| entity fields. For filters that represent a set of values, query and form parameters should use comma-separated | |||
| string values and JSON entity attributes should use JSON Arrays. | |||
| string values (with no outer brackets \[ or \]) and JSON entity attributes should use JSON Arrays. | |||
There was a problem hiding this comment.
I'm confused. So it's comma separated values, but "JSON entity attributes should use JSON Arrays"? Does that conflict? What does "JSON entity attributes should use JSON Arrays" actually mean?
There was a problem hiding this comment.
I'm 90% sure that this means:
- If you are using query string parameters (GET request to
/search/) you should do bbox=10,10,20,20 - If you are using JSON requests (POST to
/search/) then you should do "bbox": [10,10,20,20]
But obviously, that is not clear. If my explanation makes sense then I can expand this description out. It occurs to me we should also just remove the 'form parameters', and perhaps put it back in if we do #4
There was a problem hiding this comment.
Oh, I see. Let's better improve that, too, but I'm approving anyway for now as the main issue has been solved.
m-mohr
approved these changes
Nov 3, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s): #28 #47
Proposed Changes:
PR Checklist:
npm run generate-allto update the generated OpenAPI files.