Template Extension Specification

Title: Template
Identifier: https://stac-extensions.github.io/template/v1.0.0/schema.json
Field Name Prefix: template
Scope: Item, Collection
Extension Maturity Classification: Proposal
Owner: @your-gh-handles @person2

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

Examples:
- Item example: Shows the basic usage of the extension in a STAC Item
- 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
template:new_field	string	REQUIRED. Describe the required field...
template:xyz	XYZ Object	Describe the field...
template:another_one	[number]	Describe the field...

Additional Field Information

template:new_field

This is a much more detailed description of the field template:new_field...

XYZ Object

This is the introduction for the purpose and the content of the XYZ Object...

Field Name	Type	Description
x	number	REQUIRED. Describe the required field...
y	number	REQUIRED. Describe the required field...
z	number	REQUIRED. Describe the required field...

Relation types

The following types should be used as applicable rel types in the Link Object.

Type	Description
fancy-rel-type	This link points to a fancy resource.

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

nkleinbaer / template