-
Notifications
You must be signed in to change notification settings - Fork 189
add single file STAC extension #558
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c1068b9
add single file STAC extension
matthewhanson d65e1eb
resolve merge
matthewhanson 815f960
single file stac - updated readmes
matthewhanson 7767bae
single-file-stac ext: update readme
matthewhanson ff67e2a
single-file-stac: update changelog
matthewhanson 56ad0bf
Merge branch 'dev' into single_file_stac
m-mohr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # Single File STAC Specification | ||
|
|
||
| **Extension [Maturity Classification](../README.md#extension-maturity): Proposal** | ||
|
|
||
| An extension to provide a set of Collections and Items as a single file catalog. The single file is a self contained catalog that contains everything that would normally be in a linked set of STAC files. This format is useful to save a portion of a catalog, or when creating a small catalog from derived data that should remain portable. It is most useful for saving the results of a search from a STAC API, as the Items, Collections, and optionally the search parameters are all saved within the single file. Hierarchical links have no meaning in a single file STAC, and so, if present, should be removed when creating a single file catalog. | ||
|
|
||
| The Items in the single file catalog should not be merged with the Collection properties (i.e., common properties). The Collections are all included in the file as well, so there is no need to duplicate the common properties for every Item in the catalog. | ||
|
|
||
| - [Example](examples/example.json) | ||
| - [JSON Schema](json-schema/schema.json) | ||
|
|
||
| ## Catalog fields | ||
|
|
||
| A Single File STAC is a complete STAC catalog contained in a single file. | ||
|
|
||
| A Single File STAC is an [ItemCollection Object](../../item-spec/itemcollection-spec.md). This GeoJSON FeatureCollection has Features which are Items, but the Collections are still needed. | ||
|
|
||
| | Field Name | Type | Description | | ||
| | ------------------ | ------ | ------------------------------------------------------------ | | ||
| | collections | [Collection](../../collection-spec/collection-spec.md#collection-fields)] | An array of Collections that are used by any of the Items in the ItemCollection. | ||
| | search | [Search Object](#search-object) | An optional field containing a search endpoint and parameters used to generate this Single File STAC | | ||
|
|
||
| ## Search Object | ||
|
|
||
| | Field Name | Type | Description | | ||
| | ------------------ | ------ | ------------------------------------------------------------ | | ||
| | endpoint | string | The root endpoint of a STAC API used for this search. | ||
| | parameters | map<string, Object> | A dictionary of all the parameters used for the search | | ||
|
|
||
| ## Implementations | ||
|
|
||
| - [sat-search](https://github.com/sat-utils/sat-search) uses the Single File Catalog to save and load search results. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.