Skip to content

add optional numberMatched and numberReturned fields to ItemCollection #338

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 1 commit into from
Oct 13, 2022
Merged

add optional numberMatched and numberReturned fields to ItemCollection #338

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased] - TBD

### Added

- Added optional `numberMatched` and `numberReturned` fields to ItemCollection to align with OGC Commons
and OAFeat.

### Changed

- Browseable specification has been incorporated into the *STAC API - Core* specification.
Expand Down
12 changes: 7 additions & 5 deletions fragments/itemcollection/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ required fields is a valid STAC ItemCollection.

This object describes a STAC ItemCollection. The fields `type` and `features` are inherited from GeoJSON FeatureCollection.

| Field Name | Type | Description |
| ---------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| type | string | **REQUIRED.** Always "FeatureCollection" to provide compatibility with GeoJSON. |
| features | \[[STAC Item](../../stac-spec/item-spec/item-spec.md)] | **REQUIRED** A possibly-empty array of Item objects. |
| links | \[[Link Object](../../stac-spec/item-spec/item-spec.md#link-object)] | An array of Links related to this ItemCollection. |
| Field Name | Type | Description |
| -------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
| type | string | **REQUIRED.** Always "FeatureCollection" to provide compatibility with GeoJSON. |
| features | \[[STAC Item](../../stac-spec/item-spec/item-spec.md)] | **REQUIRED.** A possibly-empty array of Item objects. |
| links | \[[Link Object](../../stac-spec/item-spec/item-spec.md#link-object)] | An array of Links related to this ItemCollection. |
| numberMatched | integer | The number of Items that meet the selection parameters, possibly estimated. |
| numberReturned | integer | The number of Items in the `features` array. |

## Extensions

Expand Down
2 changes: 2 additions & 0 deletions fragments/itemcollection/examples/itemcollection-sample-full.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"type": "FeatureCollection",
"numberMatched": 10,
"numberReturned": 1,
"features": [
{
"stac_version": "1.0.0",
Expand Down
6 changes: 6 additions & 0 deletions fragments/itemcollection/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,9 @@ components:
- rel: next
href: >-
http://api.cool-sat.com/search?next=ANsXtp9mrqN0yrKWhf-y2PUpHRLQb1GT-mtxNcXou8TwkXhi1Jbk
numberMatched:
type: integer
minimum: 0
numberReturned:
type: integer
minimum: 0