Add processing:version and processing:datetime

stac-extensions · Apr 4, 2024 · bde9911 · bde9911
1 parent 1f50195
commit bde9911
Show file tree

Hide file tree

Showing 4 changed files with 54 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `processing:version` to describe the primary software version of workflow version that produced the data
+- `processing:datetime` to describe when the processing happened
+
+### Changed
+
+### Deprecated
+
+### Removed
+
+### Fixed
+
 ## [v1.1.0] - 2022-01-07
 
 ### Added

diff --git a/README.md b/README.md
@@ -30,7 +30,9 @@ and therefore are shared across all items, it is recommended adding the fields t
 | processing:lineage      | string              | Lineage Information provided as free text information about the how observations were processed or models that were used to create the resource being described [NASA ISO](https://wiki.earthdata.nasa.gov/display/NASAISO/Lineage+Information). For example, `GRD Post Processing` for "GRD" product of Sentinel-1 satellites. [CommonMark 0.29](https://commonmark.org/) syntax MAY be used for rich text representation. |
 | processing:level        | string              | The name commonly used to refer to the processing level to make it easier to search for product level across collections or items. The short name must be used (only `L`, not `Level`). See the [list of suggested processing levels](#suggested-processing-levels). |
 | processing:facility     | string              | The name of the facility that produced the data. For example, `Copernicus S1 Core Ground Segment - DPA` for product of Sentinel-1 satellites. |
-| processing:software     | Map<string, string> | A dictionary with name/version for key/value describing one or more softwares that produced the data. For example, `"Sentinel-1 IPF":"002.71"` for the software that produces Sentinel-1 satellites data. |
+| processing:datetime     | string              | Processing date and time of the corresponding data formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6), in UTC. |
+| processing:version      | string              | The version of the primary processing software or processing chain that produced the data. For example, this could be the processing baseline for the Sentinel missions. |
+| processing:software     | Map<string, string> | A dictionary with name/version for key/value describing one or more applications or libraries that were involved during the production of the data for provenance purposes. |
 
 These fields can be used in a variety of places:
 
@@ -49,7 +51,9 @@ These fields can be used in a variety of places:
 
 ### Processing Date Time
 
-The time of the processing is directly specified via the `created` properties of the target asset as specified in the [STAC Common metadata](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#date-and-time)
+The time of the processing can be specified as a global field in `processing:datetime`,
+but it can also be specified directly and individually via the `created` properties of the target asset
+as specified in the [STAC Common metadata](https://github.com/radiantearth/stac-spec/blob/master/item-spec/common-metadata.md#date-and-time).
 
 ### Linking the Items
 

diff --git a/examples/item.json b/examples/item.json
@@ -33,7 +33,9 @@
     "processing:facility": "Copernicus S1 Core Ground Segment - DPA",
     "processing:software": {
       "Sentinel-1 IPF": "002.71"
-    }
+    },
+    "processing:version": "002.71",
+    "processing:datetime": "2016-08-23T00:30:33Z"
   },
   "links": [],
   "assets": {

diff --git a/json-schema/schema.json b/json-schema/schema.json
@@ -3,6 +3,18 @@
   "$id": "https://stac-extensions.github.io/processing/v1.1.0/schema.json#",
   "title": "Processing Extension",
   "description": "STAC Processing Extension for STAC Items and STAC Collections.",
+  "type": "object",
+  "required": [
+    "stac_extensions"
+  ],
+  "properties": {
+    "stac_extensions": {
+      "type": "array",
+      "contains": {
+        "const": "https://stac-extensions.github.io/processing/v1.1.0/schema.json"
+      }
+    }
+  },
   "anyOf": [
     {
       "$comment": "This is the schema for STAC Items.",
@@ -33,12 +45,7 @@
             "$ref": "#/definitions/fields"
           }
         }
-      },
-      "allOf": [
-        {
-          "$ref": "#/definitions/stac_extensions"
-        }
-      ]
+      }
     },
     {
       "$comment": "This is the schema for STAC Collections.",
@@ -72,11 +79,6 @@
           }
         }
       },
-      "allOf": [
-        {
-          "$ref": "#/definitions/stac_extensions"
-        }
-      ],
       "anyOf": [
         {
           "$comment": "Requires at least one provider to contain processing fields.",
@@ -170,18 +172,6 @@
   ],
   "definitions": {
     "stac_extensions": {
-      "type": "object",
-      "required": [
-        "stac_extensions"
-      ],
-      "properties": {
-        "stac_extensions": {
-          "type": "array",
-          "contains": {
-            "const": "https://stac-extensions.github.io/processing/v1.1.0/schema.json"
-          }
-        }
-      }
     },
     "require_provider_role": {
       "type": "object",
@@ -206,7 +196,9 @@
         {"type": "object", "required": ["processing:lineage"]},
         {"type": "object", "required": ["processing:level"]},
         {"type": "object", "required": ["processing:facility"]},
-        {"type": "object", "required": ["processing:software"]}
+        {"type": "object", "required": ["processing:software"]},
+        {"type": "object", "required": ["processing:version"]},
+        {"type": "object", "required": ["processing:datetime"]}
       ]
     },
     "fields": {
@@ -257,6 +249,22 @@
             "Copernicus S1 Core Ground Segment - DPA"
           ]
         },
+        "processing:version": {
+          "title": "Processing Version",
+          "type": "string",
+          "examples": [
+            "0.2.0"
+          ]
+        },
+        "processing:datetime": {
+          "title": "Processing Datetime",
+          "type": "string",
+          "format": "date-time",
+          "pattern": "(\\+00:00|Z)$",
+          "examples": [
+            "2020-01-05T12:34:55Z"
+          ]
+        },
         "processing:software": {
           "title": "Processing Software Name / version",
           "type": "object",