Skip to content

Commit ab71e1c

Browse files
authored
add extensions section to ocgapi-features, cleanup other extensions sections (#181)
1 parent 36bbb50 commit ab71e1c

File tree

4 files changed

+45
-6
lines changed

4 files changed

+45
-6
lines changed

core/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
- [STAC API - Core Specification](#stac-api---core-specification)
44
- [Link Relations](#link-relations)
55
- [Example Landing Page for STAC API - Core](#example-landing-page-for-stac-api---core)
6+
- [Extensions](#extensions)
67

78
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) describes the core endpoints ([rendered version](https://api.stacspec.org/v1.0.0-beta.2/core)),
89
and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas.
@@ -117,3 +118,7 @@ the [overview](../overview.md#example-landing-page) document.
117118
]
118119
}
119120
```
121+
122+
## Extensions
123+
124+
None.

item-search/README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,10 @@ Implementations that support `POST` should add a second link with the same struc
7878

7979
## Query Parameters and Fields
8080

81-
The following list of parameters is used to narrow search queries. They can all be represented as query string parameters
82-
in a GET request, or as JSON entity fields in a POST request. For filters that represent a set of values, query parameters
83-
should use comma-separated string values with no enclosing brackets (\[ or \]) and no whitespace between values, and JSON entity attributes should use JSON Arrays.
81+
The following list of parameters is used to narrow search queries. They can all be represented as query
82+
string parameters in a GET request, or as JSON entity fields in a POST request. For filters that represent
83+
a set of values, query parameters should use comma-separated string values with no enclosing brackets
84+
(\[ or \]) and no whitespace between values, and JSON entity attributes should use JSON Arrays.
8485

8586
### Query Examples
8687

@@ -286,7 +287,7 @@ the [overview](../overview.md#example-landing-page) document.
286287

287288
## Extensions
288289

289-
These extensions provide additional functionality that enhances the core item search. All are specified as
290+
These extensions provide additional functionality that enhances Item Search. All are specified as
290291
[fragments](../fragments), as they are re-used by other extensions STAC API's that offer the following capabilities at
291292
the `search` endpoint must include the relevant **conformance URI** in the `conformsTo` response at
292293
the root (`/`) landing page, to indicate to clients that they will respond properly to requests from clients.

ogcapi-features/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55
- [Endpoints](#endpoints)
66
- [Examples](#examples)
77
- [Example Landing Page for STAC API - Features](#example-landing-page-for-stac-api---features)
8+
- [Extensions](#extensions)
9+
- [Transaction](#transaction)
10+
- [Items and Collections API Version Extension](#items-and-collections-api-version-extension)
811

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

@@ -178,3 +181,34 @@ the [overview](../overview.md#example-landing-page) document.
178181
]
179182
}
180183
```
184+
185+
## Extensions
186+
187+
These extensions provide additional functionality that enhances STAC API - Features.
188+
All are specified as [fragments](../fragments), as they are re-used by extensions to other STAC APIs.
189+
STAC APIs that offer the following capabilities must include the relevant **conformance URI** in the
190+
`conformsTo` response at the root (`/`) landing page, to indicate to clients that they will respond properly
191+
to requests from clients.
192+
193+
### Transaction
194+
195+
- **Conformance URIs:**
196+
- <https://api.stacspec.org/v1.0.0-beta.2/ogcapi-features/extensions/transaction>
197+
- <http://www.opengis.net/spec/ogcapi-features-4/1.0/conf/simpletx>
198+
- **Extension [Maturity Classification](../extensions.md#extension-maturity):** Pilot
199+
- **Definition**: [STAC API - Transaction Fragment](extensions/transaction/)
200+
201+
The core STAC API only supports retrieving existing Items.
202+
The Transaction extension supports the creation, editing, and deleting of items through the use of the
203+
POST, PUT, PATCH, and DELETE methods. The full description of how this extension works can be found in the
204+
[transaction fragment](extensions/transaction/).
205+
206+
### Items and Collections API Version Extension
207+
208+
- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.2/ogcapi-features/extensions/version>
209+
- **Extension [Maturity Classification](../extensions.md#extension-maturity):** Pilot
210+
- **Definition**: [STAC API - Version](extensions/version/)
211+
212+
The core API only supports semantics for creating and accessing a single version of an Item or Collection.
213+
The Version Extension defines the API resources and semantics for creating and accessing versioned records.
214+
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).

ogcapi-features/extensions/version/README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,7 @@
77

88
The core API doesn't support semantics to creating and accessing different versions of an Item or Collection.
99
This version API extension defines the API resources and semantics for creating and accessing versioned records.
10-
It is done on the OGC API - Features endpoints, and ideally should evolve to be an extension there, but it is
11-
incubated in STAC.
10+
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).
1211

1312
## Methods
1413

0 commit comments

Comments
 (0)