You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,8 +41,8 @@ The fields in the table below can be used in these parts of STAC documents:
41
41
#### `merkle:object_hash`
42
42
43
43
-**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.
46
46
47
47
#### `merkle:hash_method`
48
48
@@ -56,13 +56,15 @@ to verify that the object's metadata has not been altered.
56
56
- This provides transparency and allows users to accurately verify the hashes.
57
57
-**Usage:**
58
58
-**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.
61
61
62
62
#### `merkle:root`
63
63
64
64
-**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.
66
68
67
69
### Hash Method Object
68
70
@@ -71,7 +73,8 @@ The `merkle:hash_method` object provides details about the hash computation meth
|`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`). |
75
78
|`ordering`| string |**REQUIRED** (for Collections and Catalogs). Describes how the hashes are ordered when building the Merkle tree (e.g., "ascending by hash value"). |
76
79
|`description`| string | Optional. Additional details or notes about the hash computation method, such as serialization format or any special considerations. |
77
80
@@ -98,7 +101,8 @@ The `merkle:hash_method` object provides details about the hash computation meth
98
101
3.**Build Merkle Tree:**
99
102
- Pairwise hash the ordered hashes, proceeding up the tree until a single hash remains—the `merkle:root`.
100
103
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
0 commit comments