deprecate fields

stac-extensions · Nov 13, 2023 · 26fb3c5 · 26fb3c5
1 parent ad34abc
commit 26fb3c5
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -26,19 +26,16 @@ The fields in the table below can be used in these parts of STAC documents:
 
 | Field Name                              | Type     | Description                          |
 | --------------------------------------- | -------- | ------------------------------------ |
-| s2:granule_id                           | string   | Granule Identifier                   |
+| s2:tile_id                              | string   | Tile Identifier                   |
 | s2:datatake_id                          | string   | Datatake Identifier                  |
 | s2:product_uri                          | string   | Product URI                          |
 | s2:datastrip_id                         | string   | Datastrip Identifier                 |
 | s2:product_type                         | string   | Product Type                         |
 | s2:datatake_type                        | string   | Datatake Type                        |
 | s2:generation_time                      | datetime | Generation Time                      |
 | s2:processing_baseline                  | string   | Processing Baseline                  |
-| s2:mgrs_tile                            | string   | Sentinel-2 MGRS Tile Identifier      |
 | s2:reflectance_conversion_factor        | number   | Reflectance Conversion Factor        |
 | s2:water_percentage                     | number   | Water Percentage                     |
-| s2:mean_solar_zenith                    | number   | Mean Solar Zenith                    |
-| s2:mean_solar_azimuth                   | number   | Mean Solar Azimuth                   |
 | s2:snow_ice_percentage                  | number   | Snow and Ice Percentage              |
 | s2:vegetation_percentage                | number   | Vegetation Percentage                |
 | s2:thin_cirrus_percentage               | number   | Thin Cirrus Percentage               |
@@ -51,10 +48,20 @@ The fields in the table below can be used in these parts of STAC documents:
 | s2:high_proba_clouds_percentage         | number   | High Probability Clouds Percentage   |
 | s2:medium_proba_clouds_percentage       | number   | Medium Probability Clouds Percentage |
 | s2:saturated_defective_pixel_percentage | number   | Saturated Defective Pixel Percentage |
+| s2:granule_id                           | string   | **DEPRECATED** Granule Identifier                   |
+| s2:mgrs_tile                            | string   | **DEPRECATED** Sentinel-2 MGRS Tile Identifier      |
+| s2:mean_solar_zenith                    | number   | **DEPRECATED** Mean Solar Zenith                    |
+| s2:mean_solar_azimuth                   | number   | **DEPRECATED** Mean Solar Azimuth                   |
 
 ### Additional Field Information
 
-None
+**s2:granule_id** is deprecated in favor of `s2:tile_id`
+
+**s2:mean_solar_zenith** is deprecated in favor of the View Extension field `view:sun_elevation`
+
+**s2:mean_solar_azimuth** is deprecated in favor of the View Extension field `view:sun_azimuth`
+
+**s2:mgrs_tile** is deprecated in favor the [MGRS Extension](https://github.com/stac-extensions/mgrs) fields
 
 ## Relation types
 

diff --git a/examples/item.json b/examples/item.json
@@ -703,9 +703,8 @@
     "instruments": [
       "msi"
     ],
-    "s2:mgrs_tile": "20QRF",
     "constellation": "Sentinel 2",
-    "s2:granule_id": "S2A_OPER_MSI_L2A_TL_MSFT_20231107T182159_A043751_T20QRF_N05.09",
+    "s2:tile_id": "S2A_OPER_MSI_L2A_TL_MSFT_20231107T182159_A043751_T20QRF_N05.09",
     "eo:cloud_cover": 4.217,
     "s2:datatake_id": "GS2A_20231107T144731_043751_N05.09",
     "s2:product_uri": "S2A_MSIL2A_20231107T144731_N0509_R139_T20QRF_20231107T182159.SAFE",
@@ -716,8 +715,6 @@
     "s2:generation_time": "2023-11-07T18:21:59.14490Z",
     "sat:relative_orbit": 139,
     "s2:water_percentage": 95.782292,
-    "s2:mean_solar_zenith": 37.2896344512918,
-    "s2:mean_solar_azimuth": 158.036308316995,
     "s2:processing_baseline": "05.09",
     "s2:snow_ice_percentage": 0,
     "s2:vegetation_percentage": 0,

diff --git a/examples/item2.json b/examples/item2.json
@@ -41,8 +41,7 @@
     "s2:datatake_id": "GS2A_20190212T192651_019029_N02.12",
     "s2:datatake_type": "INS-NOBS",
     "s2:datastrip_id": "S2A_OPER_MSI_L2A_DS_ESRI_20201007T160858_S20190212T192646_N02.12",
-    "s2:granule_id": "S2A_OPER_MSI_L2A_TL_ESRI_20201007T160858_A019029_T07HFE_N02.12",
-    "s2:mgrs_tile": "07HFE",
+    "s2:tile_id": "S2A_OPER_MSI_L2A_TL_ESRI_20201007T160858_A019029_T07HFE_N02.12",
     "s2:reflectance_conversion_factor": 1.02763689829235,
     "s2:degraded_msi_data_percentage": 0,
     "s2:nodata_pixel_percentage": 96.769553,

diff --git a/json-schema/schema.json b/json-schema/schema.json
@@ -48,9 +48,14 @@
     "fields": {
       "type": "object",
       "properties": {
+        "s2:tile_id": {
+          "title": "Tile Identifier",
+          "type": "string"
+        },
         "s2:granule_id": {
           "title": "Granule Identifier",
-          "type": "string"
+          "type": "string",
+          "deprecated": true
         },
         "s2:datatake_id": {
           "title": "Datatake Identifier",
@@ -92,13 +97,15 @@
           "title": "Mean Solar Zenith",
           "type": "number",
           "minimum": 0,
-          "maximum": 180
+          "maximum": 180,
+          "deprecated": true
         },
         "s2:mean_solar_azimuth": {
           "title": "Mean Solar Azimuth",
           "type": "number",
           "minimum": 0,
-          "maximum": 180
+          "maximum": 180, 
+          "deprecated": true
         },
         "s2:snow_ice_percentage": {
           "title": "Snow and Ice Percentage",
@@ -179,7 +186,8 @@
         "s2:mgrs_tile": {
           "title": "Sentinel-2 MGRS Tile Identifier",
           "type": "string",
-          "pattern": "^\\d\\d?[CDEFGHJKLMNPQRSTUVWX][ABCDEFGHJKLMNPQRSTUVWXYZ][ABCDEFGHJKLMNPQRSTUV]$"
+          "pattern": "^\\d\\d?[CDEFGHJKLMNPQRSTUVWX][ABCDEFGHJKLMNPQRSTUVWXYZ][ABCDEFGHJKLMNPQRSTUV]$",
+          "deprecated": true
         }
       },
       "patternProperties": {