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

Filter Extension - Conformance classes realign #202

Merged
merged 18 commits into from
Oct 5, 2021
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
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
16 changes: 15 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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]
## [Unreleased - v1.0.0-beta4] - TBD

### Added

Expand All @@ -14,6 +14,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Changed

- Filter Extension - query language is now referred to as "CQL2" rather than CQL
- Filter Extension now uses OAFeat Part 3 conformance class URIs
- Filter Extension - The following changes have been made to the Filter Extension conformance classes to align with changes to the OAFeat CQL draft. All classes
whose names have changed also have changed conformance URI strings.
- "Basic CQL" now includes the "not equal" operator (`<>`)
- "Basic CQL" has always supported datetime comparisons, but this is now explicitly mentioned
- "Enhanced Comparison Operators" has been renamed "Advanced Comparison Operators". This is the same as the OAFeat CQL definition, except
that it does not require the `upper` and `lower` functions.
- "Enhanced Spatial Operators" has been renamed to just "Spatial Operators" (not to be confused with Basic Spatial Operators)
- "Basic Temporal Operators" and "Enhanced Temporal Operators" have merged into "Temporal Operators"
- "Functions" has been renamed "Custom Functions"
- "Arithmetic" has been renamed "Arithmetic Expressions"
- "Arrays" has been renamed "Array Operators"
- "Queryable Second Operand" has been renamed "Property-Property Comparisons"
- The required Link Relations and endpoints for each conformance class now use the wording of 'shall'
instead of 'should'. While this technically changes the semantics, it was generally understood
previously the semantics were those of 'shall' (must).
Expand Down
15 changes: 8 additions & 7 deletions collections/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# STAC API - Collections

- [STAC API - Collections](#stac-api---collections)
- [Link Relations](#link-relations)
- [Endpoints](#endpoints)
- [Example](#example)
- [Conformance](#conformance)
- [Link Relations](#link-relations)
- [Endpoints](#endpoints)
- [Example](#example)
- [Conformance](#conformance)

- **OpenAPI specification:** Missing
- **Conformance URI:** <http://stacspec.org/spec/api/1.0.0-beta.4/extensions/collections>
Expand Down Expand Up @@ -32,15 +32,16 @@ The following Link relations shall exist in the Landing Page (root).
| `service-desc` | `/api` (recommended) | OAFeat OpenAPI | The OpenAPI service description. Uses the `application/vnd.oai.openapi+json;version=3.0` media type to refer to the OpenAPI 3.0 document that defines the service's API |
| `data` | `/collections` | OAFeat | List of Collections |
A `service-doc` endpoint is recommended, but not required.

| **rel** | **href** | **From** | **Description** |
| ------------- | ------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `service-doc` | `/api.html` (recommended) | OAFeat OpenAPI | An HTML service description. Uses the `text/html` media type to refer to a human-consumable description of the service |

Additionally, `child` relations may exist to individual catalogs and collections.
| **rel** | **href** | **From** | **Description** |
| -------------- | -------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| `child` | various | STAC Core | The child STAC Catalogs & Collections. Provides curated paths to get to STAC Collection and Item objects |
| **rel** | **href** | **From** | **Description** |
| -------------- | -------------------- | -------------- | --------------- |
| `child` | various | STAC Core | The child STAC Catalogs & Collections. Provides curated paths to get to STAC Collection and Item objects |

The following Link relations should exist in the `/collections` endpoint response.

Expand Down
3 changes: 2 additions & 1 deletion core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,17 @@ The following Link relations shall exist in the Landing Page (root).
| `service-desc` | `/api` (recommended) | OAFeat OpenAPI | The OpenAPI service description. Uses the `application/vnd.oai.openapi+json;version=3.0` media type to refer to the OpenAPI 3.0 document that defines the service's API |

A `service-doc` endpoint is recommended, but not required.

| **rel** | **href** | **From** | **Description** |
| ------------- | ------------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `service-doc` | `/api.html` (recommended) | OAFeat OpenAPI | An HTML service description. Uses the `text/html` media type to refer to a human-consumable description of the service |

Additionally, `child` relations may exist to individual catalogs and collections.

| **rel** | **href** | **From** | **Description** |
| -------------- | -------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `child` | various | STAC Core | The child STAC Catalogs & Collections. Provides curated paths to get to STAC Collection and Item objects |


It is also valid to have `item` links from the landing page, but most STAC API services are used to
serve up a large number of features, so they typically
use several layers of intermediate `child` links before getting to Item objects. Note that the `items` (plural)
Expand Down
16 changes: 12 additions & 4 deletions extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,11 +69,19 @@ the service supports. This are listed at the top of each extension description,
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#fields>
- <https://api.stacspec.org/v1.0.0-beta.4/ogcapi-features#fields>
- [Filter](item-search/README.md#filter)
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#filter:filter>
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#filter:simple-cql>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/filter>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/basic-cql>
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#filter:item-search-filter>
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#filter:cql-text>
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#filter:cql-json>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/cql-text>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/cql-json>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/advanced-comparison-operators>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/basic-spatial-operators>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/spatial-operators>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/temporal-operators>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/functions>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/arithmetic>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/array-operators>
- <http://www.opengis.net/spec/ogcapi-features-3/1.0/conf/property-property>
- [Context](item-search/README.md#context)
- <https://api.stacspec.org/v1.0.0-beta.4/item-search#context>
- <https://api.stacspec.org/v1.0.0-beta.4/ogcapi-features#context>
Expand Down
Loading