Skip to content

Commit

Permalink
Merge pull request #344 from philvarner/pv/1.0.0-rc.2-release
Browse files Browse the repository at this point in the history
1.0.0-rc.2 release
  • Loading branch information
philvarner committed Nov 1, 2022
2 parents f53e499 + a77a0f8 commit d4f8b4a
Show file tree
Hide file tree
Showing 15 changed files with 65 additions and 59 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,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).

## [Unreleased] - TBD
## [1.0.0-rc.2]

### Added

Expand Down Expand Up @@ -227,6 +227,11 @@ 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]: <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>
[Unreleased]: <https://github.com/radiantearth/stac-api-spec/compare/v1.0.0-rc.2...main>
[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>
[v1.0.0-beta.4]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.4>
[v1.0.0-beta.3]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.3>
[v1.0.0-beta.2]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.2>
[v1.0.0-beta.1]: <https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.1>
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.1](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.1) (latest)
- [v1.0.0-rc.2](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-rc.2) (latest)
- [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)
- [v1.0.0-beta.4](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.4)
- [v1.0.0-beta.3](https://github.com/radiantearth/stac-api-spec/tree/v1.0.0-beta.3)
Expand Down Expand Up @@ -55,12 +56,12 @@ 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.1>, in addition to human-readable documentation.
rendered online into HTML at <https://api.stacspec.org/v1.0.0-rc.2>, 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. For 1.0.0-rc.1, we remain fully aligned with [OGC API -
currently in a 'beta' state, with no major changes anticipated. For v1.0.0-rc.2, 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
specification follows [Semantic Versioning](https://semver.org/), so once 1.0.0 is reached any breaking change
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.5
version: 1.0.0-rc.2
apis:
- url: 'build/core/openapi.yaml'
paths:
Expand Down
18 changes: 9 additions & 9 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,19 @@
- [Extensions](#extensions)
- [Structuring Catalog Hierarchies](#structuring-catalog-hierarchies)

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

All STAC API implementations must implement the *STAC API - Core* specification. The conformance class
<https://api.stacspec.org/v1.0.0-rc.1/core> requires a server to provide a valid
<https://api.stacspec.org/v1.0.0-rc.2/core> requires a server to provide a valid
[STAC Catalog](../stac-spec/catalog-spec/catalog-spec.md) that also includes a `conformsTo`
attribute with a string array value. Any API implementing this is considered a valid STAC API. Additionally,
a STAC API conforming conformance class (<https://api.stacspec.org/v1.0.0-rc.1/browseable>) must be structured
a STAC API conforming conformance class (<https://api.stacspec.org/v1.0.0-rc.2/browseable>) must be structured
such that all Items in the catalog can be accessed by following `child` and `item` link relations.

Even if a STAC catalog is simply files on a web server or objects in cloud storage, serving these files over HTTP
Expand All @@ -31,7 +31,7 @@ this "browse" mode of interaction is complementary to the dynamic search capabil
Conversely, STAC API implementations may not support browse, even though the root is a Catalog object, if they do not
have the appropriate `child` and `item` link relations to traverse over the objects in the catalog. STAC API
implementations may provide an even greater guarantee of Item reachability with the
browseable conformance class (<https://api.stacspec.org/v1.0.0-rc.1/browseable>).
browseable conformance class (<https://api.stacspec.org/v1.0.0-rc.2/browseable>).

Providing these two complementary ways of interacting with the catalog allow users to iteratively interrogate the data
to discover what data is available through browse and filter the data to only what they are interested in
Expand Down Expand Up @@ -76,7 +76,7 @@ support the *STAC API - Item Search* conformance class, perhaps because it uses
but sub-catalogs whose items are all in one database can support search.

A STAC API conforming to the *STAC API - Browseable* conformance class
(<https://api.stacspec.org/v1.0.0-rc.1/browseable>) must be structured such that
(<https://api.stacspec.org/v1.0.0-rc.2/browseable>) must be structured such that
all Items in the catalog can be accessed by following `child` and `item` link relations. This is a more significant
constraint than a STAC API without this conformance class or a STAC Catalog that is available over HTTP but does not
implement STAC API, neither of which have any guarantee regarding the reachability of Items. This conformance
Expand Down Expand Up @@ -114,7 +114,7 @@ Additionally, `child` relations may exist to child Catalogs and Collections and
relations form a directed graph that enables traversal from a root catalog or collection to items.

If all Items in a Catalog can be accessed by traversing these links, the browseable conformance class
<https://api.stacspec.org/v1.0.0-rc.1/browseable> should be advertised also.
<https://api.stacspec.org/v1.0.0-rc.2/browseable> should be advertised also.

| **rel** | **href** | **From** | **Description** |
| ------- | -------- | --------- | -------------------------------------- |
Expand Down Expand Up @@ -186,7 +186,7 @@ different conformance classes and a different set of links.
"description": "This Catalog aims to demonstrate the a simple landing page",
"type": "Catalog",
"conformsTo" : [
"https://api.stacspec.org/v1.0.0-rc.1/core"
"https://api.stacspec.org/v1.0.0-rc.2/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.1
version: 1.0.0-rc.2
paths: {}
components:
responses:
Expand Down
4 changes: 2 additions & 2 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.1
version: 1.0.0-rc.2
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 Down Expand Up @@ -63,7 +63,7 @@ components:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.1/core'
- 'https://api.stacspec.org/v1.0.0-rc.2/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.1
version: 1.0.0-rc.2
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 @@ -15,15 +15,15 @@
- [Example Landing Page for STAC API - Item Search](#example-landing-page-for-stac-api---item-search)
- [Extensions](#extensions)

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

The *STAC API - Item Search* specification defines the *STAC API - Item Search*
conformance class (<https://api.stacspec.org/v1.0.0-rc.1/item-search>), which
conformance class (<https://api.stacspec.org/v1.0.0-rc.2/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 @@ -248,8 +248,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.1/core",
"https://api.stacspec.org/v1.0.0-rc.1/item-search"
"https://api.stacspec.org/v1.0.0-rc.2/core",
"https://api.stacspec.org/v1.0.0-rc.2/item-search"
],
"links": [
{
Expand Down
2 changes: 1 addition & 1 deletion 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.1
version: 1.0.0-rc.2
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Item Search
specification.
Expand Down
24 changes: 12 additions & 12 deletions ogcapi-features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@
*based on [**OGC API - Features - Part 1: Core**](https://www.ogc.org/standards/ogcapi-features)*

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

This subset is:
Expand All @@ -67,7 +67,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.1/ogcapi-features>)
A STAC API implementation that conforms to *STAC API - Features* (<https://api.stacspec.org/v1.0.0-rc.2/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 @@ -310,9 +310,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.1/core",
"https://api.stacspec.org/v1.0.0-rc.1/ogcapi-features",
"https://api.stacspec.org/v1.0.0-rc.1/collections",
"https://api.stacspec.org/v1.0.0-rc.2/core",
"https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features",
"https://api.stacspec.org/v1.0.0-rc.2/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
4 changes: 2 additions & 2 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.1'
version: 1.0.0-rc.2
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 Down Expand Up @@ -45,7 +45,7 @@ paths:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.1/core'
- 'https://api.stacspec.org/v1.0.0-rc.2/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
4 changes: 2 additions & 2 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.1'
version: 1.0.0-rc.2
description: >-
This is an OpenAPI definition of the SpatioTemporal Asset Catalog API - Features
specification. This extends OGC API - Features - Part 1: Core.
Expand Down Expand Up @@ -44,7 +44,7 @@ paths:
title: Copernicus Sentinel Imagery
description: Catalog of Copernicus Sentinel 1 and 2 imagery.
conformsTo:
- 'https://api.stacspec.org/v1.0.0-rc.1/core'
- 'https://api.stacspec.org/v1.0.0-rc.2/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
Loading

0 comments on commit d4f8b4a

Please sign in to comment.