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

release prep 1.0.0-rc.4 #415

Merged
merged 3 commits into from
Apr 17, 2023
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
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,21 @@ 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] - 2023-04-13

## Changed

- Field `type` is no longer required for all Link objects, but is instead strongly
recommended. This was added as a requirement in 1.0.0-rc.3 based on a mis-reading
of the OGC Features spec, and is now removed as a requirement.

## [v1.0.0-rc.3] - 2023-03-27

## Changed

- Browseable has been moved to an extension, now located at <https://github.com/stac-api-extensions/browseable>
- Link relation `parent` is no longer a required link for Collections or Items
- Field `type` is now required for all Link objects

## Added

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
12 changes: 6 additions & 6 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 @@ -63,8 +63,8 @@ but sub-catalogs whose items are all in one database can support search.

## Link Relations

While the STAC definition of Link does not require the `type` field,
*STAC API - Core* requires all Links to have this field.
The STAC definition of Link does not require the `type` field,
but it is **STRONGLY RECOMMENDED** that this field exists.
If the target of a Link's `type` is unknown, `type` SHOULD be set to `application/octet-stream` or `text/plain`.

The following Link relations are defined for the Landing Page (root).
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
14 changes: 7 additions & 7 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 All @@ -49,8 +49,8 @@ Implementing `GET /search` is **required**, `POST /search` is optional, but reco

## Link Relations

While the STAC definition of Link does not require the `type` field,
*STAC API - Item Search* requires all Links to have this field.
The STAC definition of Link does not require the `type` field,
but it is **STRONGLY RECOMMENDED** that this field exists.
If the target of a Link's `type` is unknown, `type` SHOULD be set to `application/octet-stream` or `text/plain`.

This conformance class also requires implementation of the link relations in the [STAC API - Core](../core) conformance class.
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
28 changes: 14 additions & 14 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 All @@ -100,8 +100,8 @@ by *STAC API - Core*, the

These conformance classes also requires implementation of the link relations in the [STAC API - Core](../core) conformance class.

While the STAC definition of Link does not require the `type` field, this is required by OAFeat,
and is thereby required by the *STAC API - Features* conformance class.
The STAC definition of Link does not require the `type` field,
but it is **STRONGLY RECOMMENDED** that this field exists.
If the target of a Link's `type` is unknown, `type` SHOULD be set to `application/octet-stream` or `text/plain`.

### Landing Page (/)
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
Loading