clarify wording of search link rel requirement #267
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
cholmes
approved these changes
Mar 2, 2022
m-mohr
reviewed
Mar 3, 2022
| @@ -55,8 +55,11 @@ The following Link relations shall exist in the Landing Page (root). | |||
| | -------- | --------- | ---------------------- | --------------------------- | | |||
| | `search` | `/search` | STAC API - Item Search | URI for the Search endpoint | | |||
|
|
|||
| The `search` link relation shall have a `type` of `application/geo+json` and a `method` of `GET`, and may also | |||
| a link with a `method` of `POST` if the server supports it. | |||
| This `search` link relation shall have a `type` of `application/geo+json`. If no `method` attribute is | |||
There was a problem hiding this comment.
Maybe it only SHOULD have it or let's say the default for search could probably be application/geo+json. We do the same with most other links, e.g. child, item, ...
There was a problem hiding this comment.
And a general observation, but I think we mostly use MUST instead of SHALL in the documentation. Your recent PRs use SHALL and I think we should be more consistent here. Could we try to use MUST instead of SHALL? I just had to look it up again whether SHALL was equal to MUST or SHOULD and found it confusing.
There was a problem hiding this comment.
Filed #275 to discuss
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):
Proposed Changes:
PR Checklist:
stac-specdirectory (these are included as a subtree and should be updated directly in radiantearth/stac-spec)