Update field names in README.md and schema.json to use 'instrument' i…

…nstead of 'ins' This fixes #1
stac-extensions · Apr 29, 2024 · 3f7d386 · 3f7d386
1 parent fa37900
commit 3f7d386
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -25,16 +25,16 @@ The fields in the table below can be used in these parts of STAC documents:
 - [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
 - [ ] Links
 
-| Field Name         | Type                                                                                     | Description                                                                                                                                                                           |
-| ------------------ | ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| altm:ins_type      | string                                                                                   | Primary instrument type. See the list of [primary instrument types](#primary-instrument-types).                                                                                       |
-| altm:ins_mode      | string                                                                                   | Instrument mode.                                                                                                                                                                      |
-| altm:sampling_rate | number                                                                                   | Sampling rate of the instrument in Hz.                                                                                                                                                |
-| altm:nominal_track | [GeoJSON LineString Coordinates Array](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4) | An array of coordinates used to define the nominal track on the earths surface. This track is essentially a line that is representative of the product but does not include points for every value |
+| Field Name           | Type                                                                                                | Description                                                                                                                                                                                        |
+| -------------------- | --------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| altm:instrument_type | string                                                                                              | Primary instrument type. See the list of [primary instrument types](#primary-instrument-types).                                                                                                    |
+| altm:instrument_mode | string                                                                                              | Instrument mode.                                                                                                                                                                                   |
+| altm:sampling_rate   | number                                                                                              | Sampling rate of the instrument in Hz.                                                                                                                                                             |
+| altm:nominal_track   | [GeoJSON LineString Coordinates Array](https://datatracker.ietf.org/doc/html/rfc7946#section-3.1.4) | An array of coordinates used to define the nominal track on the earths surface. This track is essentially a line that is representative of the product but does not include points for every value |
 
 ### Primary Instrument Types
 
-The following values are valid for the `altm:ins_type` field:
+The following values are valid for the `altm:instrument_type` field:
 
 | Value     | Description              |
 | --------- | ------------------------ |

diff --git a/examples/sentinel3.json b/examples/sentinel3.json
@@ -62,8 +62,8 @@
     "end_datetime": "2024-04-15T10:11:41.815Z",
     "start_datetime": "2024-04-15T10:10:36.872Z",
     "productType": "SR_2_LAN_LI",
-    "altm:ins_type": "sar",
-    "altm:ins_mode": "hrm",
+    "altm:instrument_type": "sar",
+    "altm:instrument_mode": "hrm",
     "altm:sampling_rate": 20,
     "altm:nominal_track": [
       [

diff --git a/json-schema/schema.json b/json-schema/schema.json
@@ -67,8 +67,8 @@
     "require_any": {
       "$comment": "Please list all fields here so that we can force the existence of one of them in other parts of the schemas.",
       "anyOf": [
-        {"required": ["altm:ins_type"]},
-        {"required": ["altm:ins_mode"]},
+        {"required": ["altm:instrument_type"]},
+        {"required": ["altm:instrument_mode"]},
         {"required": ["altm:sampling_rate"]},
         {"required": ["altm:nominal_track"]}
       ]
@@ -77,7 +77,7 @@
       "$comment": "Add your new fields here. Don't require them here, do that above in the corresponding schema.",
       "type": "object",
       "properties": {
-        "altm:ins_type": {
+        "altm:instrument_type": {
           "type": "string",
           "description": "Type of altimetry instrument used to collect the data.",
           "enum": [
@@ -88,7 +88,7 @@
             "other"
           ]
         },
-        "altm:ins_mode": {
+        "altm:instrument_mode": {
           "type": "string",
           "description": "Mode of the altimetry instrument used to collect the data."
         },