Skip to content

Commit 3cedfe7

Browse files
committed
update READMT to have all item properties
1 parent 499fa34 commit 3cedfe7

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- **Field Name Prefix:** storage
66
- **Scope:** Item, Asset
77
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
8-
- **Owner**: @davidraleigh
8+
- **Owner**: @davidraleigh @matthewhanson
99

1010
This document explains the Storage Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
1111
This extension adds fields to STAC Item and Asset objects, allowing for details related to cloud storage access and costs to be associated
@@ -18,26 +18,24 @@ with a STAC Item. This extension does not cover NFS solutions provided by PaaS
1818
- [Changelog](./CHANGELOG.md)
1919

2020
## Item Fields
21+
2122
| Field Name | Type | Description |
2223
| ----------- | ------ | ----------- |
2324
| storage:min_tier_duration | integer | number of days for the shortest time tier restriction on access of an asset. |
2425
| storage:max_tier_duration | integer | number of days for the longest time tier restrictions on access of an asset. |
2526
| storage:archived | bool | descriptor for whether the data is "properly" archived according to implementers discretion |
26-
27-
## Asset Fields
28-
29-
| Field Name | Type | Description |
30-
| ----------- | ------ | ----------- |
3127
| storage:platform | string | (REQUIRED) The [cloud provider](#providers) where data is stored |
3228
| storage:manager | string | The entity in charge of managing the data. |
3329
| 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) |
34-
| storage:bucket | string | The bucket for the asset, used along with object path |
30+
| storage:bucket | string | The bucket for the asset(s), used along with object path |
3531
| storage:object_path | string | The object_path for the asset, used along with bucket |
3632
| storage:requester_pays | bool | Is the data requester pays or is it data manager/cloud provider pays. *Defaults to false* |
3733
| storage:tier | string | The title for the tier type (as defined by PaaS provider) |
3834
| storage:tier_duration | integer | Minimum storage duration (in days) required before additional fees |
3935
| storage:first_byte_latency | string | approximate time unit (milliseconds, minutes or hours) for accessing first byte of data |
4036

37+
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.
38+
4139
### Additional Field Information
4240

4341
#### Providers

0 commit comments

Comments
 (0)