-
Notifications
You must be signed in to change notification settings - Fork 179
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.
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
Describe ItemCollection and CollectionCollection #1290
base: dev
Are you sure you want to change the base?
Conversation
#1251 says that we actually only want to link to both specs from certain places, we won't define them in STAC core as the concepts don't exist for static catalogs. I think mentioning this without context is confusing, maybe they better go into the READMEs, not the spec document. ItemCollection is defined in stac-api-spec, CollectionCollection has no fragment in the API yet and is only defined in the API spec's openAPI document. |
@m-mohr sections are moved to READMEs but I am not sure to understand what you meant by context. Please review |
|
||
## Generic Collection of Collections | ||
|
||
In some cases, a set of Collections must be grouped together in a unique file such as in the response | ||
of the [collections search in a catalog](https://github.com/radiantearth/stac-api-spec/tree/release/v1.0.0/ogcapi-features#collections-collections). | ||
When a set of Items must be grouped together in unique file, the [CollectionCollection](https://github.com/radiantearth/stac-api-spec/blob/604ade6158de15b8ab068320ca41e25e2bf0e116/ogcapi-features/openapi-collections.yaml#L121) | ||
structure as defined in STAC API must be used. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think I'd tone this down a bit:
## Generic Collection of Collections | |
In some cases, a set of Collections must be grouped together in a unique file such as in the response | |
of the [collections search in a catalog](https://github.com/radiantearth/stac-api-spec/tree/release/v1.0.0/ogcapi-features#collections-collections). | |
When a set of Items must be grouped together in unique file, the [CollectionCollection](https://github.com/radiantearth/stac-api-spec/blob/604ade6158de15b8ab068320ca41e25e2bf0e116/ogcapi-features/openapi-collections.yaml#L121) | |
structure as defined in STAC API must be used. | |
> \[!NOTE] | |
> In cases where a set of Collections is grouped together (e.g. for providing search results), | |
> the [CollectionCollection](https://github.com/radiantearth/stac-api-spec/blob/604ade6158de15b8ab068320ca41e25e2bf0e116/ogcapi-features/openapi-collections.yaml#L121) | |
> object has been defined in the STAC API specification. |
In was wondering whether we should create a fragment similar to the ItemCollection an link to that...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
in STAC API spec?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Alongside the ItemCollection
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok will do the pr in api
Co-authored-by: Matthias Mohr <[email protected]>
Related Issue(s): #1251
Proposed Changes:
PR Checklist:
or a CHANGELOG entry is not required.
and I have opened issue/PR #XXX to track the change.