Skip to content

Commit

Permalink
Merge pull request #287 from radiantearth/openapi-cleanup-and-spectra…
Browse files Browse the repository at this point in the history 
…l-and-remark-upgrade

fix a few minor openapi spec issues, upgrade remark and spectral
  • Loading branch information
@philvarner
philvarner authored Mar 17, 2022
2 parents a81b34c + 0c36fce commit b14ec82
Show file tree
Hide file tree
Showing 7 changed files with 6,920 additions and 4,134 deletions.
2 changes: 1 addition & 1 deletion .circleci/.spectral-fragments.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ rules:
openapi-tags: off
info-contact: off
oas3-api-servers: off
oas3-unused-components-schema: off
oas3-unused-component: off
operation-operationId: off
oas3-parameter-description: true
43 changes: 0 additions & 43 deletions .circleci/rc.yaml
View file

This file was deleted.

12 changes: 6 additions & 6 deletions extensions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ This is the list of all extensions that are contained in the stac-api-spec repos

| Extension Name | Scope* | Description | Maturity |
| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ---------- |
| [Fields](item-search/README.md#fields-extension) | [Item Search](item-search/) request | Adds parameter to control which fields are returned in the response. | Candidate |
| [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 |
| [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 |
| [Sort](item-search/README.md#sort-extension) | [Item Search](item-search/) request | Adds Parameter to control sorting of returns results. | Candidate |
| [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 |
| [Fields](item-search/README.md#fields-extension) | [Item Search](item-search/) request | Adds parameter to control which fields are returned in the response. | Candidate |
| [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 |
| [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 |
| [Sort](item-search/README.md#sort-extension) | [Item Search](item-search/) request | Adds Parameter to control sorting of returns results. | Candidate |
| [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 |
| [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* |
| [Query](item-search/README.md#query-extension) | [Item Search](item-search/) request | Adds parameter to search Item and Collection properties. | Candidate |
| [Query](item-search/README.md#query-extension) | [Item Search](item-search/) request | Adds parameter to search Item and Collection properties. | Candidate |

### Conformance classes of extensions

Expand Down
12 changes: 6 additions & 6 deletions fragments/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ things clean we specify a conformance class for each, so clients can know exactl
conformance class is specified in the relevant folder as an 'extension' to the main capability. But their
semantics are exactly the same, so we put the shared openapi definition in this `fragments` directory.

| Fragment Name | Description |
| ------------------------------------------ | ------------ |
| [Context](context/README.md) | Adds search related metadata (context) to GeoJSON Responses. |
| [Fields](fields/README.md) | Adds parameter to control which fields are returned in the response. |
| [ItemCollection](itemcollection/README.md) | The specification for a set of items, e.g. returned by a search. |
| Fragment Name | Description |
| ------------------------------------------ | -------------------------------------------------------------------------- |
| [Context](context/README.md) | Adds search related metadata (context) to GeoJSON Responses. |
| [Fields](fields/README.md) | Adds parameter to control which fields are returned in the response. |
| [ItemCollection](itemcollection/README.md) | The specification for a set of items, e.g. returned by a search. |
| [Query](query/README.md) | Adds parameter to compare properties and only return the items that match. |
| [Sort](sort/README.md) | Adds Parameter to control sorting of returns results. |
| [Sort](sort/README.md) | Adds Parameter to control sorting of returns results. |
10 changes: 5 additions & 5 deletions fragments/itemcollection/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ required fields is a valid STAC ItemCollection.

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

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

## Extensions

Expand Down
Loading

0 comments on commit b14ec82

Please sign in to comment.