Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Avoid processing info in item IDs #1189

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Avoid processing info in item IDs #1189

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05f9e9c
Avoid processing info in item IDs
TomAugspurger Oct 5, 2022
805019b
Update best-practices.md
TomAugspurger Oct 8, 2022
b7ecc2a
lint
TomAugspurger Oct 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions best-practices.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,16 @@ unique, so may need a prefix. But the use of URI or file path reserved character
result in [percented encoded](https://tools.ietf.org/html/rfc3986#section-2) [STAC API](https://github.com/radiantearth/stac-api-spec)
endpoints and it prevents the use of IDs as file names as recommended in the [catalog layout](#catalog-layout) best practices.

In general, we recommend that item IDs *not* include any kind of processing timestamp. If, for example, an item's assets
require re-processing (e.g. to incorporate changes due to a new processing baseline), the re-processed items would have
new IDs. This might result in "duplicate" items: multiple items with the same spatio-temporal footprint, which might
not be desirable for end users.

Instead, we recommend cataloging processing information with the [Processing extension](https://github.com/stac-extensions/processing)
and handling updates to existing items with the [Versioning extension](https://github.com/stac-extensions/version). With
these extensions the reprocessed item would have the same item ID, updated `processing` fields, and links between the old
and new items.

### Searchable Identifiers

When coming up with values for fields that contain searchable identifiers of some sort, like `constellation` or `platform`,
Expand Down