Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update stac_version references to 1.0.0 and stac api references to 1.0.0-beta.2 #148

Merged
merged 3 commits into from
Jun 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]

### Added

### Changed

### Deprecated

### Removed

### Fixed

## [v1.0.0-beta.2] - 2020-06-01

### Added
- Added Filter extension to integrate OAFeat Part 3 CQL
- Catalog and Collection definitions now have required field "type"
- Added recommendation to enable CORS for public APIs

### Changed
- Added Filter extension to integrate OAFeat Part 3 CQL
- Updated all STAC versions to 1.0.0
- 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
- Query extension is now deprecated. Replaced by the Filter extension using OGC CQL.

### Removed

Expand Down Expand Up @@ -59,3 +72,4 @@ for STAC API releases prior to or equal to version 0.9.0.

[Unreleased]: <https://github.com/radiantearth/stac-api-spec/compare/master...dev>
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
[v1.0.0-beta.2]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2>
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ 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 <https://api.stacspec.org/v1.0.0-beta.1>, in addition to human-readable documentation.
rendered online into HTML at <https://api.stacspec.org/v1.0.0-beta.2>, in addition to human-readable documentation.

## Stability Note

Expand Down
2 changes: 1 addition & 1 deletion build/swagger-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: STAC API - Complete
version: 1.0.0-beta.1
version: 1.0.0-beta.2
apis:
- url: 'build/core/openapi.yaml'
paths:
Expand Down
8 changes: 4 additions & 4 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
- [Recommended Link Relations at `/`](#recommended-link-relations-at-)
- [Example Landing Page for STAC API - Core](#example-landing-page-for-stac-api---core)

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) describes the core endpoints ([rendered version](https://api.stacspec.org/v1.0.0-beta.1/core)),
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) describes the core endpoints ([rendered version](https://api.stacspec.org/v1.0.0-beta.2/core)),
and [commons.yaml](commons.yaml) is the OpenAPI version of the core [STAC spec](../stac-spec) JSON Schemas.
- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.1/core>
- **Conformance URI:** <https://api.stacspec.org/v1.0.0-beta.2/core>
- **Extension [Maturity Classification](../extensions.md#extension-maturity):** Pilot
- **Dependencies**: None

Expand Down Expand Up @@ -70,12 +70,12 @@ the [overview](../overview.md#example-landing-page) document.

```json
{
"stac_version": "1.0.0-beta.2",
"stac_version": "1.0.0",
"id": "example-stac",
"title": "A simple STAC API Example",
"description": "This Catalog aims to demonstrate the a simple landing page",
"conformsTo" : [
"https://api.stacspec.org/v1.0.0-beta.1/core"
"https://api.stacspec.org/v1.0.0-beta.2/core"
],
"links": [
{
Expand Down
40 changes: 20 additions & 20 deletions core/commons.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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-beta.1
version: 1.0.0-beta.2
paths: {}
components:
responses:
Expand Down Expand Up @@ -100,7 +100,7 @@ components:
license:
$ref: '#/components/schemas/license'
extent:
$ref: "#/components/schemas/extent"
$ref: '#/components/schemas/extent'
providers:
$ref: '#/components/schemas/providers'
links:
Expand Down Expand Up @@ -148,7 +148,7 @@ components:
- type: string
- type: number
example:
stac_version: 1.0.0-beta.2
stac_version: 1.0.0
stac_extensions: []
type: Collection
id: Sentinel-2
Expand Down Expand Up @@ -272,7 +272,7 @@ components:
bbox:
description: |-
One or more bounding boxes that describe the spatial extent of the dataset.

The first bounding box describes the overall spatial
extent of the data. All subsequent bounding boxes describe
more precise bounding boxes, e.g., to identify clusters of data.
Expand Down Expand Up @@ -437,7 +437,7 @@ components:
`proprietary` if the license is not on the SPDX license list or
`various` if multiple licenses apply. In these two cases links to the
license texts SHOULD be added, see the `license` link relation type.

Non-SPDX licenses SHOULD add a link to the license text with the
`license` relation in the links section. The license text MUST NOT be
provided as a value of this field. If there is no public license URL
Expand Down Expand Up @@ -556,7 +556,7 @@ components:
stac_version:
title: STAC version
type: string
example: 1.0.0-beta.2
example: 1.0.0
stac_extensions:
title: STAC extensions
type: array
Expand All @@ -569,7 +569,7 @@ components:
- title: Reference to a core extension
type: string
item:
description: A GeoJSON Feature augmented with foreign members that contain values relevant to a STAC entity
description: A GeoJSON Feature augmented with foreign members that contain values relevant to a STAC entity
type: object
required:
- stac_version
Expand All @@ -590,7 +590,7 @@ components:
bbox:
$ref: '#/components/schemas/bbox'
geometry:
$ref: "#/components/schemas/geometryGeoJSON"
$ref: '#/components/schemas/geometryGeoJSON'
type:
$ref: '#/components/schemas/itemType'
links:
Expand Down Expand Up @@ -713,16 +713,16 @@ components:
type: string
description: Purposes of the asset
example:
- thumbnail
- 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:
Expand All @@ -736,7 +736,7 @@ components:
geometries:
type: array
items:
$ref: "#/components/schemas/geometryGeoJSON"
$ref: '#/components/schemas/geometryGeoJSON'
linestringGeoJSON:
type: object
required:
Expand Down Expand Up @@ -862,7 +862,7 @@ components:
features:
type: array
items:
$ref: "#/components/schemas/featureGeoJSON"
$ref: '#/components/schemas/featureGeoJSON'
featureGeoJSON:
type: object
required:
Expand All @@ -875,7 +875,7 @@ components:
enum:
- Feature
geometry:
$ref: "#/components/schemas/geometryGeoJSON"
$ref: '#/components/schemas/geometryGeoJSON'
properties:
type: object
nullable: true
nullable: true
8 changes: 4 additions & 4 deletions core/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: The SpatioTemporal Asset Catalog API - Core
version: 1.0.0-beta.1
version: 1.0.0-beta.2
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow discovery of
Expand Down Expand Up @@ -58,12 +58,12 @@ components:
$ref: '#/components/schemas/landingPage'
example:
type: Catalog
stac_version: 1.0.0-beta.1
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-beta.1/core'
- 'https://api.stacspec.org/v1.0.0-beta.2/core'
links:
- href: 'http://data.example.org/'
rel: self
Expand All @@ -84,4 +84,4 @@ components:
- href: 'http://data.example.org/sentinel-2'
rel: child
type: application/json
title: Sentinel 2 Catalog
title: Sentinel 2 Catalog
17 changes: 8 additions & 9 deletions extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ on the extension.
| Pilot | 1 | Idea is fleshed out, with examples and a JSON schema, and implemented in one or more catalogs. Additional implementations encouraged to help give feedback | Approaching stability - breaking changes are not anticipated but can easily come from additional feedback |
| Candidate | 3 | A number of implementers are using it and are standing behind it as a solid extension. Can generally count on an extension at this maturity level | Mostly stable, breaking changes require a new version and minor changes are unlikely. |
| Stable | 6 | Highest current level of maturity. The community of extension maintainers commits to a STAC review process for any changes, which are not made lightly. | Completely stable, all changes require a new version number and review process. |
| Deprecated | N/A | A previous extension that has likely been superceded by a newer one or did not work out for some reason. | DO NOT USE, is not supported |
| Deprecated | N/A | A previous extension that has likely been superseded by a newer one or did not work out for some reason. | DO NOT USE, is not supported |

Maturity mostly comes through diverse implementations, so the minimum number of implementations
column is the main gating function for an extension to mature. But extension authors can also
Expand Down Expand Up @@ -67,14 +67,13 @@ the service supports. This are listed at the top of each extension description,

| 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> |

| [Fields](item-search/README.md#fields) | <https://api.stacspec.org/v1.0.0-beta.2/item-search#fields> |
| [Filter](item-search/README.md#filter) | <https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:filter><br/><https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:simple-cql><br/><https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:item-search-filter><br/><https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:cql-text><br/><https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:cql-json> |
| [Context](item-search/README.md#context) | <https://api.stacspec.org/v1.0.0-beta.2/item-search#context> |
| [Sort](item-search/README.md#sort) | <https://api.stacspec.org/v1.0.0-beta.2/item-search#sort> |
| [Transaction](ogcapi-features/extensions/transaction/README.md) | <https://api.stacspec.org/v1.0.0-beta.2/ogcapi-features/extensions/transaction> |
| [Items and Collections API Version](ogcapi-features/extensions/version/README.md) | <https://api.stacspec.org/v1.0.0-beta.2/ogcapi-features/extensions/version> |
| [Query](item-search/README.md#query) | <https://api.stacspec.org/v1.0.0-beta.2/item-search#query> |

## Third-party / vendor extensions

Expand Down
14 changes: 7 additions & 7 deletions fragments/context/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +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>
- **Conformance Class:** <https://api.stacspec.org/v1.0.0-beta.2/item-search#context>
- **Fragment [Maturity Classification](../../extensions.md#extension-maturity):** Pilot
- **Dependents:**
- [Item Search](../../item-search)
Expand All @@ -20,16 +20,16 @@ implementing OGC API - Features.*

## ItemCollection fields

| Element | Type | Description |
| --------- | --------------------------------- | ----------- |
| Element | Type | Description |
| --------- | --------------------------------- | ------------------------------------------------------------------------------------------------ |
| `context` | [Context Object](#context-object) | **REQUIRED.** The search-related metadata for the [ItemCollection](../itemcollection/README.md). |

## Context Object

| Element | Type | Description |
| -------- | --------------- | ----------- |
| returned | integer | **REQUIRED** The count of results returned by this response. Equal to the cardinality of features array. |
| limit | integer \| null | The maximum number of results to which the result was limited. |
| Element | Type | Description |
| -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| returned | integer | **REQUIRED** The count of results returned by this response. Equal to the cardinality of features array. |
| limit | integer \| null | The maximum number of results to which the result was limited. |
| matched | integer | The count of total number of results that match for this query, possibly estimated, particularly in the context of NoSQL data stores. |

The default sort of query results should be stable, but may not be depending on the data store's sorting performance.
Expand Down
2 changes: 1 addition & 1 deletion fragments/context/examples/example.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
},
"features": [
{
"stac_version": "1.0.0-beta.2",
"stac_version": "1.0.0",
"stac_extensions": [],
"type": "Feature",
"id": "CS3-20160503_132131_05",
Expand Down
2 changes: 1 addition & 1 deletion fragments/context/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: The SpatioTemporal Asset Catalog API - Context
description: Adds search related metadata (context) to GeoJSON Responses.
version: 1.0.0-beta.1
version: 1.0.0-beta.2
paths: {}
components:
schemas:
Expand Down
2 changes: 1 addition & 1 deletion fragments/fields/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +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>
- **Conformance Class:** <https://api.stacspec.org/v1.0.0-beta.2/item-search#fields>
- **Fragment [Maturity Classification](../../extensions.md#extension-maturity):** Pilot
- **Dependents:**
- [Item Search](../../item-search)
Expand Down
2 changes: 1 addition & 1 deletion fragments/fields/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.3
info:
title: The SpatioTemporal Asset Catalog API - Fields
description: Adds parameter to control which fields are returned in the response.
version: 1.0.0-beta.1
version: 1.0.0-beta.2
paths: {}
components:
parameters:
Expand Down
Loading