Region Extension Specification

• Title: Region
• Identifier: https://stac-extensions.github.io/region/v0.1.0/schema.json
• Field Name Prefix: region
• Scope: Item, Collection
• Extension Maturity Classification: Proposal
• Owner: @m-mohr

This document explains the Region Extension to the SpatioTemporal Asset Catalog (STAC) specification. This is the place to add a short introduction.

• Examples:
  • Collection example: Shows the basic usage of the extension in a STAC Collection
• JSON Schema
• Changelog

Fields

The fields in the table below can be used in these parts of STAC documents:

• Catalogs
• Collections
• Item Properties (incl. Summaries in Collections)
• Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
• Links

Field Name	Type	Description
region:name	string	A human-readable name of the relevant region.
region:country	string	ISO 3166-1 alpha-2 country code. Two-letter country code for the country that is primarily covered by the data.
region:subdivision	string	ISO 3166-2 codes for identifying the principal subdivisions (e.g., provinces or states) of a country that is primarily covered by the data. Only provide the second part of the ISO 3166-2 code to reduce redundancy.

Additional Field Information

region:name

In general this is a free-text field, but to make it most useful for search and discovery, please follow the following guidelines:

• Always provide all names in the language of the metadata.

  For example, if your document title and description are English, provide the names in English, too.

• Use commas (,) for separating names, don't use semicolon (;) or other separator characters.

  For example, provide it as "Lüneburg Heath, Germany" instead of "Lüneburg Heath; Germany" or "Lüneburg Heath in Germany".

• List the names from the most specific part to the most unspecific part.

  For example, "Hyde Park, London, United Kingdom".

• Do not use abbreviations.

  For example, use "United Kindgom" instead of "UK" or "United States" instead of "US".

• Capitalize names as required by the language.

  For example, write "United States of America" instead of "United states of america"

region:country

The ISO 3166-1 alpha-2 country code can be found at https://www.iso.org/obp/ui/#search. Search for country codes at via the Alpha-2 code column.

region:subdivision

The ISO 3166-2 codes can be found at https://www.iso.org/obp/ui/#iso:pub:PUB500001:en. Only provide the second part of the ISO 3166-2 code to reduce redundancy.

Please note that for some countries subdivision codes are not available.

Contributing

All contributions are subject to the STAC Specification Code of Conduct. For contributions, please follow the STAC specification contributing guide Instructions for running tests are copied here for convenience.

Running tests

The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. To run tests locally, you'll need npm, which is a standard part of any node.js installation.

First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run:

npm install

Then to check markdown formatting and test the examples against the JSON schema, you can run:

npm test

This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.

If the tests reveal formatting problems with the examples, you can fix them with:

npm run format-examples