IPFS Extension Specification

• Title: IPFS
• Identifier: https://github.com/easierdata/IPFS/blob/main/json-schema/schema.json
• Field Name Prefix: IPFS
• Scope: Item, Asset
• Extension Maturity Classification: Proposal
• Owner: @TaylorOshan @leonardzh @jsolly

This document explains the IPFS Extension to the SpatioTemporal Asset Catalog (STAC) specification. This extension adds fields to STAC Item and Asset objects, allowing for details related to IPFS storage access associated with a STAC Item.

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

Item Fields

Field Name	Type	Description
ipfs:payload-cid	string	Each item is associated with a single content ID hash

Asset Fields

Field Name	Type	Description
ipfs:cid	string	Each asset is associated with a single content ID hash

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