Skip to content

Commit

Permalink
Merge pull request #13 from stac-api-extensions/pv/release-1.0.0
Browse files Browse the repository at this point in the history
release prep for 1.0.0
  • Loading branch information
matthewhanson authored Sep 28, 2023
2 parents 1b73af7 + 6c67c83 commit 6662435
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 12 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [v1.0.0] - 2022-09-28

### Changed

Expand Down Expand Up @@ -39,7 +39,8 @@ None
Versions [v1.0.0-rc.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1) and
prior can be found in the [stac-api-spec](https://github.com/radiantearth/stac-api-spec/) repo

[Unreleased]: <https://github.com/stac-api-extensions/fields/compare/v1.0.0-rc.3...main>
[Unreleased]: <https://github.com/stac-api-extensions/fields/compare/v1.0.0...main>
[v1.0.0]: <https://github.com/stac-api-extensions/fields/tree/v1.0.0>
[v1.0.0-rc.3]: <https://github.com/stac-api-extensions/fields/tree/v1.0.0-rc.3>
[v1.0.0-rc.2]: <https://github.com/stac-api-extensions/fields/tree/v1.0.0-rc.2>
[v1.0.0-rc.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1>
Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@
- **Title:** Fields
- **OpenAPI specification:** [openapi.yaml](openapi.yaml)
- **Conformance Classes:**
- `STAC API - Item Search` binding: <https://api.stacspec.org/v1.0.0-rc.3/item-search#fields>
- `STAC API - Features` binding: <https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features#fields>
- `STAC API - Item Search` binding: <https://api.stacspec.org/v1.0.0/item-search#fields>
- `STAC API - Features` binding: <https://api.stacspec.org/v1.0.0/ogcapi-features#fields>
- **Scope:** STAC API - Features, STAC API - Item Search
- **[Extension Maturity Classification](https://github.com/radiantearth/stac-api-spec/tree/main/README.md#maturity-classification):** Candidate
- **Dependencies:**
- [STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3/item-search)
- [STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3/ogcapi-features)
- [STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/item-search)
- [STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/ogcapi-features)
- **Owner**: none

By default, STAC API endpoints that return Item objects return every field of those Items. However,
Expand All @@ -32,9 +32,9 @@ fields in an Item are used, so this
specification provides a mechanism for clients to request that servers to explicitly include or exclude certain fields.

This behavior may be bound to either or both of
[STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3/item-search) (`/search` endpoint) or
[STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3/ogcapi-features)
(`/collections/{collectionId}/items` endpoint) by advertising the relevant conformance class.
[STAC API - Item Search](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/item-search) (`/search` endpoint) or
[STAC API - Features](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0/ogcapi-features)
(`/collections/{collectionId}/items` endpoint) by advertising the relevant conformance class.

When used in a POST request with `Content-Type: application/json`, this adds an attribute `fields` with
an object value to the core JSON search request body. The `fields` object contains two attributes with string array
Expand All @@ -61,7 +61,7 @@ must be returned and the Item entities will not contain that
field.

If no `fields` are specified, the response is **must** be a valid
[ItemCollection](https://github.com/radiantearth/stac-spec/tree/v1.0.0-rc.3/itemcollection/README.md). If a client excludes
[ItemCollection](https://github.com/radiantearth/stac-spec/tree/v1.0.0/itemcollection/README.md). If a client excludes
fields that are required in a STAC Item, the server may return an invalid STAC Item. For example, if `type`
and `geometry` are excluded, the entity will not even be a valid GeoJSON Feature, or if `bbox` is excluded then the entity
will not be a valid STAC Item.
Expand Down
4 changes: 2 additions & 2 deletions openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ info:
name: Apache License 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0'
x-conformance-classes:
- 'https://api.stacspec.org/v1.0.0-rc.3/item-search#fields'
- 'https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features#fields'
- 'https://api.stacspec.org/v1.0.0/item-search#fields'
- 'https://api.stacspec.org/v1.0.0/ogcapi-features#fields'
paths: {}
components:
parameters:
Expand Down

0 comments on commit 6662435

Please sign in to comment.