Skip to content

Commit b14ec82

Browse files
philvarnerphilvarner
authored
Merge pull request #287 from radiantearth/openapi-cleanup-and-spectral-and-remark-upgrade
fix a few minor openapi spec issues, upgrade remark and spectral
2 parents a81b34c + 0c36fce commit b14ec82

File tree

7 files changed

+6920
-4134
lines changed

7 files changed

+6920
-4134
lines changed

‎.circleci/.spectral-fragments.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ rules:
33
openapi-tags: off
44
info-contact: off
55
oas3-api-servers: off
6-
oas3-unused-components-schema: off
6+
oas3-unused-component: off
77
operation-operationId: off
88
oas3-parameter-description: true

‎.circleci/rc.yaml

Lines changed: 0 additions & 43 deletions
This file was deleted.

‎extensions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ This is the list of all extensions that are contained in the stac-api-spec repos
3232

3333
| Extension Name | Scope* | Description | Maturity |
3434
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
35-
| [Fields](item-search/README.md#fields-extension) | [Item Search](item-search/) request | Adds parameter to control which fields are returned in the response. | Candidate |
36-
| [Filter](item-search/README.md#filter-extension) | [Item Search](item-search/) and [STAC API - Features](ogcapi-features) `/items` requests | Adds parameter to search Item and Collection properties. | Pilot |
37-
| [Context](item-search/README.md#context-extension) | [Item Search](item-search/) response ([ItemCollection](fragments/itemcollection/README.md)) | Adds search related metadata (context) to ItemCollection. | Candidate |
38-
| [Sort](item-search/README.md#sort-extension) | [Item Search](item-search/) request | Adds Parameter to control sorting of returns results. | Candidate |
39-
| [Transaction](ogcapi-features/extensions/transaction/README.md) | [STAC API - Features](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. | Candidate |
35+
| [Fields](item-search/README.md#fields-extension) | [Item Search](item-search/) request | Adds parameter to control which fields are returned in the response. | Candidate |
36+
| [Filter](item-search/README.md#filter-extension) | [Item Search](item-search/) and [STAC API - Features](ogcapi-features) `/items` requests | Adds parameter to search Item and Collection properties. | Pilot |
37+
| [Context](item-search/README.md#context-extension) | [Item Search](item-search/) response ([ItemCollection](fragments/itemcollection/README.md)) | Adds search related metadata (context) to ItemCollection. | Candidate |
38+
| [Sort](item-search/README.md#sort-extension) | [Item Search](item-search/) request | Adds Parameter to control sorting of returns results. | Candidate |
39+
| [Transaction](ogcapi-features/extensions/transaction/README.md) | [STAC API - Features](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. | Candidate |
4040
| [Items and Collections API Version](ogcapi-features/extensions/version/README.md) | [STAC API - Features](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* |
41-
| [Query](item-search/README.md#query-extension) | [Item Search](item-search/) request | Adds parameter to search Item and Collection properties. | Candidate |
41+
| [Query](item-search/README.md#query-extension) | [Item Search](item-search/) request | Adds parameter to search Item and Collection properties. | Candidate |
4242

4343
### Conformance classes of extensions
4444

‎fragments/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ things clean we specify a conformance class for each, so clients can know exactl
1111
conformance class is specified in the relevant folder as an 'extension' to the main capability. But their
1212
semantics are exactly the same, so we put the shared openapi definition in this `fragments` directory.
1313

14-
| Fragment Name | Description |
15-
| ------------------------------------------ | ------------ |
16-
| [Context](context/README.md) | Adds search related metadata (context) to GeoJSON Responses. |
17-
| [Fields](fields/README.md) | Adds parameter to control which fields are returned in the response. |
18-
| [ItemCollection](itemcollection/README.md) | The specification for a set of items, e.g. returned by a search. |
14+
| Fragment Name | Description |
15+
| ------------------------------------------ | -------------------------------------------------------------------------- |
16+
| [Context](context/README.md) | Adds search related metadata (context) to GeoJSON Responses. |
17+
| [Fields](fields/README.md) | Adds parameter to control which fields are returned in the response. |
18+
| [ItemCollection](itemcollection/README.md) | The specification for a set of items, e.g. returned by a search. |
1919
| [Query](query/README.md) | Adds parameter to compare properties and only return the items that match. |
20-
| [Sort](sort/README.md) | Adds Parameter to control sorting of returns results. |
20+
| [Sort](sort/README.md) | Adds Parameter to control sorting of returns results. |

‎fragments/itemcollection/README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ required fields is a valid STAC ItemCollection.
1919

2020
This object describes a STAC ItemCollection. The fields `type` and `features` are inherited from GeoJSON FeatureCollection.
2121

22-
| Field Name | Type | Description |
23-
| --------------- | --------------------------------------- | ----------- |
24-
| type | string | **REQUIRED.** Always "FeatureCollection" to provide compatibility with GeoJSON. |
25-
| features | [STAC Item](../../stac-spec/item-spec/item-spec.md) | **REQUIRED** A possibly-empty array of Item objects. |
26-
| links | [Link Object](../../stac-spec/item-spec/item-spec.md#link-object) | An array of Links related to this ItemCollection. |
22+
| Field Name | Type | Description |
23+
| ---------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------- |
24+
| type | string | **REQUIRED.** Always "FeatureCollection" to provide compatibility with GeoJSON. |
25+
| features | [STAC Item](../../stac-spec/item-spec/item-spec.md) | **REQUIRED** A possibly-empty array of Item objects. |
26+
| links | [Link Object](../../stac-spec/item-spec/item-spec.md#link-object) | An array of Links related to this ItemCollection. |
2727

2828
## Extensions
2929

0 commit comments

Comments
 (0)