Releases: radiantearth/stac-spec
Releases · radiantearth/stac-spec
v0.9.0-rc2
[v0.9.0-rc2] - 2020-02-12
Added
- Basics added to Common Metadata definitions with new
description
field for
Item properties - New fields to the
link
object to facilitate pagination support for POST requests - Data role, as a suggestion for a common role for data files to be used in case data providers don't come up with their own names and semantics
- Clarification text on HTTP verbs in STAC API
- View Geometry Extension
Changed
- Item
title
definition moved from core Item fields to Common Metadata Basics
fields. No change is required for STAC Items. putFeature
can return aPreconditionFailed
to provide more explicit information when the resource has changed in the server- Sort extension now uses "+" and "-" prefixes for GET requests to denote sort order.
- Clarified how
/search
links must be added to/
and changed that links to both GET and POST must be provided now that the method can be specified in links. - Moved angle definitions between extensions
view
andsat
sat:off_nadir_angle
->view:off_nadir
sat:azimuth_angle
->view:azimuth
sat:incidence_angle
->view:incidence_angle
sat:sun_azimuth_angle
->view:sun_azimuth
sat:sun_elevation_angle
->view:sun_elevation
Removed
- In API, removed any mention of using media type
multipart/form-data
andx-www-form-urlencoded
Fixed
- Fixed Item JSON Schema now
allOf
optional Common Metadata properties are evaluated - Clarified usage of optional Common Metadata fields for STAC Items
- Clarified usage of paging options, especially in relation to what OGC API - Features offers
- Allow Commonmark in asset description, as it's allowed everywhere else
- Put asset description in the API
- Fixed API spec regarding license expressions
- Added missing schema in the API Version extension
v0.9.0-rc1
[v0.9.0-rc1] - 2020-01-06
Added
- ItemCollection requires
stac_version
field,stac_extensions
has also been added - A
description
field has been added to Item assets (also Asset definitions extension). - Field
mission
to Common Metadata fields. - Extensions:
- Version Indicators extension, adds
version
anddeprecated
fields to STAC Items and Collections - Data Cube extension can be used in Collections, added new field
description
- Added
description
androles
fields to the Asset in the Asset Extension - Projection Extension to describe Items with Assets that have an associated geospatial projection.
- Version Indicators extension, adds
- STAC API:
- Added the Item and Collection API Version extension to support versioning in the API specification
- Run
npm run serve
ornpm run serve-ext
to quickly render development versions of the OpenAPI spec in the browser.
Changed
- Support for CommonMark 0.29 instead of CommonMark 0.28
- Collection field
property
and the merge ability moved to a new extension 'Commons' - Added attribute
roles
to Item assets (also Asset definitions extension), to be used similarly to Linkrel
. - Updated API yaml to clarify bbox filter should be implemented without brackets. Example:
bbox=160.6,-55.95,-170,-25.89
- Collection
summaries
merge array fields now. - Several fields have been moved from extensions or item fields to the Common Metadata fields:
eo:platform
/sar:platform
=>platform
eo:instrument
/sar:instrument
=>instruments
, also changed from string to array of stringseo:constellation
/sar:constellation
=>constellation
dtr:start_datetime
=>start_datetime
dtr:end_datetime
=>end_datetime
- Extensions:
- Data Cube extension: Changed allowed formats (removed PROJ string, added PROJJSON / WKT2) for reference systems
- Checksum extension is now using self-identifiable hashes (Multihash)
- Changed
sar:type
tosar:product_type
andsar:polarization
tosar:polarizations
in the SAR extension
- STAC API:
- The endpoint
/stac
has been merged with/
- The endpoint
/stac/search
is now called/search
- Sort Extension - added non-JSON query/form parameter format
- Fields extension has a simplified format for GET parameters
search
extension renamed tocontext
extension. JSON object renamed fromsearch:metadata
tocontext
- Removed "next" from the search metadata and query parameter, added POST body and headers to the links for paging support
- Query Extension - type restrictions on query predicates are more accurate, which may require additional implementation support.
- The endpoint
Removed
version
field in STAC Collections. Use Version Extension insteadsummaries
field from Catalogs. Use Collections instead- Asset Types (pre-defined values for the keys of individual assets, not media types) in Items. Use the asset's
roles
instead. license
field doesn't allow SPDX expressions any longer. Usevarious
and links instead.- Extensions:
eo:platform
,eo:instrument
,eo:constellation
from EO extension, andsar:platform
,sar:instrument
,sar:constellation
from the SAR extension- Removed from EO extension field
eo:epsg
in favor ofproj:epsg
gsd
andaccuracy
fromeo:bands
in the EO extensionsar:absolute_orbit
andsar:center_wavelength
fields from the SAR extensiondata_type
andunit
from thesar:bands
object in the SAR extension- Datetime Range (
dtr
) extension. Use the Common Metadata fields instead.
- STAC API:
next
from the search metadata and query parameter, added POST body and headers to the links for paging support
Fixed
- The
license
field in Item and Collection spec explicitly mentions that the valueproprietary
without a link means that the data is private. - Clarified how to fill
stac_extensions
. - More clarifications; typos fixed
v0.8.1
[v0.8.1] - 2019-11-01
Changed
- Updated specification to base on OGC API - Features - Part 1: Core, v1.0.0 instead of OGC API - Features - Part 1: Core, v1.0.0-draft.2 (fka WFS3 draft 2).
Fixed
- Numerous typos, clarifications and fixes for documentation and examples.
- Fixed STAC API definition to include STAC-related fields and examples in OGC API - Features-derived endpoints.
- Fixed JSON schemas for extensions:
$id
field matches file name.
v0.8.0
v0.8.0 - 2019-10-11
Changed
- Updated specification to base on WFS3 draft 2 (OGC API - Features - Part 1: Core, v1.0.0-draft.2). This leads to many changes in the API and one change in STAC collections, notably:
- The structure of the field
extent
in STAC and WFS Collections changed. - Query parameter
time
was renamed todatetime
and accepts slightly different values. - WFS links have additional fields
hreflang
andlength
. - WFS Collections have additional fields
crs
anditemType
. time
API parameter changed todatetime
- The structure of the field
- The API intersects parameter now accepts a GeoJSON Geometry (any type) instead of a GeoJSON Feature.
- API: Clarification on
include
andexclude
parameters in the field extension and notes on default values. - API: queries should contain either
bbox
orintersects
. - API: Core API now has reserved parameters to prevent overlap with extensions
- Updated bbox definitions in API, Item, and Collection specs to include support for optional elevation values.
- Moved Single Item Extension to core (
license
andproviders
properties for Items). - Allow
various
for thelicense
fields. - Clarified meaning of SAR and EO platform, constellation, and instrument
- Numerous typos, clarification and general word-smithing
- Changed GeoTIFF media type from
image/vnd.stac.geotiff
toimage/tiff; application=geotiff
, changed Cloud-optimized GeoTiff media type fromimage/vnd.stac.geotiff; cloud-optimized=true
toimage/tiff; application=geotiff; profile=cloud-optimized
.
Added
- stac_version: Each Item must specify the STAC version.
- stac_extensions: Introduced this field for Items, Catalogs and Collections.
- Property
summaries
have been added to catalogs and collections. - API Transaction extension supports optimistic locking through use of the ETag header.
- Asset Definition Extension added to Collections to allow specifying details about Assets that may appear in member Items.
- Single File Catalog extension added as a format to have a set of Collections and Items in a single file.
- Label extension added with additional fields for describing labeled data, such as used for training data or from the output of a classification
- Timestamp fields added to
Item
:created
andupdated
to refer to the datetime the metadata file was created or updated. - Added Search Metadata API extension which adds fields to a response from a STAC API such as the number of items found and how many were returned.
- ItemCollection class added to spec that is a GeoJSON FeatureCollection of Items, such as what would be returned from a search. Located in item directory.
in
operator added to the query extension (to check if value is in a list of values)- New bands added to the common band names for the EO extension: yellow, rededge, and 2 narrow NIR bands
- Scientific extension can be used in Collections.
Fixed
- Updated language, fixed typos and examples.
- Renamed
pc:schema
topc:schemas
in the Point Cloud extension.
Changes since 0.8.0rc1
- Label extension:
- moved label:classes to be a list of Class Objects from a single Class Object in spec markdown and json schema (matching previous example JSON).
- moved label:overview to be a list of Overview Objects from a single Overview Object in spec markdown and json schema (matching previous example JSON).
- Renamed fields to use plural forms (
label:property
->label:properties
,label:task
->label:tasks
,label:method
->label:methods
andlabel:overview
->label:overviews
)
v0.8.0-rc1
[v0.8.0-rc1] - 2019-08-23
Changed
- Updated specification to base on WFS3 draft 2 (OGC API - Features - Part 1: Core, v1.0.0-draft.2). This leads to many changes in the API and one change in STAC collections, notably:
- The structure of the field
extent
in STAC and WFS Collections changed. - Query parameter
time
was renamed todatetime
and accepts slightly different values. - WFS links have additional fields
hreflang
andlength
. - WFS Collections have additional fields
crs
anditemType
. time
API parameter changed todatetime
- The structure of the field
- The API intersects parameter now accepts a GeoJSON Geometry (any type) instead of a GeoJSON Feature.
- API: Clarification on
include
andexclude
parameters in the field extension and notes on default values. - API: queries should contain either
bbox
orintersects
. - API: Core API now has reserved parameters to prevent overlap with extensions
- Updated bbox definitions in API, Item, and Collection specs to include support for optional elevation values.
- Moved Single Item Extension to core (
license
andproviders
properties for Items). - Allow
various
for thelicense
fields. - Clarified meaning of SAR and EO platform, constellation, and instrument
- Numerous typos, clarification and general word-smithing
Added
- stac_version: Each Item must specify the STAC version.
- stac_extensions: Introduced this field for Items, Catalogs and Collections.
- Property
summaries
have been added to catalogs and collections. - API Transaction extension supports optimistic locking through use of the ETag header.
- Asset Definition Extension added to Collections to allow specifying details about Assets that may appear in member Items.
- Single File Catalog extension added as a format to have a set of Collections and Items in a single file.
- Label extension added with additional fields for describing labeled data, such as used for training data or from the output of a classification
- Timestamp fields added to
Item
:created
andupdated
to refer to the datetime the metadata file was created or updated. - Added Search Metadata API extension which adds fields to a response from a STAC API such as the number of items found and how many were returned.
- ItemCollection class added to spec that is a GeoJSON FeatureCollection of Items, such as what would be returned from a search. Located in item directory.
in
operator added to the query extension (to check if value is in a list of values)- New bands added to the common band names for the EO extension: yellow, rededge, and 2 narrow NIR bands
- Scientific extension can be used in Collections.
v0.7.0
v0.7.0 - 2019-05-06
Fixed
- Updated language / fixed typos
- Moved static vs dynamic discussion text to catalog best practices document
- Moved hosting of interactive api docs from swaggerhub to stacspec.org
- JSON Schemas are now all following the latest JSON Schema version, draft 07.
Changed
- No longer require an absolute self link for Items, Collections and Catalogs.
- Reorganized api-spec, added extensions folder to hold API extensions
- Change the fields parameter in the API to allow filtering on any property.
- Refinements to SAR extension, changed several fields from a single array-based field (
sar:absolute_orbit
,sar:resolution
,sar:pixel_spacing
,sar:looks
) to multiple fields with exactly one value. - Commons extension ability to 'merge' properties is now in the core specification
Added
- Catalog best practices document, including recommendations for catalog layouts, html, and self-contained catalogs.
page
parameter for STAC API- Optional
collection
property field in Items (previously part of the Commons extension) - It is now required to link to
/stac/search/
from/stac/
- Added new fields to SAR extension:
sar:incidence_angle
,sar:relative_orbit
,sar:observation_direction
- Added new filter parameters
ids
andcollections
to/stac/search/
Removed
- Removed the field
sar:off_nadir
from the SAR extension - JavaScript-based validation
v0.6.2
v0.6.2 - 2019-03-01
Fixed
- Fixed several examples and typos, improved descriptions
- Strictly checking the STAC version numbers in the JSON schemas
- Added missing required fields in Item JSON schema
- Changed
id
to$id
in JSON schemas (draft-06 compatibility)
Changed
- Extensions require examples and a JSON schema to get to the maturity level 'Pilot'
- Updated ISERV implementation
Added
- Checksum extension
- Data Cube extension
- Point Cloud extension
- SAR extension
v0.6.1
v0.6.0
v0.6.0 - 2018-11-06
Fixed
- Reorganized and cleaned up repository.
- Fixed examples throughout.
Added
- Changelog: This changelog added.
- Collections added: Collections are a type of Catalog with additional fields, such as provider and license. Items must belong to a single Collection.
- Extension maturity: Protocol for providing maturity classification for extensions based on stability and implementations.
- Commons extension: The previous 'Collections' extension is now the 'Commons' extension and allows an Item to inherit properties from its Collection.
- Datetime-range extension: Extension for providing start and end datetimes.
- Scientific extension: Extension for providings links to scientific publications relating to the data.
- rel types: A list of supported
rel
types are provided for use when specifying links,derived_from
andlicense
types added. - eo:constellation: A new field in the EO specification to specify a grouping of platforms.
- stac_version: The
stac_version
field is required on all Catalogs (and Collections). - JSON schemas: Added JSON schemas where they were missing.
- Single Item extension: Extension to supply License and Providers for single Items when no collection is used.
- UML Diagram: See STAC-060-uml.pdf.
- Development Process: See process.md for information on the STAC development process.
Changed
- API: Main catalog endpoint at
/stac
, search endpoint now at/stac/search
. - eo:bands: The
eo:bands
field is now an array rather than a dictionary, and has been moved inside ofproperties
in a STAC Item. - Catalog fields: Catalogs have a smaller number of basic fields:
id
,stac_version
,title
(optional),description
, andlinks
. The new Collections type contains additional fields. - links: The links fields are now an array rather than a dictionary.
- properties: Fields with the data type array or objects are allowed inside the
properties
in a STAC Item. - description: Description fields now allow formatting with CommonMark.
- assets: Fields changed names:
name
totitle
andmime_type
totype
.
Removed:
- provider: Provider field in Items got removed. Use Collections or the Single Item extension instead.
- license: License field in Items got removed. Use Collections or the Single Item extension instead.
v0.6.0-rc2
v0.6.0-rc2 - 2018-10-25
Fixed
- Reorganized and cleaned up repository
- Fixed examples throughout
Added
- Changelog: This changelog added
- Collections added: Collections are a type of Catalog with additional fields, such as provider and license. Items must belong to a single Collection.
- Extension maturity: Protocol for providing maturity classification for extensions based on stability and implementations.
- Commons extension: The previous 'Collections' extension is now the 'Commons' extension and allows an Item to inherit properties from it's Collection.
- Datetime-range extension: Extension for providing start and end datetimes.
- Scientific extension: Extension for providings links to scientific publications relating to the data.
- rel types: A list of supported 'rel' types are provided for use when specifying links, 'derived_from' and 'license' types added.
- eo:constellation: A new field in the EO specification to specify a grouping of platforms.
- stac_version: The stac_version field is required on all Catalogs (and Collections)
- JSON schemas: Added JSON schemas where they were missing.
- Single Item extension: Extension to supply License and Providers for single Items when no collection.
- UML Diagram: See STAC-060-uml.pdf
- Development Process: See process.md for information on the STAC development processland-
Changed
- Endpoints: Main catalog endpoint at /stac, search endpoint now at /stac/search
- eo:bands: The eo:bands field is now an array rather than a dictionary, and has been moved inside of 'properties' in a STAC Item.
- Catalog fields: Catalogs have a smaller number of basic fields: id, stac_version, title (optional), description, and links. The new Collections type contains additional fields.
- links: The links fields are now an array rather than a dictionary.
- properties: Fields with the data type array or objects are allowed inside the
properties
in a STAC Item. - description: Description fields now allow formatting with CommonMark.
- assets: Fields changed names: name to title and mime_type to type.
- Providers Object in collections: added a
description
field., renamedtype
toroles
, changeroles
from string to array and added alicensor
role.
Removed:
- provider: Provider field in Items got removed. Use Collections instead.
- license: License field in Items got removed. Use Collections instead.