From fb82c0f9c3edc01750411f10d2df74345b0f0305 Mon Sep 17 00:00:00 2001 From: Phil Varner Date: Mon, 24 Apr 2023 09:17:52 -0400 Subject: [PATCH] release prep for 1.0.0 --- CHANGELOG.md | 8 +- CITATION.cff | 4 +- README.md | 7 +- core/README.md | 8 +- core/commons.yaml | 154 ++++++++++----------- core/openapi.yaml | 42 +++--- fragments/itemcollection/openapi.yaml | 6 +- item-search/README.md | 10 +- item-search/openapi.yaml | 78 +++++------ ogcapi-features/README.md | 24 ++-- ogcapi-features/openapi-collections.yaml | 76 +++++------ ogcapi-features/openapi-features.yaml | 165 +++++++++++------------ overview.md | 26 ++-- package-lock.json | 21 ++- package.json | 2 +- 15 files changed, 327 insertions(+), 304 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index bbb23fcb..59322e8b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## [v1.0.0] - 2023-04-24 + +None + ## [v1.0.0-rc.4] - 2023-04-13 ## Changed @@ -266,7 +270,9 @@ service description must return a 400 Bad Request status code. See the [stac-spec CHANGELOG](https://github.com/radiantearth/stac-spec/blob/v0.9.0/CHANGELOG.md) for STAC API releases prior to or equal to version 0.9.0. -[Unreleased]: +[Unreleased]: +[v1.0.0]: +[v1.0.0-rc.4]: [v1.0.0-rc.3]: [v1.0.0-rc.2]: [v1.0.0-rc.1]: diff --git a/CITATION.cff b/CITATION.cff index ee568121..a8ce4c5f 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -8,9 +8,9 @@ preferred-citation: type: standard title: "SpatioTemporal Asset Catalog (STAC) API specification" abstract: "An API to make geospatial assets openly searchable and crawlable." - version: 1.0.0-rc.4 + version: v1.0.0 year: 2023 - date-released: 2023-04-13 + date-released: 2023-04-24 license: Apache-2.0 url: https://stacspec.org repository: https://github.com/radiantearth/stac-api-spec diff --git a/README.md b/README.md index 6f3fc72e..7548d0ad 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ ## Releases (stable) -- [v1.0.0-rc.4](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.4) (latest) +- [v1.0.0](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0) (latest) +- [v1.0.0-rc.4](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.4) - [v1.0.0-rc.3](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3) - [v1.0.0-rc.2](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2) - [v1.0.0-rc.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1) @@ -59,13 +60,13 @@ to search STAC catalogs, where the features returned are STAC [Item](stac-spec/i that have common properties, links to their assets and geometries that represent the footprints of the geospatial assets. The specification for STAC API is provided as files that follow the [OpenAPI](http://openapis.org/) 3.0 specification, -rendered online into HTML at , in addition to human-readable documentation. +rendered online into HTML at , in addition to human-readable documentation. ## Stability Note This specification has evolved over the past couple years, and is used in production in a variety of deployments. It is currently in a 'beta' state, with no major changes anticipated. -As of v1.0.0-rc.4, we remain fully aligned with +As of v1.0.0, we remain fully aligned with [OGC API - Features](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html) Version 1.0, and we are working to stay aligned as the additional OGC API components mature. This may result in minor changes as things evolve. The STAC API diff --git a/core/README.md b/core/README.md index 1916a57c..98833733 100644 --- a/core/README.md +++ b/core/README.md @@ -11,9 +11,9 @@ ## Summary -- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/core)), +- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0/core)), - **Conformance URIs:** - - + - - **[Maturity Classification](../README.md#maturity-classification):** Candidate - **Dependencies**: None and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas. @@ -21,7 +21,7 @@ ## Overview All STAC API implementations must implement the *STAC API - Core* conformance class -. This requires a server to return from a root endpoint a valid +. This requires a server to return from a root endpoint a valid [STAC Catalog](../stac-spec/catalog-spec/catalog-spec.md) "landing page" that also includes a `conformsTo` attribute with a string array value. Any API implementing this is considered a minimal, valid STAC API. @@ -149,7 +149,7 @@ different conformance classes and a different set of links. "description": "This Catalog aims to demonstrate a simple landing page", "type": "Catalog", "conformsTo" : [ - "https://api.stacspec.org/v1.0.0-rc.4/core" + "https://api.stacspec.org/v1.0.0/core" ], "links": [ { diff --git a/core/commons.yaml b/core/commons.yaml index 47b52bed..ef2d3909 100644 --- a/core/commons.yaml +++ b/core/commons.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: The SpatioTemporal Asset Catalog API - Commons description: This is the OpenAPI version of the core STAC spec JSON Schemas. - version: 1.0.0-rc.4 + version: v1.0.0 paths: {} components: responses: @@ -11,7 +11,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/exception' + $ref: "#/components/schemas/exception" schemas: exception: type: object @@ -48,9 +48,9 @@ components: - links properties: stac_version: - $ref: '#/components/schemas/stac_version' + $ref: "#/components/schemas/stac_version" stac_extensions: - $ref: '#/components/schemas/stac_extensions' + $ref: "#/components/schemas/stac_extensions" type: type: string enum: @@ -62,7 +62,7 @@ components: description: type: string links: - $ref: '#/components/schemas/links' + $ref: "#/components/schemas/links" collection: type: object required: @@ -75,9 +75,9 @@ components: - links properties: stac_version: - $ref: '#/components/schemas/stac_version' + $ref: "#/components/schemas/stac_version" stac_extensions: - $ref: '#/components/schemas/stac_extensions' + $ref: "#/components/schemas/stac_extensions" type: type: string enum: @@ -102,13 +102,13 @@ components: items: type: string license: - $ref: '#/components/schemas/license' + $ref: "#/components/schemas/license" extent: - $ref: '#/components/schemas/extent' + $ref: "#/components/schemas/extent" providers: - $ref: '#/components/schemas/providers' + $ref: "#/components/schemas/providers" links: - $ref: '#/components/schemas/links' + $ref: "#/components/schemas/links" summaries: description: |- Summaries are either a unique set of all available values *or* @@ -152,11 +152,11 @@ components: - type: string - type: number example: - stac_version: '1.0.0' + stac_version: "1.0.0" stac_extensions: [] type: Collection id: Sentinel-2 - title: 'Sentinel-2 MSI: MultiSpectral Instrument, Level-1C' + title: "Sentinel-2 MSI: MultiSpectral Instrument, Level-1C" description: | Sentinel-2 is a wide-swath, high-resolution, multi-spectral imaging mission... @@ -173,7 +173,7 @@ components: roles: - producer - licensor - url: 'https://sentinel.esa.int/web/sentinel/user-guides/sentinel-2-msi' + url: "https://sentinel.esa.int/web/sentinel/user-guides/sentinel-2-msi" extent: spatial: bbox: @@ -183,32 +183,32 @@ components: - 83 temporal: interval: - - - '2015-06-23T00:00:00Z' - - '2019-07-10T13:44:56Z' + - - "2015-06-23T00:00:00Z" + - "2019-07-10T13:44:56Z" summaries: datetime: - min: '2015-06-23T00:00:00Z' - max: '2019-07-10T13:44:56Z' - 'sci:citation': - - 'Copernicus Sentinel data [Year]' - 'eo:gsd': + min: "2015-06-23T00:00:00Z" + max: "2019-07-10T13:44:56Z" + "sci:citation": + - "Copernicus Sentinel data [Year]" + "eo:gsd": - 10 - 30 - 60 - 'platform': + "platform": - sentinel-2a - sentinel-2b - 'constellation': + "constellation": - sentinel-2 - 'instruments': + "instruments": - msi - 'view:off_nadir': + "view:off_nadir": min: 0 max: 100 - 'view:sun_elevation': + "view:sun_elevation": min: 6.78 max: 89.9 - 'eo:bands': + "eo:bands": - - name: B1 common_name: coastal center_wavelength: 4.439 @@ -244,13 +244,13 @@ components: center_wavelength: 2.2024 links: - rel: self - href: 'http://cool-sat.com/collections/Sentinel-2' + href: "http://cool-sat.com/collections/Sentinel-2" type: application/json - rel: root - href: 'http://cool-sat.com/collections' + href: "http://cool-sat.com/collections" type: application/json - rel: license - href: 'https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf' + href: "https://scihub.copernicus.eu/twiki/pub/SciHubWebPortal/TermsConditions/Sentinel_Data_Terms_and_Conditions.pdf" title: Legal notice on the use of Copernicus Sentinel Data and Service Information type: application/pdf extent: @@ -334,8 +334,8 @@ components: additional enum values. type: string enum: - - 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' - default: 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' + - "http://www.opengis.net/def/crs/OGC/1.3/CRS84" + default: "http://www.opengis.net/def/crs/OGC/1.3/CRS84" temporal: description: |- The temporal extent of the features in the collection. @@ -369,7 +369,7 @@ components: format: date-time nullable: true example: - - '2011-11-11T12:22:11Z' + - "2011-11-11T12:22:11Z" - null trs: description: |- @@ -380,12 +380,12 @@ components: additional enum values. type: string enum: - - 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian' - default: 'http://www.opengis.net/def/uom/ISO-8601/0/Gregorian' + - "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" + default: "http://www.opengis.net/def/uom/ISO-8601/0/Gregorian" links: type: array items: - $ref: '#/components/schemas/link' + $ref: "#/components/schemas/link" link: title: Link type: object @@ -557,7 +557,7 @@ components: The searchable date and time of the assets, in UTC. It is formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6). `null` is allowed, but requires `start_datetime` and `end_datetime` from common metadata to be set. - example: '2018-02-12T00:00:00Z' + example: "2018-02-12T00:00:00Z" stac_version: title: STAC version type: string @@ -587,29 +587,29 @@ components: - assets properties: stac_version: - $ref: '#/components/schemas/stac_version' + $ref: "#/components/schemas/stac_version" stac_extensions: - $ref: '#/components/schemas/stac_extensions' + $ref: "#/components/schemas/stac_extensions" id: - $ref: '#/components/schemas/itemId' + $ref: "#/components/schemas/itemId" bbox: - $ref: '#/components/schemas/bbox' + $ref: "#/components/schemas/bbox" geometry: - $ref: '#/components/schemas/geometryGeoJSON' + $ref: "#/components/schemas/geometryGeoJSON" type: - $ref: '#/components/schemas/itemType' + $ref: "#/components/schemas/itemType" links: - $ref: '#/components/schemas/links' + $ref: "#/components/schemas/links" properties: - $ref: '#/components/schemas/properties' + $ref: "#/components/schemas/properties" assets: - $ref: '#/components/schemas/assets' + $ref: "#/components/schemas/assets" example: - stac_version: '1.0.0' + stac_version: "1.0.0" stac_extensions: - - 'https://stac-extensions.github.io/eo/v1.0.0/schema.json' - - 'https://stac-extensions.github.io/view/v1.0.0/schema.json' - - 'https://example.com/cs-extension/1.0/schema.json' + - "https://stac-extensions.github.io/eo/v1.0.0/schema.json" + - "https://stac-extensions.github.io/view/v1.0.0/schema.json" + - "https://example.com/cs-extension/1.0/schema.json" type: Feature id: CS3-20160503_132131_05 bbox: @@ -631,7 +631,7 @@ components: - - -122.308150179 - 37.488035566 properties: - datetime: '2016-05-03T13:22:30.040Z' + datetime: "2016-05-03T13:22:30.040Z" title: A CS3 item license: PDDL-1.0 providers: @@ -639,37 +639,37 @@ components: roles: - producer - licensor - url: 'https://cool-sat.com/' - 'view:sun_azimuth': 168.7 - 'eo:cloud_cover': 0.12 - 'view:off_nadir': 1.4 - 'platform': coolsat2 - 'instruments': + url: "https://cool-sat.com/" + "view:sun_azimuth": 168.7 + "eo:cloud_cover": 0.12 + "view:off_nadir": 1.4 + "platform": coolsat2 + "instruments": - cool_sensor_v1 - 'eo:bands': [] - 'view:sun_elevation': 33.4 - 'eo:gsd': 0.512 + "eo:bands": [] + "view:sun_elevation": 33.4 + "eo:gsd": 0.512 collection: CS3 links: - rel: self - href: 'http://cool-sat.com/collections/CS3/items/20160503_132130_04' + href: "http://cool-sat.com/collections/CS3/items/20160503_132130_04" type: application/geo+json - rel: root - href: 'http://cool-sat.com/collections' + href: "http://cool-sat.com/collections" type: application/json - rel: parent - href: 'http://cool-sat.com/collections/CS3' + href: "http://cool-sat.com/collections/CS3" type: application/json - rel: collection - href: 'http://cool-sat.com/collections/CS3' + href: "http://cool-sat.com/collections/CS3" type: application/json assets: analytic: - href: 'http://cool-sat.com/static-catalog/CS3/20160503_132130_04/analytic.tif' + href: "http://cool-sat.com/static-catalog/CS3/20160503_132130_04/analytic.tif" title: 4-Band Analytic type: image/tiff; application=geotiff; profile=cloud-optimized thumbnail: - href: 'http://cool-sat.com/static-catalog/CS3/20160503_132130_04/thumbnail.png' + href: "http://cool-sat.com/static-catalog/CS3/20160503_132130_04/thumbnail.png" title: Thumbnail type: image/png itemId: @@ -687,7 +687,7 @@ components: description: provides the core metadata fields plus extensions properties: datetime: - $ref: '#/components/schemas/datetime' + $ref: "#/components/schemas/datetime" additionalProperties: description: Any additional properties added in via Item specification or extensions. assets: @@ -729,13 +729,13 @@ components: - thumbnail geometryGeoJSON: oneOf: - - $ref: '#/components/schemas/pointGeoJSON' - - $ref: '#/components/schemas/multipointGeoJSON' - - $ref: '#/components/schemas/linestringGeoJSON' - - $ref: '#/components/schemas/multilinestringGeoJSON' - - $ref: '#/components/schemas/polygonGeoJSON' - - $ref: '#/components/schemas/multipolygonGeoJSON' - - $ref: '#/components/schemas/geometrycollectionGeoJSON' + - $ref: "#/components/schemas/pointGeoJSON" + - $ref: "#/components/schemas/multipointGeoJSON" + - $ref: "#/components/schemas/linestringGeoJSON" + - $ref: "#/components/schemas/multilinestringGeoJSON" + - $ref: "#/components/schemas/polygonGeoJSON" + - $ref: "#/components/schemas/multipolygonGeoJSON" + - $ref: "#/components/schemas/geometrycollectionGeoJSON" geometrycollectionGeoJSON: type: object required: @@ -749,7 +749,7 @@ components: geometries: type: array items: - $ref: '#/components/schemas/geometryGeoJSON' + $ref: "#/components/schemas/geometryGeoJSON" linestringGeoJSON: type: object required: @@ -875,7 +875,7 @@ components: features: type: array items: - $ref: '#/components/schemas/featureGeoJSON' + $ref: "#/components/schemas/featureGeoJSON" featureGeoJSON: type: object required: @@ -888,7 +888,7 @@ components: enum: - Feature geometry: - $ref: '#/components/schemas/geometryGeoJSON' + $ref: "#/components/schemas/geometryGeoJSON" properties: type: object nullable: true diff --git a/core/openapi.yaml b/core/openapi.yaml index 3ede79a8..08860ad6 100644 --- a/core/openapi.yaml +++ b/core/openapi.yaml @@ -1,23 +1,23 @@ openapi: 3.0.3 info: title: STAC API - Core - version: 1.0.0-rc.4 + version: v1.0.0 description: >- This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Core specification. Any service that implements this endpoint to allow discovery of spatiotemporal assets can be considered a STAC API. contact: name: STAC Specification - url: 'http://stacspec.org' + url: "http://stacspec.org" license: name: Apache License 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0' - x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/core'] + url: "http://www.apache.org/licenses/LICENSE-2.0" + x-conformance-classes: ["https://api.stacspec.org/v1.0.0/core"] tags: - name: Core description: essential characteristics of a STAC API paths: - '/': + "/": get: tags: - Core @@ -36,18 +36,18 @@ paths: Extensions may add additional links with new relation types. operationId: getLandingPage responses: - '200': - $ref: '#/components/responses/LandingPage' - '4XX': - $ref: 'commons.yaml#/components/responses/Error' - '5XX': - $ref: 'commons.yaml#/components/responses/Error' + "200": + $ref: "#/components/responses/LandingPage" + "4XX": + $ref: "commons.yaml#/components/responses/Error" + "5XX": + $ref: "commons.yaml#/components/responses/Error" components: schemas: landingPage: allOf: - - $ref: 'commons.yaml#/components/schemas/catalog' - - $ref: 'commons.yaml#/components/schemas/conformanceClasses' + - $ref: "commons.yaml#/components/schemas/catalog" + - $ref: "commons.yaml#/components/schemas/conformanceClasses" responses: LandingPage: description: |- @@ -56,33 +56,33 @@ components: content: application/json: schema: - $ref: '#/components/schemas/landingPage' + $ref: "#/components/schemas/landingPage" example: type: Catalog - stac_version: '1.0.0' + stac_version: "1.0.0" id: sentinel title: Copernicus Sentinel Imagery description: Catalog of Copernicus Sentinel 1 and 2 imagery. conformsTo: - - 'https://api.stacspec.org/v1.0.0-rc.4/core' + - "https://api.stacspec.org/v1.0.0/core" links: - - href: 'http://data.example.org/' + - href: "http://data.example.org/" rel: self type: application/json title: this document - - href: 'http://data.example.org/api' + - href: "http://data.example.org/api" rel: service-desc type: application/vnd.oai.openapi+json;version=3.0 title: the API definition - - href: 'http://data.example.org/api.html' + - href: "http://data.example.org/api.html" rel: service-doc type: text/html title: the API documentation - - href: 'http://data.example.org/catalogs/sentinel-1' + - href: "http://data.example.org/catalogs/sentinel-1" rel: child type: application/json title: Sentinel 1 Catalog - - href: 'http://data.example.org/catalogs/sentinel-2' + - href: "http://data.example.org/catalogs/sentinel-2" rel: child type: application/json title: Sentinel 2 Catalog diff --git a/fragments/itemcollection/openapi.yaml b/fragments/itemcollection/openapi.yaml index c1e83e20..cf7bf4dc 100644 --- a/fragments/itemcollection/openapi.yaml +++ b/fragments/itemcollection/openapi.yaml @@ -2,7 +2,7 @@ openapi: 3.0.3 info: title: The SpatioTemporal Asset Catalog API - Item Collection description: The specification for a set of items, e.g. returned by a search. - version: 1.0.0-rc.4 + version: v1.0.0 paths: {} components: schemas: @@ -21,14 +21,14 @@ components: features: type: array items: - $ref: '../../core/commons.yaml#/components/schemas/item' + $ref: "../../core/commons.yaml#/components/schemas/item" links: type: array description: >- An array of links. Can be used for pagination, e.g. by providing a link with the `next` relation type. items: - $ref: '../../core/commons.yaml#/components/schemas/link' + $ref: "../../core/commons.yaml#/components/schemas/link" example: - rel: next type: application/geo+json diff --git a/item-search/README.md b/item-search/README.md index 1d657ba3..243533f4 100644 --- a/item-search/README.md +++ b/item-search/README.md @@ -19,9 +19,9 @@ ## Summary -- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/item-search)) +- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0/item-search)) - **Conformance URIs:** - - + - - **[Maturity Classification](../README.md#maturity-classification):** Candidate - **Dependencies**: [STAC API - Core](../core) - **Examples**: [examples.md](examples.md) @@ -29,7 +29,7 @@ ## Overview The *STAC API - Item Search* specification defines the *STAC API - Item Search* -conformance class (), which +conformance class (), which provides the ability to search for STAC [Item](../stac-spec/item-spec/README.md) objects across collections. It retrieves a group of Item objects that match the provided parameters, wrapped in an @@ -275,8 +275,8 @@ the [overview](../overview.md#example-landing-page) document. "description": "This Catalog aims to demonstrate the a simple landing page", "type": "Catalog", "conformsTo" : [ - "https://api.stacspec.org/v1.0.0-rc.4/core", - "https://api.stacspec.org/v1.0.0-rc.4/item-search" + "https://api.stacspec.org/v1.0.0/core", + "https://api.stacspec.org/v1.0.0/item-search" ], "links": [ { diff --git a/item-search/openapi.yaml b/item-search/openapi.yaml index 7be53aa9..be8846b6 100644 --- a/item-search/openapi.yaml +++ b/item-search/openapi.yaml @@ -1,20 +1,20 @@ openapi: 3.0.3 info: title: STAC API - Item Search - version: 1.0.0-rc.4 + version: v1.0.0 description: >- This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Item Search specification. contact: name: STAC Specification - url: 'http://stacspec.org' + url: "http://stacspec.org" license: name: Apache License 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0' + url: "http://www.apache.org/licenses/LICENSE-2.0" tags: - name: Item Search description: essential characteristics of a STAC API -x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/item-search'] +x-conformance-classes: ["https://api.stacspec.org/v1.0.0/item-search"] paths: /search: get: @@ -33,26 +33,26 @@ paths: tags: - Item Search parameters: - - $ref: '#/components/parameters/bbox' - - $ref: '#/components/parameters/intersects' - - $ref: '#/components/parameters/datetime' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/ids' - - $ref: '#/components/parameters/collectionsArray' + - $ref: "#/components/parameters/bbox" + - $ref: "#/components/parameters/intersects" + - $ref: "#/components/parameters/datetime" + - $ref: "#/components/parameters/limit" + - $ref: "#/components/parameters/ids" + - $ref: "#/components/parameters/collectionsArray" responses: - '200': + "200": description: A feature collection. content: application/geo+json: schema: - $ref: '../fragments/itemcollection/openapi.yaml#/components/schemas/itemCollection' + $ref: "../fragments/itemcollection/openapi.yaml#/components/schemas/itemCollection" text/html: schema: type: string - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" post: summary: Search STAC items with full-featured filtering. operationId: postItemSearch @@ -71,21 +71,21 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/searchBody' + $ref: "#/components/schemas/searchBody" responses: - '200': + "200": description: A feature collection. content: application/geo+json: schema: - $ref: '../fragments/itemcollection/openapi.yaml#/components/schemas/itemCollection' + $ref: "../fragments/itemcollection/openapi.yaml#/components/schemas/itemCollection" text/html: schema: type: string - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" components: parameters: ids: @@ -95,7 +95,7 @@ components: Array of Item ids to return. required: false schema: - $ref: '#/components/schemas/ids' + $ref: "#/components/schemas/ids" explode: false collectionsArray: name: collections @@ -105,7 +105,7 @@ components: Only Item objects in one of the provided collections will be searched required: false schema: - $ref: '#/components/schemas/collectionsArray' + $ref: "#/components/schemas/collectionsArray" explode: false datetime: name: datetime @@ -205,7 +205,7 @@ components: a GeoJSON Geometry rather than a bbox. required: false schema: - $ref: '../core/commons.yaml#/components/schemas/geometryGeoJSON' + $ref: "../core/commons.yaml#/components/schemas/geometryGeoJSON" style: form explode: false schemas: @@ -213,12 +213,12 @@ components: description: The search criteria type: object allOf: - - $ref: '#/components/schemas/bboxFilter' - - $ref: '#/components/schemas/datetimeFilter' - - $ref: '#/components/schemas/intersectsFilter' - - $ref: '#/components/schemas/collectionsFilter' - - $ref: '#/components/schemas/idsFilter' - - $ref: '#/components/schemas/limitFilter' + - $ref: "#/components/schemas/bboxFilter" + - $ref: "#/components/schemas/datetimeFilter" + - $ref: "#/components/schemas/intersectsFilter" + - $ref: "#/components/schemas/collectionsFilter" + - $ref: "#/components/schemas/idsFilter" + - $ref: "#/components/schemas/limitFilter" limit: type: integer minimum: 1 @@ -240,7 +240,7 @@ components: description: Only return items that intersect the provided bounding box. properties: bbox: - $ref: '../core/commons.yaml#/components/schemas/bbox' + $ref: "../core/commons.yaml#/components/schemas/bbox" collectionsArray: type: array description: |- @@ -259,31 +259,31 @@ components: type: object properties: datetime: - $ref: '#/components/schemas/datetime_interval' + $ref: "#/components/schemas/datetime_interval" intersectsFilter: type: object description: Only returns items that intersect with the provided polygon. properties: intersects: - $ref: '../core/commons.yaml#/components/schemas/geometryGeoJSON' + $ref: "../core/commons.yaml#/components/schemas/geometryGeoJSON" limitFilter: type: object description: Only returns maximum number of results (page size) properties: limit: - $ref: '#/components/schemas/limit' + $ref: "#/components/schemas/limit" idsFilter: type: object description: Only returns items that match the array of given ids properties: ids: - $ref: '#/components/schemas/ids' + $ref: "#/components/schemas/ids" collectionsFilter: type: object description: Only returns the collections specified properties: collections: - $ref: '#/components/schemas/collectionsArray' + $ref: "#/components/schemas/collectionsArray" datetime_interval: type: string description: |- @@ -302,4 +302,4 @@ components: If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties. - example: '2018-02-12T00:00:00Z/2018-03-18T12:31:12Z' + example: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" diff --git a/ogcapi-features/README.md b/ogcapi-features/README.md index c5a8837a..95b064e5 100644 --- a/ogcapi-features/README.md +++ b/ogcapi-features/README.md @@ -26,11 +26,11 @@ ## Summary - **OpenAPI specifications:** - - [STAC API - Features](openapi-features.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features)) - - [STAC API - Collections](openapi-collections.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/collections)) + - [STAC API - Features](openapi-features.yaml) ([rendered version](https://api.stacspec.org/v1.0.0/ogcapi-features)) + - [STAC API - Collections](openapi-collections.yaml) ([rendered version](https://api.stacspec.org/v1.0.0/collections)) - **Conformance Class URIs:** - - - Features - - - Collections + - - Features + - - Collections - **[Maturity Classification](../README.md#maturity-classification):** Candidate - **Dependencies**: - [STAC API - Core](../core) @@ -51,19 +51,19 @@ entities. As these entities are also GeoJSON types, the GeoJSON conformance clas While OAFeat defines a single conformance class for its endpoints, STAC API divides these behaviors into two conformance classes -- Collections and Features. The STAC API - Features -() conformance class includes and extends the behavior -of OAFeat, while the STAC API - Collections () conformance +() conformance class includes and extends the behavior +of OAFeat, while the STAC API - Collections () conformance class is the subset of Features that pertains only to Collections. ### STAC API - Features -The *STAC API - Features* () conformance class +The *STAC API - Features* () conformance class encompasses all of the behavior described in this specification, as derived from OAFeat. ### STAC API - Collections -The *STAC API - Collections* () conformance class +The *STAC API - Collections* () conformance class requires only the subset of the behavior of Features that relates to Collections. This subset is: @@ -77,7 +77,7 @@ without needing to implement the entire *STAC API - Features* conformance class. ### OGC API - Features - Part 1: Core -A STAC API implementation that conforms to *STAC API - Features* () +A STAC API implementation that conforms to *STAC API - Features* () also conforms to [OGC API - Features - Part 1 Requirements Class Core](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#rc_core) conformance class (). @@ -355,9 +355,9 @@ the [overview](../overview.md#example-landing-page) document. "description": "This Catalog aims to demonstrate the a simple landing page", "type": "Catalog", "conformsTo" : [ - "https://api.stacspec.org/v1.0.0-rc.4/core", - "https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features", - "https://api.stacspec.org/v1.0.0-rc.4/collections", + "https://api.stacspec.org/v1.0.0/core", + "https://api.stacspec.org/v1.0.0/ogcapi-features", + "https://api.stacspec.org/v1.0.0/collections", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" diff --git a/ogcapi-features/openapi-collections.yaml b/ogcapi-features/openapi-collections.yaml index 743b41a3..e9489730 100644 --- a/ogcapi-features/openapi-collections.yaml +++ b/ogcapi-features/openapi-collections.yaml @@ -1,24 +1,24 @@ openapi: 3.0.3 info: title: STAC API - Collections - version: 1.0.0-rc.4 + version: v1.0.0 description: >- This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Collections specification. This is a subset of the STAC API - Features specification. contact: name: STAC Specification - url: 'http://stacspec.org' + url: "http://stacspec.org" license: name: Apache License 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0' - x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/collections'] + url: "http://www.apache.org/licenses/LICENSE-2.0" + x-conformance-classes: ["https://api.stacspec.org/v1.0.0/collections"] tags: - name: Core description: essential characteristics of a STAC API - name: Collections description: All endpoints related to STAC API - Collections paths: - '/': + "/": get: tags: - Core @@ -27,7 +27,7 @@ paths: The landing page provides links to the sub-resources. operationId: getLandingPage responses: - '200': + "200": description: |- The landing page provides links to the API definition (link relations `service-desc` and `service-doc`), @@ -38,40 +38,40 @@ paths: content: application/json: schema: - $ref: '../core/openapi.yaml#/components/schemas/landingPage' + $ref: "../core/openapi.yaml#/components/schemas/landingPage" example: - stac_version: '1.0.0' + stac_version: "1.0.0" type: Catalog id: sentinel title: Copernicus Sentinel Imagery description: Catalog of Copernicus Sentinel 1 and 2 imagery. conformsTo: - - 'https://api.stacspec.org/v1.0.0-rc.4/core' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson' + - "https://api.stacspec.org/v1.0.0/core" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" links: - - href: 'http://data.example.org/' + - href: "http://data.example.org/" rel: self type: application/json title: this document - - href: 'http://data.example.org/api' + - href: "http://data.example.org/api" rel: service-desc type: application/vnd.oai.openapi+json;version=3.0 title: the API definition - - href: 'http://data.example.org/api.html' + - href: "http://data.example.org/api.html" rel: service-doc type: text/html title: the API documentation - - href: 'http://data.example.org/conformance' + - href: "http://data.example.org/conformance" rel: conformance type: application/json title: OGC API conformance classes implemented by this server - - href: 'http://data.example.org/collections' + - href: "http://data.example.org/collections" rel: data type: application/json title: Information about the feature collections - '/collections': + "/collections": get: tags: - Collections @@ -81,13 +81,13 @@ paths: Request may not return the full set of metadata per Feature Collection. operationId: getCollections responses: - '200': - $ref: '#/components/responses/Collections' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '/collections/{collectionId}': + "200": + $ref: "#/components/responses/Collections" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "/collections/{collectionId}": get: tags: - Collections @@ -98,16 +98,16 @@ paths: Request this endpoint to get a full list of metadata for the Feature Collection. operationId: describeCollection parameters: - - $ref: '#/components/parameters/collectionId' + - $ref: "#/components/parameters/collectionId" responses: - '200': - $ref: '#/components/responses/Collection' - '404': - $ref: '#/components/responses/NotFound' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' + "200": + $ref: "#/components/responses/Collection" + "404": + $ref: "#/components/responses/NotFound" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" components: parameters: collectionId: @@ -125,11 +125,11 @@ components: - collections properties: links: - $ref: '../core/commons.yaml#/components/schemas/links' + $ref: "../core/commons.yaml#/components/schemas/links" collections: type: array items: - $ref: '../core/commons.yaml#/components/schemas/collection' + $ref: "../core/commons.yaml#/components/schemas/collection" responses: Collections: description: |- @@ -151,7 +151,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/collections' + $ref: "#/components/schemas/collections" Collection: description: |- Information about the feature collection with id `collectionId`. @@ -169,7 +169,7 @@ components: content: application/json: schema: - $ref: '../core/commons.yaml#/components/schemas/collection' + $ref: "../core/commons.yaml#/components/schemas/collection" NotFound: description: |- The requested URI was not found. diff --git a/ogcapi-features/openapi-features.yaml b/ogcapi-features/openapi-features.yaml index aa60df34..5e6c8cb3 100644 --- a/ogcapi-features/openapi-features.yaml +++ b/ogcapi-features/openapi-features.yaml @@ -1,24 +1,23 @@ openapi: 3.0.3 info: title: STAC API - Features - version: 1.0.0-rc.4 + version: v1.0.0 description: >- This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Features specification. This extends OGC API - Features - Part 1: Core. contact: name: STAC Specification - url: 'http://stacspec.org' + url: "http://stacspec.org" license: name: Apache License 2.0 - url: 'http://www.apache.org/licenses/LICENSE-2.0' - x-conformance-classes: - ['https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features'] + url: "http://www.apache.org/licenses/LICENSE-2.0" + x-conformance-classes: ["https://api.stacspec.org/v1.0.0/ogcapi-features"] tags: - name: Features description: |- All endpoints related to OGC API - Features - Part 1: Core paths: - '/': + "/": get: tags: - Features @@ -27,7 +26,7 @@ paths: The landing page provides links to the sub-resources. operationId: getLandingPage responses: - '200': + "200": description: |- The landing page provides links to the API definition (link relations `service-desc` and `service-doc`), @@ -38,40 +37,40 @@ paths: content: application/json: schema: - $ref: '../core/openapi.yaml#/components/schemas/landingPage' + $ref: "../core/openapi.yaml#/components/schemas/landingPage" example: - stac_version: '1.0.0' + stac_version: "1.0.0" type: Catalog id: sentinel title: Copernicus Sentinel Imagery description: Catalog of Copernicus Sentinel 1 and 2 imagery. conformsTo: - - 'https://api.stacspec.org/v1.0.0-rc.4/core' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson' + - "https://api.stacspec.org/v1.0.0/core" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" links: - - href: 'http://data.example.org/' + - href: "http://data.example.org/" rel: self type: application/json title: this document - - href: 'http://data.example.org/api' + - href: "http://data.example.org/api" rel: service-desc type: application/vnd.oai.openapi+json;version=3.0 title: the API definition - - href: 'http://data.example.org/api.html' + - href: "http://data.example.org/api.html" rel: service-doc type: text/html title: the API documentation - - href: 'http://data.example.org/conformance' + - href: "http://data.example.org/conformance" rel: conformance type: application/json title: OGC API conformance classes implemented by this server - - href: 'http://data.example.org/collections' + - href: "http://data.example.org/collections" rel: data type: application/json title: Information about the feature collections - '/conformance': + "/conformance": get: tags: - Features @@ -81,13 +80,13 @@ paths: server conforms to. operationId: getConformanceDeclaration responses: - '200': - $ref: '#/components/responses/ConformanceDeclaration' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '/collections': + "200": + $ref: "#/components/responses/ConformanceDeclaration" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "/collections": get: tags: - Features @@ -97,13 +96,13 @@ paths: Request may not return the full set of metadata per Feature Collection. operationId: getCollections responses: - '200': - $ref: '#/components/responses/Collections' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '/collections/{collectionId}': + "200": + $ref: "#/components/responses/Collections" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "/collections/{collectionId}": get: tags: - Features @@ -114,17 +113,17 @@ paths: Request this endpoint to get a full list of metadata for the Feature Collection. operationId: describeCollection parameters: - - $ref: '#/components/parameters/collectionId' + - $ref: "#/components/parameters/collectionId" responses: - '200': - $ref: '#/components/responses/Collection' - '404': - $ref: '#/components/responses/NotFound' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '/collections/{collectionId}/items': + "200": + $ref: "#/components/responses/Collection" + "404": + $ref: "#/components/responses/NotFound" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "/collections/{collectionId}/items": get: tags: - Features @@ -137,20 +136,20 @@ paths: collection of features of a similar type, based on a common schema. operationId: getFeatures parameters: - - $ref: '#/components/parameters/collectionId' - - $ref: '#/components/parameters/limit' - - $ref: '#/components/parameters/bbox' - - $ref: '#/components/parameters/datetime' + - $ref: "#/components/parameters/collectionId" + - $ref: "#/components/parameters/limit" + - $ref: "#/components/parameters/bbox" + - $ref: "#/components/parameters/datetime" responses: - '200': - $ref: '#/components/responses/Features' - '404': - $ref: '#/components/responses/NotFound' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '/collections/{collectionId}/items/{featureId}': + "200": + $ref: "#/components/responses/Features" + "404": + $ref: "#/components/responses/NotFound" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "/collections/{collectionId}/items/{featureId}": get: tags: - Features @@ -160,17 +159,17 @@ paths: with id `collectionId`. operationId: getFeature parameters: - - $ref: '#/components/parameters/collectionId' - - $ref: '#/components/parameters/featureId' + - $ref: "#/components/parameters/collectionId" + - $ref: "#/components/parameters/featureId" responses: - '200': - $ref: '#/components/responses/Feature' - '404': - $ref: '#/components/responses/NotFound' - '4XX': - $ref: '../core/commons.yaml#/components/responses/Error' - '5XX': - $ref: '../core/commons.yaml#/components/responses/Error' + "200": + $ref: "#/components/responses/Feature" + "404": + $ref: "#/components/responses/NotFound" + "4XX": + $ref: "../core/commons.yaml#/components/responses/Error" + "5XX": + $ref: "../core/commons.yaml#/components/responses/Error" components: parameters: bbox: @@ -281,14 +280,14 @@ components: - collections properties: links: - $ref: '../core/commons.yaml#/components/schemas/links' + $ref: "../core/commons.yaml#/components/schemas/links" collections: type: array items: - $ref: '../core/commons.yaml#/components/schemas/collection' + $ref: "../core/commons.yaml#/components/schemas/collection" featureCollectionGeoJSON: allOf: - - $ref: '../core/commons.yaml#/components/schemas/featureCollectionGeoJSON' + - $ref: "../core/commons.yaml#/components/schemas/featureCollectionGeoJSON" - type: object required: - features @@ -296,15 +295,15 @@ components: features: type: array items: - $ref: '../core/commons.yaml#/components/schemas/item' + $ref: "../core/commons.yaml#/components/schemas/item" links: - $ref: '../core/commons.yaml#/components/schemas/links' + $ref: "../core/commons.yaml#/components/schemas/links" timeStamp: - $ref: '#/components/schemas/timeStamp' + $ref: "#/components/schemas/timeStamp" numberMatched: - $ref: '#/components/schemas/numberMatched' + $ref: "#/components/schemas/numberMatched" numberReturned: - $ref: '#/components/schemas/numberReturned' + $ref: "#/components/schemas/numberReturned" numberMatched: description: |- The number of features of the feature type that match the selection @@ -328,7 +327,7 @@ components: description: This property indicates the time and date when the response was generated. type: string format: date-time - example: '2017-08-17T08:05:32Z' + example: "2017-08-17T08:05:32Z" responses: ConformanceDeclaration: description: |- @@ -341,12 +340,12 @@ components: content: application/json: schema: - $ref: '../core/commons.yaml#/components/schemas/conformanceClasses' + $ref: "../core/commons.yaml#/components/schemas/conformanceClasses" example: conformsTo: - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30' - - 'http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson' + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30" + - "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" Collections: description: |- The feature collections shared by this API. @@ -367,7 +366,7 @@ components: content: application/json: schema: - $ref: '#/components/schemas/collections' + $ref: "#/components/schemas/collections" Collection: description: |- Information about the feature collection with id `collectionId`. @@ -385,7 +384,7 @@ components: content: application/json: schema: - $ref: '../core/commons.yaml#/components/schemas/collection' + $ref: "../core/commons.yaml#/components/schemas/collection" Features: description: |- The response is a document consisting of features in the collection. @@ -410,7 +409,7 @@ components: content: application/geo+json: schema: - $ref: '#/components/schemas/featureCollectionGeoJSON' + $ref: "#/components/schemas/featureCollectionGeoJSON" Feature: description: |- fetch the feature with id `featureId` in the feature collection @@ -418,7 +417,7 @@ components: content: application/geo+json: schema: - $ref: '../core/commons.yaml#/components/schemas/item' + $ref: "../core/commons.yaml#/components/schemas/item" NotFound: description: |- The requested URI was not found. diff --git a/overview.md b/overview.md index 8ae45484..b6a10dc0 100644 --- a/overview.md +++ b/overview.md @@ -20,7 +20,7 @@ point for the more powerful capabilities - it contains a list of URLs with link 'relationships' (`rel`) and descriptions to indicate their functionality. Note that the [STAC Core specification](stac-spec) provides most of the content of API responses - the STAC API is primarily concerned with the return of STAC [Item](stac-spec/item-spec/README.md) and [Collection](stac-spec/collection-spec/README.md) objects via a -web API. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0-rc.4/core) for more details. +web API. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0/core) for more details. There are then two major sets of functionality that build on the core, [Item Search](item-search) and [Collection and Features](ogcapi-features) , which are designed to be complementary, letting @@ -33,7 +33,7 @@ located at a `/search` endpoint. It re-uses all of the OAFeat [query parameters](http://docs.opengeospatial.org/is/17-069r3/17-069r3.html#_items_) specified in their 'core', and adds a few more. It does not require a full implementation of OAFeat, but it is instead a simplified construct that can run a search across any group of STAC [`Item`](stac-spec/item-spec/README.md) objects. See the [rendered OpenAPI -document](https://api.stacspec.org/v1.0.0-rc.4/item-search) for more details. +document](https://api.stacspec.org/v1.0.0/item-search) for more details. ### Collections and Features @@ -50,7 +50,7 @@ Full compliance involves splitting STAC `Item` objects into individual `/collections/{collectionId}/items` endpoints that expose querying single collections, as OAFeat does not currently support cross-collection search. It also adds a few other requirements, which are highlighted in the [features description](ogcapi-features/), in order to help STAC implementors understand OAFeat without having to -read the full specification from scratch. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features) +read the full specification from scratch. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0/ogcapi-features) for more details. ### Extensions & Fragments @@ -116,12 +116,12 @@ conformance URIs serve up a rendered HTML version of the corresponding OpenAPI d ### Conformance Class Table -| **Name** | **Specified in** | **Conformance URI** | **Description** | -| ---------------------- | ------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | -| STAC API - Core | [Core](core) | | Specifies the STAC Landing page `/`, communicating conformance and available endpoints. | -| STAC API - Item Search | [Item Search](item-search) | | Enables search of all STAC Item objects on the server, with the STAC `[/search](#stac-api-endpoints)` endpoint. | -| STAC API - Features | [Collections and Features](ogcapi-features) | | Specifies the use of OGC API - Features to serve STAC Item and Collection objects | -| STAC API - Collections | [Collections and Features](ogcapi-features) | | Specifies the use of a subset of STAC API - Features to serve Collection objects | +| **Name** | **Specified in** | **Conformance URI** | **Description** | +| ---------------------- | ------------------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- | +| STAC API - Core | [Core](core) | | Specifies the STAC Landing page `/`, communicating conformance and available endpoints. | +| STAC API - Item Search | [Item Search](item-search) | | Enables search of all STAC Item objects on the server, with the STAC `[/search](#stac-api-endpoints)` endpoint. | +| STAC API - Features | [Collections and Features](ogcapi-features) | | Specifies the use of OGC API - Features to serve STAC Item and Collection objects | +| STAC API - Collections | [Collections and Features](ogcapi-features) | | Specifies the use of a subset of STAC API - Features to serve Collection objects | Additional conformance classes can be specified by [STAC API Extensions](extensions.md). @@ -143,10 +143,10 @@ The Landing Page will at least have the following `conformsTo` and `links`: "description": "This Catalog aims to demonstrate the a simple landing page", "type": "Catalog", "conformsTo" : [ - "https://api.stacspec.org/v1.0.0-rc.4/core", - "https://api.stacspec.org/v1.0.0-rc.4/collections", - "https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features", - "https://api.stacspec.org/v1.0.0-rc.4/item-search", + "https://api.stacspec.org/v1.0.0/core", + "https://api.stacspec.org/v1.0.0/collections", + "https://api.stacspec.org/v1.0.0/ogcapi-features", + "https://api.stacspec.org/v1.0.0/item-search", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/oas30", "http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/geojson" diff --git a/package-lock.json b/package-lock.json index f0f48256..f0e840bd 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "api-spec", - "version": "1.0.0-rc.4", + "version": "v1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "api-spec", - "version": "1.0.0-rc.4", + "version": "v1.0.0", "license": "Apache-2.0", "dependencies": { "@redocly/openapi-cli": "^1.0.0-beta.94", @@ -4575,6 +4575,15 @@ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==" }, + "node_modules/redoc-cli/node_modules/@types/mkdirp": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/@types/mkdirp/-/mkdirp-1.0.1.tgz", + "integrity": "sha512-HkGSK7CGAXncr8Qn/0VqNtExEE+PHMWb+qlR1faHMao7ng6P3tAaoWWBMdva0gL5h4zprjIO89GJOLXsMcDm1Q==", + "extraneous": true, + "dependencies": { + "@types/node": "*" + } + }, "node_modules/redoc-cli/node_modules/@types/node": { "version": "15.12.2", "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", @@ -13042,6 +13051,14 @@ "resolved": "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.9.tgz", "integrity": "sha512-qcUXuemtEu+E5wZSJHNxUXeCZhAfXKQ41D+duX+VYPde7xyEVZci+/oXKJL13tnRs9lR2pr4fod59GT6/X1/yQ==" }, + "@types/mkdirp": { + "version": "https://registry.npmjs.org/@types/mkdirp/-/mkdirp-1.0.1.tgz", + "integrity": "sha512-HkGSK7CGAXncr8Qn/0VqNtExEE+PHMWb+qlR1faHMao7ng6P3tAaoWWBMdva0gL5h4zprjIO89GJOLXsMcDm1Q==", + "extraneous": true, + "requires": { + "@types/node": "*" + } + }, "@types/node": { "version": "15.12.2", "resolved": "https://registry.npmjs.org/@types/node/-/node-15.12.2.tgz", diff --git a/package.json b/package.json index 4ab5918c..7375065d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "api-spec", - "version": "1.0.0-rc.4", + "version": "v1.0.0", "description": "STAC API helpers to generate, serve and check the API spec.", "repository": "https://github.com/radiantearth/stac-api-spec", "license": "Apache-2.0",