- Title: Marble
- Identifier: https://stac-extensions.github.io/marble/v1.0.0/schema.json
- Field Name Prefix: marble
- Scope: Item, Collection
- Extension Maturity Classification: Proposal
- Owner: @dchandan
This document explains the Marble Platform specific extension to the SpatioTemporal Asset Catalog (STAC) specification. It adds fields that describe the location of data on the Marble Network/Platform.
- Examples:
- Item example: Shows the basic usage of the extension in a STAC Item
- JSON Schema
- Changelog
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 |
---|---|---|
marble:host_node | string | REQUIRED. Name of the Marble node hosting the data |
marble:is_local | boolean | REQUIRED. Whether this data is local on the node being searched |
This is a controlled vocabulary and the values can be one of the host IDs (not its display name or some other identifier) currently available in the Marble node registry.
If true
, it means that the data is locally available on the node where the search is being performed. If false
, it means
the data is available on another federated node.
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.
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