Skip to content

Commit 7b2b9c6

Browse files
authored
Update README.md
1 parent c17a60d commit 7b2b9c6

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ The fields in the table below can be used in these parts of STAC documents:
4141
#### `merkle:object_hash`
4242

4343
- **Type:** string
44-
- **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
45-
to verify that the object's metadata has not been altered.
44+
- **Description:** A cryptographic hash of the object's metadata (Item, Collection, or Catalog), computed according to the method specified in
45+
the `merkle:hash_method`. This hash allows users to verify that the object's metadata has not been altered.
4646

4747
#### `merkle:hash_method`
4848

@@ -56,13 +56,15 @@ to verify that the object's metadata has not been altered.
5656
- This provides transparency and allows users to accurately verify the hashes.
5757
- **Usage:**
5858
- **Collections and Catalogs:** This object is **REQUIRED**.
59-
- **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
60-
hash method than the Collection.
59+
- **Items:** Items inherit the `merkle:hash_method` from their parent Collection by default. An Item can optionally include its own
60+
`merkle:hash_method` if it uses a different hash method than the Collection.
6161

6262
#### `merkle:root`
6363

6464
- **Type:** string
65-
- **Description:** The Merkle root hash representing the Collection or Catalog. It is computed by building a Merkle tree from the `merkle:object_hash` values of its child objects and, optionally, its own `merkle:object_hash`. This root hash provides a single value that represents the integrity of all underlying objects.
65+
- **Description:** The Merkle root hash representing the Collection or Catalog. It is computed by building a Merkle tree from the `merkle:object_hash`
66+
values of its child objects and, optionally, its own `merkle:object_hash`. This root hash provides a single value that represents the integrity of
67+
all underlying objects.
6668

6769
### Hash Method Object
6870

@@ -71,7 +73,8 @@ The `merkle:hash_method` object provides details about the hash computation meth
7173
| Field Name | Type | Description |
7274
| ------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7375
| `function` | string | **REQUIRED**. The cryptographic hash function used (e.g., `sha256`, `sha3-256`). |
74-
| `fields` | \[string\] | **REQUIRED** (for all objects). An array of fields included in the hash computation. Use `"*"` or `"all"` to indicate that all fields are included. For nested fields, dot notation should be used (e.g., `properties.datetime`, `assets.image`). |
76+
| `fields` | \[string\] | **REQUIRED** (for all objects). An array of fields included in the hash computation. Use `"*"` or `"all"` to indicate
77+
that all fields are included. For nested fields, dot notation should be used (e.g., `properties.datetime`, `assets.image`). |
7578
| `ordering` | string | **REQUIRED** (for Collections and Catalogs). Describes how the hashes are ordered when building the Merkle tree (e.g., "ascending by hash value"). |
7679
| `description` | string | Optional. Additional details or notes about the hash computation method, such as serialization format or any special considerations. |
7780

@@ -98,7 +101,8 @@ The `merkle:hash_method` object provides details about the hash computation meth
98101
3. **Build Merkle Tree:**
99102
- Pairwise hash the ordered hashes, proceeding up the tree until a single hash remains—the `merkle:root`.
100103
4. **Include `merkle:hash_method`:**
101-
- Specify the method used in the Collection's or Catalog's `merkle:hash_method` field, including any details necessary for users to replicate the process.
104+
- Specify the method used in the Collection's or Catalog's `merkle:hash_method` field, including any details necessary for users
105+
to replicate the process.
102106

103107
## Examples
104108

0 commit comments

Comments
 (0)