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

Reorg conformance uris, endpoints, links, and maturity classification #240

Prev Previous commit
Next Next commit
reword query extension language
  • Loading branch information
philvarner committed Dec 14, 2021
commit 6824af7da5bd1a93eb304ce71d85843449cda5b8
2 changes: 1 addition & 1 deletion collections/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ aim to align with it. But it still seems to be in flux.*

## Link Relations

This conformance class also requires for the link relations in the [STAC API - Core](../core) conformance class to be implemented.
This conformance class also requires implementation of the link relations in the [STAC API - Core](../core) conformance class.

The following Link relations shall exist in the Landing Page (root).

Expand Down
28 changes: 14 additions & 14 deletions item-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@
- [PUT / PATCH / DELETE](#put--patch--delete)
- [Example Landing Page for STAC API - Item Search](#example-landing-page-for-stac-api---item-search)
- [Extensions](#extensions)
- [Fields](#fields)
- [Sort](#sort)
- [Context](#context)
- [Filter](#filter)
- [Query](#query)
- [Fields Extension](#fields-extension)
- [Sort Extension](#sort-extension)
- [Context Extension](#context-extension)
- [Filter Extension](#filter-extension)
- [Query Extension](#query-extension)

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-beta.5/item-search))
- **Conformance URIs:**
Expand Down Expand Up @@ -47,7 +47,7 @@ Implementing `GET /search` is **required**, `POST /search` is optional, but reco

## Link Relations

This conformance class also requires for the link relations in the [STAC API - Core](../core) conformance class to be implemented.
This conformance class also requires implementation of the link relations in the [STAC API - Core](../core) conformance class.

The following Link relations shall exist in the Landing Page (root).

Expand Down Expand Up @@ -293,7 +293,7 @@ These extensions provide additional functionality that enhances Item Search. All
the `search` endpoint must include the relevant **conformance URI** in the `conformsTo` response at
the root (`/`) landing page, to indicate to clients that they will respond properly to requests from clients.

### Fields
### Fields Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#fields>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -305,7 +305,7 @@ allows the client to suggest to the server which Item attributes should be inclu
through the use of a `fields` parameter. The full description of how this extension works can be found in the
[fields fragment](../fragments/fields/).

### Sort
### Sort Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#sort>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -318,7 +318,7 @@ field names to sort by, with an indication of direction. It can be used with bot
'-' to indicate sort order, and the latter including a 'direction' field in JSON. The full description of the semantics
of this extension can be found in the [sort fragment](../fragments/sort).

### Context
### Context Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#context>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -328,7 +328,7 @@ This extension is intended to augment the core ItemCollection responses from the
JSON object called `context` that includes the number of items `matched`, `returned` and the `limit` requested.
The full description and examples of this are found in the [context fragment](../fragments/context).

### Filter
### Filter Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#filter>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Pilot
Expand All @@ -340,16 +340,16 @@ match predicates between the fields requested and the values of Item objects. It
query formats, `cql-text` and `cql-json`. The full details on the JSON structure are specified in the [filter
fragment](../fragments/filter/).

### Query
### Query Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#query>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
- **Definition**: [STAC API - Query Fragment](../fragments/query/)

**Note** - the Query Extension will be deprecated at some point in 1.x. Implementers
are encouraged to use the Filter Extension instead.
**Note**: It is recommended that implementers implement the [Filter Extension](#filter-extension) instead, as
it offers a more robust set of operators and uses the CQL2 standard.

The STAC search endpoint, `/search`, by default only accepts a limited set of parameters to limit the results
The STAC API search endpoint, `/search`, by default only accepts a limited set of parameters to limit the results
by properties. The Query extension adds a new parameter, `query`, that can take a number of comparison operators to
match predicates between the fields requested and the values of Item objects. It can be used with both GET and POST, though
GET includes the exact same JSON. The full details on the JSON structure are specified in the [query
Expand Down
30 changes: 15 additions & 15 deletions ogcapi-features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@
- [Example Landing Page for STAC API - Features](#example-landing-page-for-stac-api---features)
- [Example Collection for STAC API - Features](#example-collection-for-stac-api---features)
- [Extensions](#extensions)
- [Transaction](#transaction)
- [Transaction Extension](#transaction-extension)
- [Items and Collections API Version Extension](#items-and-collections-api-version-extension)
- [Fields](#fields)
- [Sort](#sort)
- [Context](#context)
- [Filter](#filter)
- [Query](#query)
- [Fields Extension](#fields-extension)
- [Sort Extension](#sort-extension)
- [Context Extension](#context-extension)
- [Filter Extension](#filter-extension)
- [Query Extension](#query-extension)

*based on [**OGC API - Features - Part 1: Core**](https://www.ogc.org/standards/ogcapi-features)*

Expand Down Expand Up @@ -47,7 +47,7 @@ with OAFeat clients. But specialized STAC clients will likely display results be

## Link Relations

This conformance class also requires for the link relations in the [STAC API - Core](../core) conformance class to be implemented.
This conformance class also requires implementation of the link relations in the [STAC API - Core](../core) conformance class.

The following Link relations shall exist in the Landing Page (root).

Expand Down Expand Up @@ -329,7 +329,7 @@ STAC APIs that offer the following capabilities must include the relevant **conf
`conformsTo` response at the root (`/`) landing page, to indicate to clients that they will respond properly
to requests from clients.

### Transaction
### Transaction Extension

- **Conformance URIs:**
- <https://api.stacspec.org/v1.0.0-beta.5/ogcapi-features/extensions/transaction>
Expand All @@ -352,7 +352,7 @@ The core API only supports semantics for creating and accessing a single version
The Version Extension defines the API resources and semantics for creating and accessing versioned records.
It is the STAC API equivalent of [OGC API - Features - Part 4: Create, Replace, Update and Delete](https://docs.ogc.org/DRAFTS/20-002.html).

### Fields
### Fields Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/ogcapi-features#fields>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -365,7 +365,7 @@ allows the client to suggest to the server which Item attributes should be inclu
through the use of a `fields` parameter. The full description of how this extension works can be found in the
[fields fragment](../fragments/fields/).

### Sort
### Sort Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/ogcapi-features#sort>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -378,7 +378,7 @@ field names to sort by, with an indication of direction. It uses '+' and
'-' to indicate sort order of the list of fields. The full description of the semantics
of this extension can be found in the [sort fragment](../fragments/sort).

### Context
### Context Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/ogcapi-features#context>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
Expand All @@ -388,7 +388,7 @@ This extension is intended to augment the core ItemCollection responses from the
JSON object called `context` that includes the number of items `matched`, `returned` and the `limit` requested.
The full description and examples of this are found in the [context fragment](../fragments/context).

### Filter
### Filter Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#filter>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Pilot
Expand All @@ -400,14 +400,14 @@ match predicates between the fields requested and the values of Item objects. It
query formats, `cql-text` and `cql-json`. The full details on the JSON structure are specified in the [filter
fragment](../fragments/filter/).

### Query
### Query Extension

- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.5/item-search#query>
- **Extension [Maturity Classification](../README.md#maturity-classification):** Candidate
- **Definition**: [STAC API - Query Fragment](../fragments/query/)

**Note** - the Query Extension will be deprecated at some point in 1.x. Implementers
are encouraged to use the Filter Extension instead.
**Note**: It is recommended that implementers implement the [Filter Extension](#filter-extension) instead, as
it offers a more robust set of operators and uses the CQL2 standard.

The STAC search endpoint, `/search`, by default only accepts a limited set of parameters to limit the results
by properties. The Query extension adds a new parameter, `query`, that can take a number of comparison operators to
Expand Down