-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Put EventResponseJSONAPI in its own file
And add appropriate file comments for both eventresponse.proto and eventresponsejsonapi.proto AB#8336
- Loading branch information
Robin Bryce
committed
Feb 28, 2024
1 parent
d93b8f8
commit 554a17d
Showing
3 changed files
with
198 additions
and
176 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
191 changes: 191 additions & 0 deletions
191
datatrails-common-api/assets/v2/assets/eventresponsejsonapi.proto
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| // Maintainers, please refer to the style guide here: | ||
| // https://developers.google.com/protocol-buffers/docs/style | ||
| // | ||
| // This file provides a type that can marshal the event data a customer sees | ||
| // from our apis. It is typically used for demo and api code in go-lang that | ||
| // needs to work with our api responses. | ||
| // | ||
| // NOTE: It MUST be kept up to date with the EventREsponse message definition | ||
|
|
||
| syntax = "proto3"; | ||
| package archivist.v2; | ||
| option go_package="github.com/datatrails/go-datatrails-common-api-gen/assets/v2/assets;assets"; | ||
| import "protoc-gen-openapiv2/options/annotations.proto"; | ||
| import "datatrails-common-api/assets/v2/assets/enums.proto"; | ||
| import "datatrails-common-api/assets/v2/assets/principal.proto"; | ||
| import "datatrails-common-api/assets/v2/assets/merklelogentry.proto"; | ||
|
|
||
|
|
||
| // EventResponseJSONAPI represents how the consumer of the events api sees the event data. | ||
| message EventResponseJSONAPI { | ||
| option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_schema) = { | ||
| json_schema: { | ||
| description: "This describes an Event." | ||
| } | ||
| example:"{ " | ||
| "\"identity\": \"assets/add30235-1424-4fda-840a-d5ef82c4c96f/events/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000\", " | ||
| "\"asset_identity\": \"assets/add30235-1424-4fda-840a-d5ef82c4c96f\", " | ||
| "\"operation\": \"Record\", " | ||
| "\"behaviour\": \"RecordEvidence\", " | ||
| "\"event_attributes\": { " | ||
| " \"arc_attachments\": [" | ||
| " {" | ||
| " \"arc_attachment_identity\": \"blobs/1754b920-cf20-4d7e-9d36-9ed7d479744d\"," | ||
| " \"arc_hash_value\": \"01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b\"," | ||
| " \"arc_display_name\": \"Picture from yesterday\"," | ||
| " \"arc_hash_alg\": \"sha256\"" | ||
| " }" | ||
| " ]" | ||
| "}, " | ||
| "\"asset_attributes\": { " | ||
| " \"arc_firmware_version\": \"3.2.1\", " | ||
| " \"arc_home_location_identity\": \"locations/42054f10-9952-4c10-a082-9fd0d10295ae\"" | ||
| "}, " | ||
| "\"timestamp_accepted\": \"2019-11-27T14:44:19Z\", " | ||
| "\"timestamp_declared\": \"2019-11-27T14:44:19Z\", " | ||
| "\"timestamp_committed\": \"2019-11-27T14:44:19Z\", " | ||
| "\"principal_declared\": { " | ||
| " \"issuer\": \"job.idp.server/1234\", \"subject\":\"bob@job\" " | ||
| " }, " | ||
| " \"principal_accepted\": { " | ||
| " \"issuer\": \"job.idp.server/1234\", \"subject\":\"bob@job\" " | ||
| "}, " | ||
| "\"confirmation_status\": \"CONFIRMED\", " | ||
| "\"block_number\": 12, " | ||
| "\"transaction_index\": 5, " | ||
| "\"transaction_id\": \"0x07569\", " | ||
| "\"tenant_identity\": \"tenant/8e0b600c-8234-43e4-860c-e95bdcd695a9\" " | ||
| "}" | ||
| }; | ||
|
|
||
| // Relative Resource Name for the operation event | ||
| string identity = 1 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "identity of a event resource" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // relative resource name for associated asset ( asset the operation is performed on - has to have specific behaviour enabled) | ||
| string asset_identity = 2 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "identity of a related asset resource `assets/11bf5b37-e0b8-42e0-8dcf-dc8c4aefc000`" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // map of event attributes. Specific behaviours define required and optional event attributes for each supported operation. | ||
| map<string, string> event_attributes = 16 [ | ||
| (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "key value mapping of event attributes" | ||
| } | ||
| ]; | ||
|
|
||
| // map of asset attributes. Specific behaviours define required and optional asset attributes. These attributes cause the corresponding attributes on the asset to be updated. | ||
| map<string, string> asset_attributes = 17 [ | ||
| (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "key value mapping of asset attributes" | ||
| } | ||
| ]; | ||
|
|
||
| // name of operation on this behviour | ||
| string operation = 4 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "The operation represented by the event. `Record`" | ||
| read_only: true | ||
| max_length: 4096 | ||
| }]; | ||
|
|
||
| // name of this behaviour | ||
| string behaviour = 14 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "The behaviour used to create event. `RecordEvidence`" | ||
| read_only: true | ||
| max_length: 4096 | ||
| }]; | ||
|
|
||
| // timestamp when operation was actually performed - if not provided will be set to timestamp_accepted | ||
| string timestamp_declared = 5 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "RFC 3339 time of event as declared by the user" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // timestamp when system received operation request | ||
| string timestamp_accepted = 6 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "RFC 3339 time of event as recorded by the server" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // timestamp for when the event was committed to a verifiable log | ||
| string timestamp_committed = 7 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "RFC 3339 time of event as recorded in verifiable storage" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // principal information associated with event - if not provided will be set to principal_accepted | ||
| Principal principal_declared = 8 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "principal provided by the user" | ||
| read_only: true | ||
| // see https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/options/openapiv2.proto | ||
| // for specific types. | ||
| type: OBJECT | ||
| }]; | ||
|
|
||
| // principal logged into the system that performed the operation | ||
| Principal principal_accepted = 9 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "principal recorded by the server" | ||
| read_only: true | ||
| // see https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/options/openapiv2.proto | ||
| // for specific types. | ||
| type: OBJECT | ||
| }]; | ||
|
|
||
| // indicated if operation has been committed to the blockchain | ||
| string confirmation_status = 10 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "indicates if the event has been succesfully committed to the blockchain" | ||
| read_only: true | ||
| // see https://github.com/grpc-ecosystem/grpc-gateway/blob/master/protoc-gen-openapiv2/options/openapiv2.proto | ||
| // for specific types. | ||
| type: STRING | ||
| }]; | ||
|
|
||
| // NOTICE: We expect to retire simple hash and then remove all the top level dlt fields. | ||
|
|
||
| // hash of transaction committing this operation on blockchain | ||
| string transaction_id = 11 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "hash of the transaction as a hex string `0x11bf5b37e0b842e08dcfdc8c4aefc000`" | ||
| max_length: 4096 | ||
| }]; | ||
|
|
||
| // block number of committing transaction | ||
| uint64 block_number = 12 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "number of block event was commited on" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // transaction index of committing transaction | ||
| uint64 transaction_index = 13 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "index of event within commited block" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| // wallet address for the creator of this event | ||
| string from = 15 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: "wallet address for the creator of this event" | ||
| read_only: true | ||
| }]; | ||
|
|
||
| string tenant_identity = 18 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: | ||
| "Identity of the tenant the that created this event" | ||
| max_length: 1024 | ||
| }]; | ||
|
|
||
| // An event has exactly one proof mechanism. This field caputures the proof | ||
| // mechanism specific details supporting the trustworthyness of the event | ||
| // record. We anticipate at least two proof mechs: merkle_log and | ||
| // verkle_log. We use oneof to avoid repeating the scattering of randomly | ||
| // re-purposed fields we currently have for simple hash vs khipu. | ||
| oneof proof_details { | ||
| // proof details for proof_mechanism MERKLE_LOG | ||
| MerkleLogEntry merklelog_entry = 19 [ (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_field) = { | ||
| description: | ||
| "verifiable merkle mmr log entry details" | ||
| max_length: 1024 | ||
| }]; | ||
| }; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters