Skip to content

Commit 8312e1f

Browse files
authored
Update README.md
1 parent e3240f9 commit 8312e1f

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@
77
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
88
- **Owner**: @jonhealy1
99

10-
This extension specifies a way to ensure metadata integrity for STAC Items, Collections, and Catalogs by encoding them in a Merkle tree via hashing. Each STAC object (Item, Collection, or Catalog) is hashed using a hash function (e.g., SHA-256), and this hash is stored in the object's properties under the `merkle:object_hash` field. Details concerning the methods used for hashing are stored in a separate object called `merkle:hash_method`. To produce the Merkle root identifier for a Collection or Catalog, the hashes from its child objects are taken into account. This process ensures the integrity of all STAC objects within the hierarchy.
10+
This extension specifies a way to ensure metadata integrity for STAC Items, Collections, and Catalogs by encoding them in a Merkle tree via hashing. Each STAC object (Item, Collection, or Catalog)
11+
is hashed using a hash function (e.g., SHA-256), and this hash is stored in the object's properties under the `merkle:object_hash` field. Details concerning the methods used for hashing are stored
12+
in a separate object called `merkle:hash_method`. To produce the Merkle root identifier for a Collection or Catalog, the hashes from its child objects are taken into account. This process ensures
13+
the integrity of all STAC objects within the hierarchy.
1114

1215
- **Examples:**
1316
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item.
@@ -37,7 +40,8 @@ The fields in the table below can be used in these parts of STAC documents:
3740
#### `merkle:object_hash`
3841

3942
- **Type:** string
40-
- **Description:** A cryptographic hash of the object's metadata (Item, Collection, or Catalog), computed according to the method specified in the `merkle:hash_method`. This hash allows users to verify that the object's metadata has not been altered.
43+
- **Description:** A cryptographic hash of the object's metadata (Item, Collection, or Catalog), computed according to the method specified in the `merkle:hash_method`. This hash allows users
44+
to verify that the object's metadata has not been altered.
4145

4246
#### `merkle:hash_method`
4347

@@ -51,7 +55,8 @@ The fields in the table below can be used in these parts of STAC documents:
5155
- This provides transparency and allows users to accurately verify the hashes.
5256
- **Usage:**
5357
- **Collections and Catalogs:** This object is **REQUIRED**.
54-
- **Items:** Items inherit the `merkle:hash_method` from their parent Collection by default. An Item can optionally include its own `merkle:hash_method` if it uses a different hash method than the Collection.
58+
- **Items:** Items inherit the `merkle:hash_method` from their parent Collection by default. An Item can optionally include its own `merkle:hash_method` if it uses a different
59+
hash method than the Collection.
5560

5661
#### `merkle:root`
5762

0 commit comments

Comments
 (0)