From 05f9e9ca202e49b0083878d4f1320f2731655458 Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Wed, 5 Oct 2022 07:23:54 -0500 Subject: [PATCH 1/3] Avoid processing info in item IDs --- best-practices.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/best-practices.md b/best-practices.md index 68902c78..6f6ccec9 100644 --- a/best-practices.md +++ b/best-practices.md @@ -157,6 +157,15 @@ 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 whatever reason, an +item needs to be reprocessed the new item would have a different ID. 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`, From 805019bc4a3a6e793fe342c7f032baf2f50d764d Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Sat, 8 Oct 2022 13:49:32 -0500 Subject: [PATCH 2/3] Update best-practices.md Co-authored-by: Pete Gadomski --- best-practices.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/best-practices.md b/best-practices.md index 6f6ccec9..5877620d 100644 --- a/best-practices.md +++ b/best-practices.md @@ -157,8 +157,7 @@ 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 whatever reason, an -item needs to be reprocessed the new item would have a different ID. This might result in "duplicate" items: multiple +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) From b7ecc2a24738ecb287974c19b9aa5e492c3e9ac8 Mon Sep 17 00:00:00 2001 From: Tom Augspurger Date: Tue, 18 Oct 2022 11:44:20 -0500 Subject: [PATCH 3/3] lint --- best-practices.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/best-practices.md b/best-practices.md index 5877620d..54cdfdc5 100644 --- a/best-practices.md +++ b/best-practices.md @@ -157,8 +157,10 @@ 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. +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