Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add text around when to include an extension in stac_extensions #1123

Merged
merged 8 commits into from
May 11, 2021
Merged

Add text around when to include an extension in stac_extensions #1123

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d87813d
Clarify when to include extensions in stac_extensions
lossyrob May 5, 2021
cd08d4a
Fix TOC ordering in extensions
lossyrob May 5, 2021
59a8cf4
Update CHANGELOG
lossyrob May 5, 2021
ea3ee26
reorg and edits
cholmes May 5, 2021
b24066e
update from PR review
cholmes May 10, 2021
c9323e4
line break for linting
cholmes May 10, 2021
bf02447
updates from PR review
cholmes May 11, 2021
90a2cbd
line break for linting
cholmes May 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion extensions/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ with the template.

The logic for when an object should list an extension ID in its `stac_extension` array is as follows:

- If the object directly implements the extension, the `stac_extensions` of that object should contain the extension ID.
- If the object directly implements the extension (by including at least one of the fields of the extension, plus any additional specified requirements), the `stac_extensions` of that object should contain the extension ID.
Copy link
Collaborator

@m-mohr m-mohr May 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As there may be some extensions that don't add fields, maybe say something like:

by including at least one of the fields of the extension (if there are any) or implementing proposed behaviors, plus any additional specified requirements.

Please improve my wording, it seems like a very "German" way of writing it...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will there be extensions that don't add fields? What would they do?

If there are ones that don't add fields then I think I might just say '(by including the fields specified by the extension)'

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

e.g. define asset roles or rel types. Or behavior such as the commons extension or the external item properties.

- If an Asset implements fields of the extension, then `stac_extensions` of the Item or Collection which holds that
Asset should contain the extension ID.
- If a Collection [summary](../collection-spec/collection-spec.md#summaries) contains Item fields that implement an extension, then
Expand Down