Assign specific media types to relation types#1259
Merged
Conversation
cc20204 to
9cef574
Compare
9cef574 to
47f8e2d
Compare
gadomski
reviewed
Oct 9, 2023
Collaborator
gadomski
left a comment
There was a problem hiding this comment.
Two questions:
- Is there a place in the spec where it would be appropriate to link into
OGC API - Recordsto indicate the intent to align? It'd be good to preserve the reason behind this change in the documentation somewhere, and I'm not sure the CHANGELOG is the right place? - Is there a place in the spec where it would be appropriate to warn clients/consumers about the need to filter hierarchical links by media type (e.g. how you told me about it in stac-utils/pystac#1255)? I'm not sure it would be obvious to new implementors that there could be other
itemlinks that they shouldn't load as anItem.
Co-authored-by: Pete Gadomski <[email protected]>
philvarner
approved these changes
Oct 10, 2023
Collaborator
Author
|
Yes, we should probably add what @gadomski proposed. |
Collaborator
Author
emmanuelmathot
approved these changes
May 15, 2024
gadomski
reviewed
May 15, 2024
gadomski
requested changes
May 15, 2024
Collaborator
gadomski
left a comment
There was a problem hiding this comment.
Needs one header text in a table.
Collaborator
Author
|
@gadomski Fixed, please re-review. |
gadomski
approved these changes
May 15, 2024
This file contains hidden or 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
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): None
Proposed Changes:
Clarified which media types should be used for the hierarchical relation types.
Intention is to make clients more aware of checking media types as with OGC API - Records etc. we'll run more and more into examples where the media types could be different.
Example with a child link with JSON & HTML media types: https://api.weather.gc.ca/stac/?f=json
or as a JSON excerpt:
{ "type":"Catalog", ... "links":[ { "rel":"child", "href":"https://api.weather.gc.ca/stac/msc-datamart?f=json", "type":"application/json" }, { "rel":"child", "href":"https://api.weather.gc.ca/stac/msc-datamart", "type":"text/html" } ] }Nothing in the spec disallows this, I think.
And we should not disallow it iMHO, to keep compliant with OGC API - Records.
PR Checklist:
or a CHANGELOG entry is not required.
and I have opened issue/PR #XXX to track the change.