require children endpoint to return all child link objects #265
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
| It is recommended that the Catalog and Collection objects returned by the `/children` endpoint are the same | ||
| as those referenced by `child` link relations in the STAC API Landing Page. Following these semantics, it should | ||
| return the immediate children of the root Catalog, rather than all descendant catalogs or collections. | ||
| it contains using the link relation `children` to an endpoint `/children`. The `/children` endpoint shall |
There was a problem hiding this comment.
Just 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.
I just looked. We use must a lot more than shall. I'd prefer must also, since shall seems overly formal in English. I'll file an issue to make these consistent.
m-mohr
approved these changes
Mar 3, 2022
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)