diff --git a/CHANGELOG.md b/CHANGELOG.md index 32fa41b68..e3d2042b7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. - `proj:geometry` allows all GeoJSON geometries instead of just a polygon. - `label:description` and `processing:lineage` allow CommonMark for rich-text representation ([#950](https://github.com/radiantearth/stac-spec/issues/950)) - Renamed "Scientific Extension" to "Scientific Citation Extension" ([#990](https://github.com/radiantearth/stac-spec/issues/990)) +- Enhanced the way the spec talks about ID's to encourage more global uniqueness. ### Removed diff --git a/collection-spec/collection-spec.md b/collection-spec/collection-spec.md index 6ab6a58ca..1a4278dd3 100644 --- a/collection-spec/collection-spec.md +++ b/collection-spec/collection-spec.md @@ -34,6 +34,12 @@ STAC Collections are meant to be compatible with *OGC API - Features* Collection ### Additional Field Information +#### id + +It is important that collection identifiers are unique across the provider. And providers should strive as much as possible to make +their collection ids 'globally' unique, prefixing any common information with a unique string. This could be the provider's name if +it is a fairly unique name, or their name combined with the domain they operate in. + #### stac_extensions A list of extensions the Collection implements. This does NOT declare the extensions of child Catalogs or Items. The list contains URLs to the JSON Schema files it can be validated against. For official [extensions](../extensions/README.md#list-of-stac-extensions), a "shortcut" can be used. This means you can specify the folder name of the extension, for example `version` for the Versioning Indicators extension. If the versions of the extension and the collection diverge, you can specify the URL of the JSON schema file. diff --git a/item-spec/item-spec.md b/item-spec/item-spec.md index c1374a3bf..c0af16280 100644 --- a/item-spec/item-spec.md +++ b/item-spec/item-spec.md @@ -31,7 +31,7 @@ inherited from GeoJSON. | ---------- | -------------------------------------------------------------------------- | ----------- | | stac_version | string | **REQUIRED.** The STAC version the Item implements. | | stac_extensions | \[string] | A list of extensions the Item implements. | -| id | string | **REQUIRED.** Provider identifier. As most geospatial assets are already defined by some identification scheme by the data provider it is recommended to simply use that ID. Data providers are advised to include sufficient information to make their IDs globally unique, including things like unique satellite IDs. | +| id | string | **REQUIRED.** Provider identifier. The ID should be unique within the [Collection](../collection-spec/README.md) that contains the item. | | type | string | **REQUIRED.** Type of the GeoJSON Object. MUST be set to `Feature`. | | geometry | [GeoJSON Geometry Object](https://tools.ietf.org/html/rfc7946#section-3.1) \| [null](https://tools.ietf.org/html/rfc7946#section-3.2) | **REQUIRED.** Defines the full footprint of the asset represented by this item, formatted according to [RFC 7946, section 3.1](https://tools.ietf.org/html/rfc7946#section-3.1). The footprint should be the default GeoJSON geometry, though additional geometries can be included. Coordinates are specified in Longitude/Latitude or Longitude/Latitude/Elevation based on [WGS 84](http://www.opengis.net/def/crs/OGC/1.3/CRS84). | | bbox | \[number] | **REQUIRED if `geometry` is not `null`.** Bounding Box of the asset represented by this item, formatted according to [RFC 7946, section 5](https://tools.ietf.org/html/rfc7946#section-5). | @@ -46,6 +46,18 @@ inherited from GeoJSON. In general, STAC versions can be mixed, but please keep the [recommended best practices](../best-practices.md#mixing-stac-versions) in mind. +#### id + +It is important that an Item identifier is unique within a collection, and that the +[Collection identifier](../collection-spec/collection-spec.md#id) in turn is unique globally. Then the two can be combined to +give a globally unique identifier. Items are *[strongly recommended](#collections)* to have collections, and not having one makes +it more difficult to be used in the wider STAC ecosystem. If an Item does not have a Collection, then the Item identifier should be unique within its root Catalog. + +As most geospatial assets are already uniquely defined by some +identification scheme from the data provider it is recommended to simply use that ID. Data providers are advised to include sufficient information to make their +IDs globally unique, including things like unique satellite IDs. See the [id section of best practices](../best-practices.md#field-and-id-formatting) for +additional recommendations. + #### stac_extensions A list of extensions the Item implements. The list contains URLs to the JSON Schema files it can be validated against. For official [extensions](../extensions/README.md#list-of-stac-extensions), a "shortcut" can be used. This means you can specify the folder name of the extension, for example `pointcloud` for the Point Cloud extension. This does *not* apply for API extensions. If the versions of the extension and the item diverge, you can specify the URL of the JSON schema file.