Skip to content

Commit

Permalink
Merge pull request #415 from philvarner/pv/release-prep-1.0.0-rc.4
Browse files Browse the repository at this point in the history
release prep 1.0.0-rc.4
  • Loading branch information
philvarner committed Apr 17, 2023
2 parents 6f6c8dd + bbc2abd commit 80932ce
Show file tree
Hide file tree
Showing 15 changed files with 73 additions and 55 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ 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-rc.4] - TBD
## [v1.0.0-rc.4] - 2023-04-13

## Changed

Expand Down
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -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.3
version: 1.0.0-rc.4
year: 2023
date-released: 2023-03-27
date-released: 2023-04-13
license: Apache-2.0
url: https://stacspec.org
repository: https://github.com/radiantearth/stac-api-spec
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@

## Releases (stable)

- [v1.0.0-rc.3](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.3) (latest)
- [v1.0.0-rc.4](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.4) (latest)
- [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)
- [v1.0.0-beta.5](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.5)
Expand Down Expand Up @@ -58,13 +59,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 <https://api.stacspec.org/v1.0.0-rc.3>, in addition to human-readable documentation.
rendered online into HTML at <https://api.stacspec.org/v1.0.0-rc.4>, 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.3, we remain fully aligned with
As of v1.0.0-rc.4, 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
Expand Down
8 changes: 4 additions & 4 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@

## Summary

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.3/core)),
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/core)),
- **Conformance URIs:**
- <https://api.stacspec.org/v1.0.0-rc.3/core>
- <https://api.stacspec.org/v1.0.0-rc.4/core>
- **[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.

## Overview

All STAC API implementations must implement the *STAC API - Core* conformance class
<https://api.stacspec.org/v1.0.0-rc.3/core>. This requires a server to return from a root endpoint a valid
<https://api.stacspec.org/v1.0.0-rc.4/core>. 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.

Expand Down Expand Up @@ -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.3/core"
"https://api.stacspec.org/v1.0.0-rc.4/core"
],
"links": [
{
Expand Down
2 changes: 1 addition & 1 deletion 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-rc.3
version: 1.0.0-rc.4
paths: {}
components:
responses:
Expand Down
6 changes: 3 additions & 3 deletions core/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: STAC API - Core
version: 1.0.0-rc.3
version: 1.0.0-rc.4
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Core
specification. Any service that implements this endpoint to allow discovery of
Expand All @@ -12,7 +12,7 @@ info:
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.3/core']
x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/core']
tags:
- name: Core
description: essential characteristics of a STAC API
Expand Down Expand Up @@ -64,7 +64,7 @@ components:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.3/core'
- 'https://api.stacspec.org/v1.0.0-rc.4/core'
links:
- href: 'http://data.example.org/'
rel: self
Expand Down
2 changes: 1 addition & 1 deletion fragments/itemcollection/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 - Item Collection
description: The specification for a set of items, e.g. returned by a search.
version: 1.0.0-rc.3
version: 1.0.0-rc.4
paths: {}
components:
schemas:
Expand Down
10 changes: 5 additions & 5 deletions item-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@

## Summary

- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.3/item-search))
- **OpenAPI specification:** [openapi.yaml](openapi.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.4/item-search))
- **Conformance URIs:**
- <https://api.stacspec.org/v1.0.0-rc.3/item-search>
- <https://api.stacspec.org/v1.0.0-rc.4/item-search>
- **[Maturity Classification](../README.md#maturity-classification):** Candidate
- **Dependencies**: [STAC API - Core](../core)
- **Examples**: [examples.md](examples.md)

## Overview

The *STAC API - Item Search* specification defines the *STAC API - Item Search*
conformance class (<https://api.stacspec.org/v1.0.0-rc.3/item-search>), which
conformance class (<https://api.stacspec.org/v1.0.0-rc.4/item-search>), 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
Expand Down Expand Up @@ -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.3/core",
"https://api.stacspec.org/v1.0.0-rc.3/item-search"
"https://api.stacspec.org/v1.0.0-rc.4/core",
"https://api.stacspec.org/v1.0.0-rc.4/item-search"
],
"links": [
{
Expand Down
4 changes: 2 additions & 2 deletions item-search/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: STAC API - Item Search
version: 1.0.0-rc.3
version: 1.0.0-rc.4
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Item Search
specification.
Expand All @@ -14,7 +14,7 @@ info:
tags:
- name: Item Search
description: essential characteristics of a STAC API
x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.3/item-search']
x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/item-search']
paths:
/search:
get:
Expand Down
24 changes: 12 additions & 12 deletions ogcapi-features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@
## Summary

- **OpenAPI specifications:**
- [STAC API - Features](openapi-features.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features))
- [STAC API - Collections](openapi-collections.yaml) ([rendered version](https://api.stacspec.org/v1.0.0-rc.3/collections))
- [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))
- **Conformance Class URIs:**
- <https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features> - Features
- <https://api.stacspec.org/v1.0.0-rc.3/collections> - Collections
- <https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features> - Features
- <https://api.stacspec.org/v1.0.0-rc.4/collections> - Collections
- **[Maturity Classification](../README.md#maturity-classification):** Candidate
- **Dependencies**:
- [STAC API - Core](../core)
Expand All @@ -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
(<https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features>) conformance class includes and extends the behavior
of OAFeat, while the STAC API - Collections (<https://api.stacspec.org/v1.0.0-rc.3/collections>) conformance
(<https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features>) conformance class includes and extends the behavior
of OAFeat, while the STAC API - Collections (<https://api.stacspec.org/v1.0.0-rc.4/collections>) conformance
class is the subset of Features that pertains only to Collections.

### STAC API - Features

The *STAC API - Features* (<https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features>) conformance class
The *STAC API - Features* (<https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features>) conformance class
encompasses all of the behavior described in this specification, as
derived from OAFeat.

### STAC API - Collections

The *STAC API - Collections* (<https://api.stacspec.org/v1.0.0-rc.3/collections>) conformance class
The *STAC API - Collections* (<https://api.stacspec.org/v1.0.0-rc.4/collections>) conformance class
requires only the subset of the behavior of Features that relates to Collections.

This subset is:
Expand All @@ -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* (<https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features>)
A STAC API implementation that conforms to *STAC API - Features* (<https://api.stacspec.org/v1.0.0-rc.4/ogcapi-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 (<http://www.opengis.net/spec/ogcapi-features-1/1.0/conf/core>).
Expand Down Expand Up @@ -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.3/core",
"https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features",
"https://api.stacspec.org/v1.0.0-rc.3/collections",
"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",
"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"
Expand Down
6 changes: 3 additions & 3 deletions ogcapi-features/openapi-collections.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: STAC API - Collections
version: 1.0.0-rc.3
version: 1.0.0-rc.4
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Collections
specification. This is a subset of the STAC API - Features specification.
Expand All @@ -11,7 +11,7 @@ info:
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.3/collections']
x-conformance-classes: ['https://api.stacspec.org/v1.0.0-rc.4/collections']
tags:
- name: Core
description: essential characteristics of a STAC API
Expand Down Expand Up @@ -46,7 +46,7 @@ paths:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.3/core'
- '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'
Expand Down
6 changes: 3 additions & 3 deletions ogcapi-features/openapi-features.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: STAC API - Features
version: 1.0.0-rc.3
version: 1.0.0-rc.4
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Features
specification. This extends OGC API - Features - Part 1: Core.
Expand All @@ -12,7 +12,7 @@ info:
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.3/ogcapi-features']
['https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features']
tags:
- name: Features
description: |-
Expand Down Expand Up @@ -46,7 +46,7 @@ paths:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.3/core'
- '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'
Expand Down
22 changes: 11 additions & 11 deletions overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.3/core) for more details.
web API. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0-rc.4/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
Expand All @@ -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.3/item-search) for more details.
document](https://api.stacspec.org/v1.0.0-rc.4/item-search) for more details.

### Collections and Features

Expand All @@ -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.3/ogcapi-features)
read the full specification from scratch. See the [rendered OpenAPI document](https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features)
for more details.

### Extensions & Fragments
Expand Down Expand Up @@ -118,10 +118,10 @@ conformance URIs serve up a rendered HTML version of the corresponding OpenAPI d

| **Name** | **Specified in** | **Conformance URI** | **Description** |
| ---------------------- | ------------------------------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
| STAC API - Core | [Core](core) | <https://api.stacspec.org/v1.0.0-rc.3/core> | Specifies the STAC Landing page `/`, communicating conformance and available endpoints. |
| STAC API - Item Search | [Item Search](item-search) | <https://api.stacspec.org/v1.0.0-rc.3/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) | <https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features> | Specifies the use of OGC API - Features to serve STAC Item and Collection objects |
| STAC API - Collections | [Collections and Features](ogcapi-features) | <https://api.stacspec.org/v1.0.0-rc.3/collections> | Specifies the use of a subset of STAC API - Features to serve Collection objects |
| STAC API - Core | [Core](core) | <https://api.stacspec.org/v1.0.0-rc.4/core> | Specifies the STAC Landing page `/`, communicating conformance and available endpoints. |
| STAC API - Item Search | [Item Search](item-search) | <https://api.stacspec.org/v1.0.0-rc.4/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) | <https://api.stacspec.org/v1.0.0-rc.4/ogcapi-features> | Specifies the use of OGC API - Features to serve STAC Item and Collection objects |
| STAC API - Collections | [Collections and Features](ogcapi-features) | <https://api.stacspec.org/v1.0.0-rc.4/collections> | 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).

Expand All @@ -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.3/core",
"https://api.stacspec.org/v1.0.0-rc.3/collections",
"https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features",
"https://api.stacspec.org/v1.0.0-rc.3/item-search",
"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",
"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"
Expand Down
Loading

0 comments on commit 80932ce

Please sign in to comment.