Merge pull request #128 from philvarner/filter-extension

Filter Extension
radiantearth · May 26, 2021 · ed7f3f1 · ed7f3f1
2 parents 0f5e1b0 + 8e08794
commit ed7f3f1
Show file tree

Hide file tree

Showing 17 changed files with 2,019 additions and 51 deletions.
diff --git a/.circleci/rc.yaml b/.circleci/rc.yaml
@@ -4,17 +4,15 @@ plugins:
 # Apply some recommended defaults for consistency
   - remark-preset-lint-consistent
   - remark-preset-lint-recommended
-# No HTML for security - can't activate yet due to STAC logo in README.md
-# - lint-no-html
+  - lint-no-html
 # General formatting
-#  - - remark-lint-emphasis-marker
-#    - '*'
+  - - remark-lint-emphasis-marker
+    - '*'
   - remark-lint-hard-break-spaces
   - remark-lint-blockquote-indentation
   - remark-lint-no-consecutive-blank-lines
-# Detect overly long lines - be liberal for now and don't restrict to 80 yet
-#  - - remark-lint-maximum-line-length
-#    - 150
+  - - remark-lint-maximum-line-length
+    - 150
 # Code
   - remark-lint-fenced-code-flag
   - remark-lint-fenced-code-marker
@@ -23,24 +21,23 @@ plugins:
     - 'fenced'
 # Headings
   - remark-lint-heading-increment
-  - remark-lint-no-duplicate-headings
   - remark-lint-no-multiple-toplevel-headings
   - remark-lint-no-heading-punctuation
   - - remark-lint-maximum-heading-length
     - 70
   - - remark-lint-heading-style
     - atx
+  - - remark-lint-no-shortcut-reference-link
+    - false
 # Lists
   - remark-lint-list-item-bullet-indent
   - remark-lint-ordered-list-marker-style
   - remark-lint-ordered-list-marker-value
   - remark-lint-checkbox-character-style
-#  - - remark-lint-unordered-list-marker-style
-#    - '-'
+  - - remark-lint-unordered-list-marker-style
+    - '-'
   - - remark-lint-list-item-indent
     - space 
 # Tables
   - remark-lint-table-pipes
-#  - remark-lint-table-pipe-alignment # Wait for https://github.com/remarkjs/remark-lint/issues/226  
-# Urls
   - remark-lint-no-literal-urls
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,10 +11,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added recommendation to enable CORS for public APIs
 
 ### Changed
+- Added Filter extension to integrate OAFeat Part 3 CQL
 - Passing the `ids` parameter to an item search does not deactivate other query parameters [#125](https://github.com/radiantearth/stac-api-spec/pull/125)
 - The first extent in a Collection is always the overall extent, followed by more specific extents. [opengeospatial/ogcapi-features#520](https://github.com/opengeospatial/ogcapi-features/pull/520)
 
 ### Deprecated
+- Query extension is now deprecated. Replaced by the Filter extension using OGC CQL
 
 ### Removed
 

diff --git a/core/README.md b/core/README.md
@@ -10,7 +10,8 @@
 - **Extension [Maturity Classification](../extensions.md#extension-maturity):** Pilot
 - **Dependencies**: None
 
-The base of a STAC API is its landing page. This resource is the starting point to discover what behaviors the API supports via the `conformsTo` values and link relations. 
+The base of a STAC API is its landing page. This resource is the starting point to discover what behaviors 
+the API supports via the `conformsTo` values and link relations. 
 This behavior in a RESTful API is known as 
 [Hypermedia as the Engine of Application State (HATEOAS)](https://en.wikipedia.org/wiki/HATEOAS). 
 STAC API relies heavily on hypermedia for API resource navigation. 
@@ -29,7 +30,8 @@ client must inspect the the `rel` (relationship) to understand what capabilities
 Note the `conformsTo` JSON object follows exactly the structure of OGC API - Features [declaration of conformance 
 classes](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_declaration_of_conformance_classes), except is available directly under 
 the landing page. This is a slight break from how OGC API does things, as STAC feels it is important for clients to be able to understand
-conformance in a single request. Implementers choosing to also implement the OGC API - Features and/or STAC API - Features conformance classes must also implment the `/conformance` endpoint.
+conformance in a single request. Implementers choosing to also implement the OGC API - Features and/or 
+STAC API - Features conformance classes must also implment the `/conformance` endpoint.
 
 This particular catalog provides the ability to browse down to child STAC Collection objects through its `child` links, and also provides the search
 endpoint to be able to search across items in its collections. Note though that none of those links are required, other servers may provide
@@ -47,13 +49,13 @@ API endpoints from OAFeat or STAC API to be implemented, so the following links
 
 When implementing the STAC API Core conformance class, it it recommended to implement these Link relations.
 
-| **`rel`** | **href to**                                | **From**           | **Description**                                                  |
-|-----------|--------------------------------------------|--------------------|------------------------------------------------------------------|
-| `root`    | The root URI                               | STAC Core          | Reference to self URI |
-| `self`    | The root URI                               | OAFeat             | Reference to self URI  |
-| `service-desc` | The OpenAPI service description       | OAFeat OpenAPI   | 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 |
-| `service-doc`  | An HTML service description           | OAFeat OpenAPI   | Uses the `text/html` media type to refer to a human-consumable description of the service |
-| `child`   | The child STAC Catalogs & Collections      | STAC Core          | Provides curated paths to get to STAC Collection and Item objects      |
+| **`rel`**      | **href to**                           | **From**       | **Description**                                                                                                                        |
+| -------------- | ------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
+| `root`         | The root URI                          | STAC Core      | Reference to self URI                                                                                                                  |
+| `self`         | The root URI                          | OAFeat         | Reference to self URI                                                                                                                  |
+| `service-desc` | The OpenAPI service description       | OAFeat OpenAPI | 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 |
+| `service-doc`  | An HTML service description           | OAFeat OpenAPI | Uses the `text/html` media type to refer to a human-consumable description of the service                                              |
+| `child`        | The child STAC Catalogs & Collections | STAC Core      | 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

diff --git a/extensions.md b/extensions.md
@@ -50,28 +50,31 @@ are scoped against ogcapi-features*.
 
 This is the list of all extensions that are contained in the stac-api-spec repository.
 
-| Extension Name                                                                    | Scope*                                                                                                     | Description                                                                                                                             | Maturity   |
-|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|------------|
-| [Fields](item-search/README.md#fields)                                            | [Item Search](item-search/) request                                                                        | Adds parameter to control which fields are returned in the response.                                                                    | *Pilot*    |
-| [Query](item-search/README.md#query)                                              | [Item Search](item-search/) request                                                                        | Adds parameter to search Item and Collection properties.                                                                                | *Pilot*    |
+| Extension Name | Scope* | Description | Maturity | 
+|----------------|--------|-------------|----------|
+| [Fields](item-search/README.md#fields) | [Item Search](item-search/) request | Adds parameter to control which fields are returned in the response. | *Pilot* |
+| [Filter](item-search/README.md#filter) | [Item Search](item-search/) and [STAC - Features API](ogcapi-features) `/items` requests | Adds parameter to search Item and Collection properties. | *Pilot* |
 | [Context](item-search/README.md#context)                                          | [Item Search](item-search/) response ([ItemCollection](fragments/itemcollection/README.md))                       | Adds search related metadata (context) to ItemCollection.                                                                               | *Proposal* |
 | [Sort](item-search/README.md#sort)                                                | [Item Search](item-search/) request                                                                        | Adds Parameter to control sorting of returns results.                                                                                   | *Pilot*    |
 | [Transaction](ogcapi-features/extensions/transaction/README.md)                   | [STAC - Features API](ogcapi-features) POST on `/items` endpoint, DELETE/PUT on `/items/{itemId}` endpoint | Adds PUT and DELETE endpoints for the creation, editing, and deleting of Item objects.                                         | *Pilot*    |
 | [Items and Collections API Version](ogcapi-features/extensions/version/README.md) | [STAC - Features API](ogcapi-features) on `/items` endpoint                                                | Adds GET versions resource to Collection and Item endpoints and provides semantics for a versioning scheme for Collection and Item objects. | *Proposal* |
+| [Query](item-search/README.md#query) | [Item Search](item-search/) request | Adds parameter to search Item and Collection properties. | *Deprecated* |
 
 ### Conformance classes of extensions
 
 Each extension has its own conformance URI, which is used in the `conformsTo` response of the landing page to let clients know what capabilities 
 the service supports. This are listed at the top of each extension description, but the full table is given here for ease of reference.
 
-| Extension Name                                                                    | Conformance URI                                                            |
-|-----------------------------------------------------------------------------------|----------------------------------------------------------------------------|
-| [Fields](item-search/README.md#fields)                                            | <https://api.stacspec.org/v1.0.0-beta.1/item-search#fields>  |
-| [Query](item-search/README.md#query)                                              | <https://api.stacspec.org/v1.0.0-beta.1/item-search#query>   |
-| [Context](item-search/README.md#context)                                          | <https://api.stacspec.org/v1.0.0-beta.1/item-search#context> |
-| [Sort](item-search/README.md#sort)                                                | <https://api.stacspec.org/v1.0.0-beta.1/item-search#sort>    |
-| [Transaction](ogcapi-features/extensions/transaction/README.md)                   | <https://api.stacspec.org/v1.0.0-beta.1/ogcapi-features/extensions/transaction>         |
-| [Items and Collections API Version](ogcapi-features/extensions/version/README.md) | <https://api.stacspec.org/v1.0.0-beta.1/ogcapi-features/extensions/version>             |
+| Extension Name | Conformance Class URIs  |
+|---------------|-------------------------|
+| [Fields](item-search/README.md#fields)   | <https://api.stacspec.org/v1.0.0-beta.1/item-search#fields>  |
+| [Filter](item-search/README.md#filter)   | <https://api.stacspec.org/v1.0.0-beta.1/item-search#filter:filter><br/><https://api.stacspec.org/v1.0.0-beta.1/item-search#filter:simple-cql><br/><https://api.stacspec.org/v1.0.0-beta.1/item-search#filter:item-search-filter><br/><https://api.stacspec.org/v1.0.0-beta.1/item-search#filter:cql-text><br/><https://api.stacspec.org/v1.0.0-beta.1/item-search#filter:cql-json> |
+| [Context](item-search/README.md#context) | <https://api.stacspec.org/v1.0.0-beta.1/item-search#context> |
+| [Sort](item-search/README.md#sort)       | <https://api.stacspec.org/v1.0.0-beta.1/item-search#sort>    |
+| [Transaction](ogcapi-features/extensions/transaction/README.md) | <https://api.stacspec.org/v1.0.0-beta.1/ogcapi-features/extensions/transaction> |
+| [Items and Collections API Version](ogcapi-features/extensions/version/README.md) | <https://api.stacspec.org/v1.0.0-beta.1/ogcapi-features/extensions/version> |
+| [Query](item-search/README.md#query)     | <https://api.stacspec.org/v1.0.0-beta.1/item-search#query> |
+
 
 ## Third-party / vendor extensions
 

diff --git a/fragments/context/README.md b/fragments/context/README.md
@@ -1,6 +1,7 @@
 # STAC API - Context Fragment
 
 - **OpenAPI specification:** [openapi.yaml](openapi.yaml)
+- **Conformance Class:** <https://api.stacspec.org/v1.0.0-beta.1/item-search#context>
 - **Fragment [Maturity Classification](../../extensions.md#extension-maturity):** Pilot
 - **Dependents:**
   - [Item Search](../../item-search)

diff --git a/fragments/fields/README.md b/fragments/fields/README.md
@@ -1,6 +1,7 @@
 # STAC API - Fields Fragment
 
 - **OpenAPI specification:** [openapi.yaml](openapi.yaml)
+- **Conformance Class:** <https://api.stacspec.org/v1.0.0-beta.1/item-search#fields>
 - **Fragment [Maturity Classification](../../extensions.md#extension-maturity):** Pilot
 - **Dependents:**
   - [Item Search](../../item-search)