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.

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

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from

Conversation

emmanuelmathot
Copy link
Collaborator

Related Issue(s): #1251

Proposed Changes:

  1. ItemCollection
  2. CollectionCollection

PR Checklist:

  • This PR is made against the dev branch (all proposed changes except releases should be against dev, not master).
  • This PR has no breaking changes.
  • I have added my changes to the CHANGELOG
    or a CHANGELOG entry is not required.
  • This PR affects the STAC API spec,
    and I have opened issue/PR #XXX to track the change.

@m-mohr m-mohr changed the title Dewscribe ItemCollection and CollectionCollection Describe ItemCollection and CollectionCollection Jun 27, 2024
@m-mohr
Copy link
Collaborator

m-mohr commented Jun 27, 2024

#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 m-mohr added this to the 1.1 milestone Jun 27, 2024
@m-mohr m-mohr removed a link to an issue Jun 28, 2024
@emmanuelmathot
Copy link
Collaborator Author

@m-mohr sections are moved to READMEs but I am not sure to understand what you meant by context. Please review

@emmanuelmathot emmanuelmathot self-assigned this Jul 4, 2024
@emmanuelmathot emmanuelmathot marked this pull request as ready for review July 4, 2024 07:44
item-spec/README.md Outdated Show resolved Hide resolved
Comment on lines +47 to +53

## 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.
Copy link
Collaborator

@m-mohr m-mohr Jul 4, 2024

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:

Suggested change
## 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...

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

in STAC API spec?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Yes. Alongside the ItemCollection

Copy link
Collaborator Author

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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Define ItemCollection in stac-spec
2 participants