Merge pull request #10 from stac-extensions/mah/updates

matthewhanson · web-flow · commit 2e27eb668681 · 2021-06-14T21:52:42.000-04:00
Schema updates, drop some fields
diff --git a/.github/remark.yaml b/.github/remark.yaml
@@ -21,7 +21,6 @@ plugins:
     - 'fenced'
 # Headings
   - remark-lint-heading-increment
-  - remark-lint-no-duplicate-headings
   - remark-lint-no-multiple-toplevel-headings
   - remark-lint-no-heading-punctuation
   - - remark-lint-maximum-heading-length
diff --git a/README.md b/README.md
@@ -5,40 +5,37 @@
 - **Field Name Prefix:** storage
 - **Scope:** Item, Asset
 - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
-- **Owner**: @davidraleigh
+- **Owner**: @davidraleigh @matthewhanson
 
 This document explains the Storage Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
 This extension adds fields to STAC Item and Asset objects, allowing for details related to cloud storage access and costs to be associated
 with a STAC Item.  This extension does not cover NFS solutions provided by PaaS cloud companies.
 
 - Examples:
-  - [Item example 1](examples/example-naip.json): Shows the basic usage of the extension in a STAC Item.
-  - [Item example 2](examples/example-nsl.json): Another example of basic usage.
+  - [Item example 1](examples/item-naip.json): Shows the basic usage of the extension in a STAC Item.
+  - [Item example 2](examples/item-nsl.json): Another example of basic usage.
 - [JSON Schema](json-schema/schema.json)
 - [Changelog](./CHANGELOG.md)
 
 ## Item Fields
+
 | Field Name  | Type   | Description |
 | ----------- | ------ | ----------- |
 | storage:min_tier_duration   | integer  | number of days for the shortest time tier restriction on access of an asset. |
 | storage:max_tier_duration   | integer  | number of days for the longest time tier restrictions on access of an asset. |
 | storage:archived            | bool    | descriptor for whether the data is "properly" archived according to implementers discretion |
-
-## Asset Fields
-
-| Field Name  | Type   | Description |
-| ----------- | ------ | ----------- |
-| storage:platform              | string    | (REQUIRED) The [cloud provider](#providers) where data is stored |
-| storage:manager               | string    | The entity in charge of managing the data. |
-| storage:region                | string    | (REQUIRED) The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider) |
-| storage:bucket                | string    | The bucket for the asset, used along with object path |
+| storage:platform              | string    | The [cloud provider](#providers) where data is stored |
+| storage:region                | string    | The region where the data is stored. Relevant to speed of access and inter region egress costs (as defined by PaaS provider) |
+| storage:bucket                | string    | The bucket for the asset(s), used along with object path |
 | storage:object_path           | string    | The object_path for the asset, used along with bucket |
-| storage:requester_pays        | bool      | (REQUIRED) Is the data requester pays or is it data manager/cloud provider pays |
+| storage:requester_pays        | bool      | Is the data requester pays or is it data manager/cloud provider pays. *Defaults to false* |
 | storage:tier                  | string    | The title for the tier type (as defined by PaaS provider) |
 | storage:tier_duration         | integer   | Minimum storage duration (in days) required before additional fees |
-| storage:date_stored           | string    | Date and time the corresponding asset placed into the current storage tier (relevant for tier_duration > 0). Format is RFC 3339. |
 | storage:first_byte_latency    | string    | approximate time unit (milliseconds, minutes or hours) for accessing first byte of data |
 
+While these are all valid properties on an Item, they will typically be defined per-asset. If a field applies equally
+to all assets (e.g., storage:platform=AWS if all assets are on AWS), then it should be specified in Item properties.
+
 ### Additional Field Information
 
 #### Providers
@@ -81,3 +78,34 @@ Alibaba:
 - <https://www.alibabacloud.com/help/doc-detail/51374.htm>
 
 All timestamps MUST be formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).
+
+## Contributing
+
+All contributions are subject to the
+[STAC Specification Code of Conduct](https://github.com/radiantearth/stac-spec/blob/master/CODE_OF_CONDUCT.md).
+For contributions, please follow the
+[STAC specification contributing guide](https://github.com/radiantearth/stac-spec/blob/master/CONTRIBUTING.md) Instructions
+for running tests are copied here for convenience.
+
+### Running tests
+
+The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. 
+To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/).
+
+First you'll need to install everything with npm once. Just navigate to the root of this repository and on 
+your command line run:
+```bash
+npm install
+```
+
+Then to check markdown formatting and test the examples against the JSON schema, you can run:
+```bash
+npm test
+```
+
+This will spit out the same texts that you see online, and you can then go and fix your markdown or examples.
+
+If the tests reveal formatting problems with the examples, you can fix them with:
+```bash
+npm run format-examples
+```
diff --git a/examples/item-naip.json b/examples/item-naip.json
@@ -1,5 +1,5 @@
 {
-  "stac_version": "1.0.0-beta.2",
+  "stac_version": "1.0.0",
   "stac_extensions": [
     "https://stac-extensions.github.io/storage/v1.0.0/schema.json"
   ],
@@ -55,7 +55,6 @@
       "storage:bucket": "naip-nsl",
       "storage:object_path": "tx/2016/100cm/rgb/30097/m_3009743_sw_14_1_20160928.tif",
       "storage:platform": "AZURE",
-      "storage:manager": "Near Space Labs",
       "storage:region": "westus2",
       "storage:tier": "Archive tier",
       "storage:tier_duration": 180,
@@ -68,7 +67,6 @@
       "storage:bucket": "naip-data",
       "storage:object_path": "tx/2016/100cm/rgb/30097/m_3009743_sw_14_1_20160928.tif",
       "storage:platform": "GCP",
-      "storage:manager": "Near Space Labs",
       "storage:region": "us-central1",
       "storage:requester_pays": true,
       "storage:tier": "COLDLINE",
@@ -82,7 +80,6 @@
       "storage:bucket": "naip-visualization",
       "storage:object_path": "tx/2016/100cm/rgb/30097/m_3009743_sw_14_1_20160928.tif",
       "storage:platform": "AWS",
-      "storage:manager": "ESRI",
       "storage:region": "us-west-2",
       "storage:requester_pays": true,
       "storage:tier": "standard",
@@ -95,7 +92,6 @@
       "storage:bucket": "naipeuwest",
       "storage:object_path": "naip/v002/tx/2016/tx_100cm_2016/30097/m_3009743_sw_14_1_20160928.tif",
       "storage:platform": "AZURE",
-      "storage:manager": "AZURE",
       "storage:region": "westeurope",
       "storage:requester_pays": false,
       "storage:tier": "hot tier",
@@ -108,7 +104,6 @@
       "storage:bucket": "naipblobs",
       "storage:object_path": "naip/v002/tx/2016/tx_100cm_2016/30097/m_3009743_sw_14_1_20160928.tif",
       "storage:platform": "AZURE",
-      "storage:manager": "AZURE",
       "storage:region": "eastus",
       "storage:requester_pays": false,
       "storage:tier": "hot tier",
@@ -121,7 +116,6 @@
       "storage:bucket": "naipblobs",
       "storage:object_path": "naip/v002/tx/2016/tx_100cm_2016/30097/m_3009743_sw_14_1_20160928.200.jpg",
       "storage:platform": "AZURE",
-      "storage:manager": "AZURE",
       "storage:region": "eastus",
       "storage:requester_pays": false,
       "storage:tier": "hot tier",
@@ -131,14 +125,12 @@
   },
   "links": [
     {
-      "rel": "root",
-      "href": "../../catalog.json",
-      "type": "application/json"
+      "href": "https://example.com/examples/item.json",
+      "rel": "self"
     },
     {
-      "rel": "parent",
-      "href": "../collection.json",
-      "type": "application/json"
+      "href": "https://example.com/examples/item.json",
+      "rel": "collection"
     }
   ]
 }
diff --git a/examples/item-nsl.json b/examples/item-nsl.json
@@ -1,7 +1,6 @@
 {
-  "stac_version": "1.0.0-beta.2",
+  "stac_version": "1.0.0",
   "stac_extensions": [
-    "view",
     "https://stac-extensions.github.io/storage/v1.0.0/schema.json"
   ],
   "id": "20190822T183518Z_746_POM1_ST2_P",
@@ -46,7 +45,6 @@
     "platform": "SWIFT_2",
     "instrument": "POM_1",
     "gsd": 0.20000000298023224,
-    "view:off_nadir": 9.42326831817627,
     "storage:min_tier_duration": 0,
     "storage:max_tier_duration": 90,
     "storage:archived": true
@@ -58,7 +56,6 @@
       "storage:bucket": "swiftera-processed-data",
       "storage:object_path": "20190822T162258Z_TRAVIS_COUNTY/Published/REGION_0/20190822T183518Z_746_POM1_ST2_P.tif",
       "storage:platform": "GCP",
-      "storage:manager": "Near Space Labs",
       "storage:region": "us-central1",
       "storage:requester_pays": true,
       "storage:tier": "Standard",
@@ -71,7 +68,6 @@
       "storage:bucket": "swiftera-processed-data",
       "storage:object_path": "20190822T162258Z_TRAVIS_COUNTY/Published/REGION_0/20190822T183518Z_746_POM1_ST2_P.png",
       "storage:platform": "GCP",
-      "storage:manager": "Near Space Labs",
       "storage:region": "us-central1",
       "storage:requester_pays": true,
       "storage:tier": "Standard",
@@ -84,7 +80,6 @@
       "storage:bucket": "nsl-data-archive",
       "storage:object_path": "20190822T162258Z_TRAVIS_COUNTY/Published/REGION_0/20190822T183518Z_746_POM1_ST2_P.tif",
       "storage:platform": "AWS",
-      "storage:manager": "Near Space Labs",
       "storage:region": "us-central1",
       "storage:requester_pays": true,
       "storage:tier": "Glacier",
@@ -98,7 +93,6 @@
       "storage:bucket": "nsl-data-archive",
       "storage:object_path": "20190822T162258Z_TRAVIS_COUNTY/Published/REGION_0/20190822T183518Z_746_POM1_ST2_P.png",
       "storage:platform": "AWS",
-      "storage:manager": "Near Space Labs",
       "storage:region": "us-central1",
       "storage:requester_pays": true,
       "storage:tier": "Standard",
@@ -108,14 +102,12 @@
   },
   "links": [
     {
-      "rel": "root",
-      "href": "../../catalog.json",
-      "type": "application/json"
+      "href": "https://example.com/examples/item.json",
+      "rel": "self"
     },
     {
-      "rel": "parent",
-      "href": "../collection.json",
-      "type": "application/json"
+      "href": "https://example.com/examples/item.json",
+      "rel": "collection"
     }
   ]
 }
diff --git a/json-schema/schema.json b/json-schema/schema.json
diff --git a/package.json b/package.json
