Skip to content

Fix collection description #45

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

Merged
merged 2 commits into from
Oct 5, 2020
Merged

Fix collection description #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4695def
update API spec description of /collections result type to match OAFeat
Sep 23, 2020
46d6f7f
update CHANGELOG
Sep 23, 2020
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ For changes in 0.9.0 and prior, see the [STAC Spec Changelog](https://github.com
### Changed
- Context Extension OpenAPI spec was updated to remove the no longer used `next` attribute
- Added root endpoint Link `search` must have `type` of `application/geo+json`
- Corrected the description of endpoint `/collections` to say it returns an object per OAFeat, instead of an array of Collection

### Fixed

Expand Down
4 changes: 3 additions & 1 deletion api-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,11 +83,13 @@ The core OGC API - Features endpoints are shown below, with details provided in
| ------------ | ------------- | ----------- |
| / | JSON | Landing page, links to API capabilities |
| /conformance | JSON | Info about standards to which the API conforms |
| /collections | [Collection] | List of Collections contained in the catalog |
| /collections | JSON | List of Collections contained in the catalog |
| /collections/{collectionId} | Collection | Returns single Collection JSON |
| /collections/{collectionId}/items | ItemCollection | GeoJSON FeatureCollection-conformant entity of Items in collection |
| /collections/{collectionId}/items/{featureId} | Item | Returns single Item (GeoJSON Feature) |

The `/collections` endpoint returns an object with a field `collections` that is an array of Collection objects.

The `/collections/{collection_id}/items` endpoint accepts parameters for filtering the results (also called filters).
Items in the collection should match all filters to be returned when querying. This implies a logical AND operation. If
an OR operation is needed, it should be specified through an extension filter.
Expand Down