diff --git a/content/developers/api-reference/assets-api/index.md b/content/developers/api-reference/assets-api/index.md index 85f73874d..dc0746570 100644 --- a/content/developers/api-reference/assets-api/index.md +++ b/content/developers/api-reference/assets-api/index.md @@ -43,13 +43,10 @@ Define the asset parameters and store in `/path/to/jsonfile`: "arc_file_name": "somepic.jpeg", "arc_display_name": "Picture from yesterday", }, - "arc_firmware_version": "3.2.1", - "arc_home_location_identity": "locations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "behaviours": [ "RecordEvidence" ], - "proof_mechanism": "SIMPLE_HASH", "public": false } ``` @@ -81,8 +78,6 @@ The response is: "arc_file_name": "somepic.jpeg", "arc_display_name": "Picture from yesterday", }, - "arc_firmware_version": "3.2.1", - "arc_home_location_identity": "locations/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }, "behaviours": [ "RecordEvidence" @@ -90,7 +85,6 @@ The response is: "confirmation_status": "PENDING", "identity": "assets/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "owner": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxX", - "proof_mechanism": "SIMPLE_HASH", "public": false, "tenant_identity": "tenant/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "tracked": "TRACKED" @@ -141,8 +135,7 @@ Define the asset parameters and store in `/path/to/jsonfile`: "behaviours": [ "Builtin", "RecordEvidence" - ], - "proof_mechanism":"SIMPLE_HASH" + ] } ``` {{< note >}} @@ -184,7 +177,6 @@ The response is: "owner": "", "at_time": "2023-09-27T11:32:22Z", "storage_integrity": "TENANT_STORAGE", - "proof_mechanism": "SIMPLE_HASH", "chain_id": "8275868384", "public": false, "tenant_identity": "" diff --git a/content/developers/api-reference/events-api/index.md b/content/developers/api-reference/events-api/index.md index 2e851fed2..44c90d89a 100644 --- a/content/developers/api-reference/events-api/index.md +++ b/content/developers/api-reference/events-api/index.md @@ -85,7 +85,7 @@ The response is: "issuer": "job.idp.server/1234", "subject": "bob@job" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "block_number": 12, "transaction_index": 5, "transaction_id": "0x07569" @@ -384,7 +384,7 @@ You should see the response: "issuer": "job.idp.server/1234", "subject": "bob@job" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "block_number": 12, "transaction_index": 5, "transaction_id": "0x07569" diff --git a/content/developers/api-reference/iam-policies-api/index.md b/content/developers/api-reference/iam-policies-api/index.md index 8dfafcde4..28a7f6439 100644 --- a/content/developers/api-reference/iam-policies-api/index.md +++ b/content/developers/api-reference/iam-policies-api/index.md @@ -76,7 +76,7 @@ Define the access_policies parameters and store in `/path/to/jsonfile`: "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -126,7 +126,7 @@ The response is: "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -210,7 +210,7 @@ Each of these calls returns a list of matching IAM Access Policies records in th "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -234,7 +234,7 @@ Each of these calls returns a list of matching IAM Access Policies records in th "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -292,7 +292,7 @@ Define the Access Policy parameters to be changed and store in `/path/to/jsonfil "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -342,7 +342,7 @@ The response is: "behaviours": [ "RecordEvidence" ], "event_arc_display_type_read": ["toner_type", "toner_colour"], "event_arc_display_type_write": ["toner_replacement"], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "subjects": [ "subjects/6a951b62-0a26-4c22-a886-1082297b063b", "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" @@ -402,7 +402,7 @@ Each of these calls returns a list of matching Asset records in the form: "arc_display_name": "arc_primary_image", }, }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "tracked": "TRACKED" } ] @@ -447,7 +447,7 @@ Each of these calls returns a list of matching IAM `access_policies` records in "subjects/a24306e5-dc06-41ba-a7d6-2b6b3e1df48d" ], "behaviours": [ "RecordEvidence" ], - "include_attributes": [ "arc_display_name", "arc_display_type", "arc_firmware_version" ], + "include_attributes": [ "arc_display_name", "arc_display_type" ], "user_attributes": [ {"or": ["group:maintainers", "group:supervisors"]} ] diff --git a/content/developers/api-reference/public-assets-api/index.md b/content/developers/api-reference/public-assets-api/index.md index e253c2c4c..99041a270 100644 --- a/content/developers/api-reference/public-assets-api/index.md +++ b/content/developers/api-reference/public-assets-api/index.md @@ -51,12 +51,11 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/ "arc_description": "This asset is public", "arc_display_name": "Public Asset" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "tracked": "TRACKED", "owner": "0x5eC362570D1b52a01648997db5ed7693fc6b3978", "at_time": "2022-07-15T14:26:40Z", "storage_integrity": "TENANT_STORAGE", - "proof_mechanism": "SIMPLE_HASH", "chain_id": "8275868384", "public": true, "tenant_identity": "tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9" @@ -98,7 +97,7 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/ "display_name": "", "email": "" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "transaction_id": "", "block_number": 0, "transaction_index": 0, @@ -153,7 +152,7 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/ "display_name": "", "email": "" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "transaction_id": "", "block_number": 0, "transaction_index": 0, @@ -198,7 +197,7 @@ curl -H "Content-Type: application/json" https://app.datatrails.ai/archivist/v2/ "display_name": "", "email": "" }, - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "transaction_id": "", "block_number": 0, "transaction_index": 0, diff --git a/content/developers/developer-patterns/containers-as-assets/index.md b/content/developers/developer-patterns/containers-as-assets/index.md index 9ffa47dc1..3af15dc46 100644 --- a/content/developers/developer-patterns/containers-as-assets/index.md +++ b/content/developers/developer-patterns/containers-as-assets/index.md @@ -46,7 +46,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH attributes: arc_display_name: Shipping Container arc_display_type: Shipping Container @@ -60,7 +59,6 @@ steps: cat > asset.json < asset-box.json <" @@ -137,7 +136,7 @@ steps: ## Assets Wait For Confirmed -This action tells the YAML Runner to wait before proceeding to the next step until all Assets that meet your specified criteria are confirmed. +This action tells the YAML Runner to wait before proceeding to the next step until all Assets that meet your specified criteria are confirmed/committed. ```yaml --- diff --git a/content/developers/yaml-reference/events/index.md b/content/developers/yaml-reference/events/index.md index f695dda3a..b067678da 100644 --- a/content/developers/yaml-reference/events/index.md +++ b/content/developers/yaml-reference/events/index.md @@ -27,7 +27,7 @@ The `asset_label` must match the setting when the Asset was created in an earlie There are a few optional settings that can be used when creating Events. `attachments` uploads the attachment to DataTrails and the response is added to the Event before posting. `location` creates the location if it does not exist and adds it to the Event. The `sbom` setting uploads the SBOM to DataTrails and adds the response to the Event before posting. -`confirm: true` tells the YAML Runner to wait for the Event to be confirmed before moving to the next step. +`confirm: true` tells the YAML Runner to wait for the Event to be committed before moving to the next step. For example: @@ -113,7 +113,7 @@ steps: print_response: true asset_label: Courts of Justice Paris Front Door props: - confirmation_status: CONFIRMED + confirmation_status: COMMITTED attrs: arc_display_type: open asset_attrs: @@ -135,7 +135,7 @@ steps: print_response: true asset_label: Courts of Justice Paris Front Door props: - confirmation_status: CONFIRMED + confirmation_status: COMMITTED attrs: arc_display_type: open asset_attrs: diff --git a/content/developers/yaml-reference/subjects/index.md b/content/developers/yaml-reference/subjects/index.md index 1ffc644eb..a2d4b49b0 100644 --- a/content/developers/yaml-reference/subjects/index.md +++ b/content/developers/yaml-reference/subjects/index.md @@ -156,7 +156,7 @@ steps: ## Subjects Wait for Confirmation -This action tells the YAML Runner to wait before proceeding to the next step until all Subjects that meet your specified criteria are confirmed. +This action tells the YAML Runner to wait before proceeding to the next step until all Subjects that meet your specified criteria are confirmed/committed. `subject_label` is required, and may be specified as the friendly name defined in a previous step or as the Subject ID of an existing subject, in the form `subjects/`. diff --git a/content/platform/overview/advanced-concepts/index.md b/content/platform/overview/advanced-concepts/index.md index 9f53e118d..82c08acb7 100644 --- a/content/platform/overview/advanced-concepts/index.md +++ b/content/platform/overview/advanced-concepts/index.md @@ -75,7 +75,7 @@ A simple Asset might look like this: "at_time": "2021-06-25T12:40:03Z", // Storage and integrity properties - managed by the system - "confirmation_status": "CONFIRMED", + "confirmation_status": "COMMITTED", "tracked": "TRACKED", "owner": "0xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "storage_integrity": "LEDGER" diff --git a/content/platform/overview/creating-an-asset/index.md b/content/platform/overview/creating-an-asset/index.md index 484ece037..61215564d 100644 --- a/content/platform/overview/creating-an-asset/index.md +++ b/content/platform/overview/creating-an-asset/index.md @@ -66,8 +66,6 @@ Create an empty file, in later steps we will add the correct JSON. 1. Add details to your new Asset. - The Proof Mechanism [`Simple Hash`](/platform/overview/advanced-concepts/#simple-hash) commits a batch of events as one blockchain transaction. This allows you to audit if the asset has changed during that time period. - Please see our [Advanced Concepts](/platform/overview/advanced-concepts/#proof-mechanisms) section for more information on the Proof Mechanism for your Asset. {{< tabs name="add_asset_details" >}} {{{< tab name="UI" >}} You will see an Asset Creation form, where you provide details of your new Asset: @@ -91,7 +89,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH ``` {{< /tab >}} @@ -102,8 +99,7 @@ In the file you created earlier, begin adding metadata for your Asset: ```json { - "behaviours": ["RecordEvidence"], - "proof_mechanism": "SIMPLE_HASH" + "behaviours": ["RecordEvidence"] } ``` @@ -133,7 +129,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH attributes: arc_display_name: My First Container arc_display_type: Shipping Container @@ -145,8 +140,7 @@ The DataTrails API uses the reserved attributes `arc_display_name` and `arc_disp ```json { - "behaviours": ["RecordEvidence"], - "proof_mechanism": "SIMPLE_HASH", + "behaviours": ["RecordEvidence"] "attributes": { "arc_display_name": "My First Container", "arc_display_type": "Shipping Container" @@ -190,7 +184,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH attributes: arc_display_name: My First Container arc_display_type: Shipping Container @@ -216,8 +209,7 @@ This example also adds a location to our Asset. To find out more about locations ```json { - "behaviours": ["RecordEvidence"], - "proof_mechanism": "SIMPLE_HASH", + "behaviours": ["RecordEvidence"] "attributes": { "arc_display_name": "My First Container", "arc_display_type": "Shipping Container", diff --git a/content/platform/overview/registering-a-document-profile-asset/index.md b/content/platform/overview/registering-a-document-profile-asset/index.md index 104bdbd5d..8fc563567 100644 --- a/content/platform/overview/registering-a-document-profile-asset/index.md +++ b/content/platform/overview/registering-a-document-profile-asset/index.md @@ -154,7 +154,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH public: true attributes: arc_display_name: My First Document @@ -180,7 +179,6 @@ The DataTrails API uses the reserved attributes `arc_display_name` and `arc_disp }, "behaviours": ["RecordEvidence"], - "proof_mechanism": "SIMPLE_HASH", "public": true } ``` @@ -221,7 +219,6 @@ steps: - arc_display_name behaviours: - RecordEvidence - proof_mechanism: SIMPLE_HASH public: true attributes: arc_display_name: My First Document @@ -259,7 +256,6 @@ This example also adds a location to our Asset. To find out more about locations }, "behaviours": ["RecordEvidence"], - "proof_mechanism": "SIMPLE_HASH", "public": true } ```