From 40e872537379dd585ac94c98fdcc9fddb94665aa Mon Sep 17 00:00:00 2001 From: Scott Phillips Date: Mon, 1 Nov 2021 19:13:04 -0400 Subject: [PATCH] =?UTF-8?q?Documentation=20generated=20automatically=20fro?= =?UTF-8?q?m=20`.proto`=20files=20=F0=9F=94=A5=20=20(#172)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- devops/generate_proto_files.py | 10 + docs/reference/proto/index.md | 1602 ++++++++++++++++++++++++++++++++ mkdocs.yml | 1 + 3 files changed, 1613 insertions(+) create mode 100644 docs/reference/proto/index.md diff --git a/devops/generate_proto_files.py b/devops/generate_proto_files.py index 673540bf4..8eb72933e 100644 --- a/devops/generate_proto_files.py +++ b/devops/generate_proto_files.py @@ -84,6 +84,15 @@ def update_java(): shutil.rmtree(join(java_proto_path, 'trinsic', 'okapi')) +def update_markdown(): + lang_path = get_language_dir('docs') + lang_proto_path = join(lang_path, 'reference', 'proto') + # https://github.com/pseudomuto/protoc-gen-doc + # go get -u github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc + # Add to path and rename to `protoc-gen-grpc-java` + run_protoc({'doc_out': lang_proto_path}, {'doc_opt': 'markdown,index.md'}, get_proto_files()) + + def update_python(): """ Generate the protobuf interface files using the python library https://github.com/danielgtaylor/python-betterproto @@ -111,6 +120,7 @@ def main(): update_ruby() update_java() update_python() + update_markdown() if __name__ == "__main__": diff --git a/docs/reference/proto/index.md b/docs/reference/proto/index.md new file mode 100644 index 000000000..03396e90c --- /dev/null +++ b/docs/reference/proto/index.md @@ -0,0 +1,1602 @@ +# Protocol Documentation + + +## Table of Contents + +- [pbmse/v1/pbmse.proto](#pbmse/v1/pbmse.proto) + - [EncryptedMessage](#pbmse.v1.EncryptedMessage) + - [EncryptionHeader](#pbmse.v1.EncryptionHeader) + - [EncryptionRecipient](#pbmse.v1.EncryptionRecipient) + - [Signature](#pbmse.v1.Signature) + - [SignatureHeader](#pbmse.v1.SignatureHeader) + - [SignedMessage](#pbmse.v1.SignedMessage) + + - [EncryptionAlgorithm](#pbmse.v1.EncryptionAlgorithm) + - [EncryptionMode](#pbmse.v1.EncryptionMode) + +- [services/common/v1/common.proto](#services/common/v1/common.proto) + - [JsonPayload](#services.common.v1.JsonPayload) + - [RequestOptions](#services.common.v1.RequestOptions) + + - [JsonFormat](#services.common.v1.JsonFormat) + - [ResponseStatus](#services.common.v1.ResponseStatus) + + - [Common](#services.common.v1.Common) + +- [services/debug/v1/debug.proto](#services/debug/v1/debug.proto) + - [Debugging](#services.debug.v1.Debugging) + +- [services/provider/v1/provider.proto](#services/provider/v1/provider.proto) + - [InvitationStatusRequest](#services.provider.v1.InvitationStatusRequest) + - [InvitationStatusResponse](#services.provider.v1.InvitationStatusResponse) + - [InviteRequest](#services.provider.v1.InviteRequest) + - [InviteRequest.DidCommInvitation](#services.provider.v1.InviteRequest.DidCommInvitation) + - [InviteResponse](#services.provider.v1.InviteResponse) + + - [InvitationStatusResponse.Status](#services.provider.v1.InvitationStatusResponse.Status) + - [ParticipantType](#services.provider.v1.ParticipantType) + + - [Provider](#services.provider.v1.Provider) + +- [services/trust-registry/v1/trust-registry.proto](#services/trust-registry/v1/trust-registry.proto) + - [AddFrameworkRequest](#services.trustregistry.v1.AddFrameworkRequest) + - [AddFrameworkResponse](#services.trustregistry.v1.AddFrameworkResponse) + - [CheckIssuerStatusRequest](#services.trustregistry.v1.CheckIssuerStatusRequest) + - [CheckIssuerStatusResponse](#services.trustregistry.v1.CheckIssuerStatusResponse) + - [CheckVerifierStatusRequest](#services.trustregistry.v1.CheckVerifierStatusRequest) + - [CheckVerifierStatusResponse](#services.trustregistry.v1.CheckVerifierStatusResponse) + - [FetchDataRequest](#services.trustregistry.v1.FetchDataRequest) + - [FetchDataResponse](#services.trustregistry.v1.FetchDataResponse) + - [GovernanceFramework](#services.trustregistry.v1.GovernanceFramework) + - [RegisterIssuerRequest](#services.trustregistry.v1.RegisterIssuerRequest) + - [RegisterIssuerResponse](#services.trustregistry.v1.RegisterIssuerResponse) + - [RegisterVerifierRequest](#services.trustregistry.v1.RegisterVerifierRequest) + - [RegisterVerifierResponse](#services.trustregistry.v1.RegisterVerifierResponse) + - [RemoveFrameworkRequest](#services.trustregistry.v1.RemoveFrameworkRequest) + - [RemoveFrameworkResponse](#services.trustregistry.v1.RemoveFrameworkResponse) + - [SearchRegistryRequest](#services.trustregistry.v1.SearchRegistryRequest) + - [SearchRegistryResponse](#services.trustregistry.v1.SearchRegistryResponse) + - [UnregisterIssuerRequest](#services.trustregistry.v1.UnregisterIssuerRequest) + - [UnregisterIssuerResponse](#services.trustregistry.v1.UnregisterIssuerResponse) + - [UnregisterVerifierRequest](#services.trustregistry.v1.UnregisterVerifierRequest) + - [UnregisterVerifierResponse](#services.trustregistry.v1.UnregisterVerifierResponse) + + - [RegistrationStatus](#services.trustregistry.v1.RegistrationStatus) + + - [TrustRegistry](#services.trustregistry.v1.TrustRegistry) + +- [services/universal-wallet/v1/universal-wallet.proto](#services/universal-wallet/v1/universal-wallet.proto) + - [ConnectRequest](#services.universalwallet.v1.ConnectRequest) + - [ConnectResponse](#services.universalwallet.v1.ConnectResponse) + - [CreateWalletRequest](#services.universalwallet.v1.CreateWalletRequest) + - [CreateWalletResponse](#services.universalwallet.v1.CreateWalletResponse) + - [GetProviderConfigurationRequest](#services.universalwallet.v1.GetProviderConfigurationRequest) + - [GetProviderConfigurationResponse](#services.universalwallet.v1.GetProviderConfigurationResponse) + - [GrantAccessRequest](#services.universalwallet.v1.GrantAccessRequest) + - [GrantAccessResponse](#services.universalwallet.v1.GrantAccessResponse) + - [InsertItemRequest](#services.universalwallet.v1.InsertItemRequest) + - [InsertItemResponse](#services.universalwallet.v1.InsertItemResponse) + - [InvitationToken](#services.universalwallet.v1.InvitationToken) + - [RevokeAccessRequest](#services.universalwallet.v1.RevokeAccessRequest) + - [RevokeAccessResponse](#services.universalwallet.v1.RevokeAccessResponse) + - [SearchRequest](#services.universalwallet.v1.SearchRequest) + - [SearchResponse](#services.universalwallet.v1.SearchResponse) + - [WalletProfile](#services.universalwallet.v1.WalletProfile) + + - [Wallet](#services.universalwallet.v1.Wallet) + +- [services/verifiable-credentials/templates/v1/templates.proto](#services/verifiable-credentials/templates/v1/templates.proto) + - [CreateCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.CreateCredentialTemplateRequest) + - [CreateCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.CreateCredentialTemplateResponse) + - [CredentialTemplate](#services.verifiablecredentials.templates.v1.CredentialTemplate) + - [DeleteCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.DeleteCredentialTemplateRequest) + - [DeleteCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.DeleteCredentialTemplateResponse) + - [GetCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.GetCredentialTemplateRequest) + - [GetCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.GetCredentialTemplateResponse) + - [SearchCredentialTemplatesRequest](#services.verifiablecredentials.templates.v1.SearchCredentialTemplatesRequest) + - [SearchCredentialTemplatesResponse](#services.verifiablecredentials.templates.v1.SearchCredentialTemplatesResponse) + - [UpdateCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.UpdateCredentialTemplateRequest) + - [UpdateCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.UpdateCredentialTemplateResponse) + + - [CredentialTemplates](#services.verifiablecredentials.templates.v1.CredentialTemplates) + +- [services/verifiable-credentials/v1/verifiable-credentials.proto](#services/verifiable-credentials/v1/verifiable-credentials.proto) + - [CreateProofRequest](#services.verifiablecredentials.v1.CreateProofRequest) + - [CreateProofResponse](#services.verifiablecredentials.v1.CreateProofResponse) + - [IssueFromTemplateRequest](#services.verifiablecredentials.v1.IssueFromTemplateRequest) + - [IssueRequest](#services.verifiablecredentials.v1.IssueRequest) + - [IssueResponse](#services.verifiablecredentials.v1.IssueResponse) + - [SendRequest](#services.verifiablecredentials.v1.SendRequest) + - [SendResponse](#services.verifiablecredentials.v1.SendResponse) + - [VerifyProofRequest](#services.verifiablecredentials.v1.VerifyProofRequest) + - [VerifyProofResponse](#services.verifiablecredentials.v1.VerifyProofResponse) + + - [Credential](#services.verifiablecredentials.v1.Credential) + +- [Scalar Value Types](#scalar-value-types) + + + + +

Top

+ +## pbmse/v1/pbmse.proto + + + + + +### EncryptedMessage + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| iv | [bytes](#bytes) | | | +| aad | [bytes](#bytes) | | | +| ciphertext | [bytes](#bytes) | | | +| tag | [bytes](#bytes) | | | +| recipients | [EncryptionRecipient](#pbmse.v1.EncryptionRecipient) | repeated | | + + + + + + + + +### EncryptionHeader + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| mode | [EncryptionMode](#pbmse.v1.EncryptionMode) | | | +| algorithm | [EncryptionAlgorithm](#pbmse.v1.EncryptionAlgorithm) | | | +| key_id | [string](#string) | | | +| sender_key_id | [string](#string) | | | + + + + + + + + +### EncryptionRecipient + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| header | [EncryptionHeader](#pbmse.v1.EncryptionHeader) | | | +| content_encryption_key | [bytes](#bytes) | | | + + + + + + + + +### Signature + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| header | [bytes](#bytes) | | | +| signature | [bytes](#bytes) | | | + + + + + + + + +### SignatureHeader + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| algorithm | [string](#string) | | | +| key_id | [string](#string) | | | + + + + + + + + +### SignedMessage +JWS +Protocol buffer message signing and encryption + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| payload | [bytes](#bytes) | | | +| signatures | [Signature](#pbmse.v1.Signature) | repeated | | + + + + + + + + + + +### EncryptionAlgorithm + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ENCRYPTION_ALGORITHM_UNSPECIFIED | 0 | | +| ENCRYPTION_ALGORITHM_XCHACHA20POLY1305 | 1 | | +| ENCRYPTION_ALGORITHM_AES_GCM | 2 | | + + + + + +### EncryptionMode + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| ENCRYPTION_MODE_UNSPECIFIED | 0 | | +| ENCRYPTION_MODE_DIRECT | 1 | | +| ENCRYPTION_MODE_CONTENT_ENCRYPTION_KEY | 2 | | + + + + + + + + + + + +

Top

+ +## services/common/v1/common.proto + + + + + +### JsonPayload + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| json_struct | [google.protobuf.Struct](#google.protobuf.Struct) | | | +| json_string | [string](#string) | | | +| json_bytes | [bytes](#bytes) | | | + + + + + + + + +### RequestOptions + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| response_json_format | [JsonFormat](#services.common.v1.JsonFormat) | | | + + + + + + + + + + +### JsonFormat + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Protobuf | 0 | | +| Binary | 1 | | +| String | 2 | | + + + + + +### ResponseStatus + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| SUCCESS | 0 | | +| WALLET_ACCESS_DENIED | 10 | | +| WALLET_EXISTS | 11 | | +| ITEM_NOT_FOUND | 20 | | +| SERIALIZATION_ERROR | 200 | | +| UNKNOWN_ERROR | 100 | | + + + + + + + + + +### Common + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Request | [.pbmse.v1.EncryptedMessage](#pbmse.v1.EncryptedMessage) | [.pbmse.v1.EncryptedMessage](#pbmse.v1.EncryptedMessage) | | + + + + + + +

Top

+ +## services/debug/v1/debug.proto + + + + + + + + + + + +### Debugging + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| CallEmpty | [.google.protobuf.Empty](#google.protobuf.Empty) | [.google.protobuf.Empty](#google.protobuf.Empty) | | +| CallEmptyAuth | [.google.protobuf.Empty](#google.protobuf.Empty) | [.google.protobuf.Empty](#google.protobuf.Empty) | | + + + + + + +

Top

+ +## services/provider/v1/provider.proto + + + + + +### InvitationStatusRequest +Request details for the status of onboarding +an individual or organization. +The referenece_id passed is the response from the +`Onboard` method call + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| invitation_id | [string](#string) | | | + + + + + + + + +### InvitationStatusResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [InvitationStatusResponse.Status](#services.provider.v1.InvitationStatusResponse.Status) | | | +| status_details | [string](#string) | | | + + + + + + + + +### InviteRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| participant | [ParticipantType](#services.provider.v1.ParticipantType) | | | +| description | [string](#string) | | | +| email | [string](#string) | | | +| phone | [string](#string) | | | +| didcomm_invitation | [InviteRequest.DidCommInvitation](#services.provider.v1.InviteRequest.DidCommInvitation) | | | + + + + + + + + +### InviteRequest.DidCommInvitation + + + + + + + + + +### InviteResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | +| invitation_id | [string](#string) | | | + + + + + + + + + + +### InvitationStatusResponse.Status + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| Error | 0 | Onboarding resulted in error | +| InvitationSent | 1 | The participant has been invited | +| Completed | 2 | The participant has been onboarded | + + + + + +### ParticipantType + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| participant_type_individual | 0 | | +| participant_type_organization | 1 | | + + + + + + + + + +### Provider + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Invite | [InviteRequest](#services.provider.v1.InviteRequest) | [InviteResponse](#services.provider.v1.InviteResponse) | rpc CreateOrganization(CreateOrganizationRequest) returns (CreateOrganizationResponse); | +| InviteWithWorkflow | [InviteRequest](#services.provider.v1.InviteRequest) | [InviteResponse](#services.provider.v1.InviteResponse) | | +| InvitationStatus | [InvitationStatusRequest](#services.provider.v1.InvitationStatusRequest) | [InvitationStatusResponse](#services.provider.v1.InvitationStatusResponse) | rpc CreateCredentialTemplate(CreateCredentialTemplateRequest) returns (CreateCredentialTemplateResponse); rpc ListCredentialTemplates(ListCredentialTemplatesRequest) returns (ListCredentialTemplatesResponse); | + + + + + + +

Top

+ +## services/trust-registry/v1/trust-registry.proto + + + + + +### AddFrameworkRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework | [GovernanceFramework](#services.trustregistry.v1.GovernanceFramework) | | | + + + + + + + + +### AddFrameworkResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### CheckIssuerStatusRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| credential_type_uri | [string](#string) | | | + + + + + + + + +### CheckIssuerStatusResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| status | [RegistrationStatus](#services.trustregistry.v1.RegistrationStatus) | | | + + + + + + + + +### CheckVerifierStatusRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| presentation_type_uri | [string](#string) | | | + + + + + + + + +### CheckVerifierStatusResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| status | [RegistrationStatus](#services.trustregistry.v1.RegistrationStatus) | | | + + + + + + + + +### FetchDataRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| query | [string](#string) | | | + + + + + + + + +### FetchDataResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| response | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### GovernanceFramework + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework_uri | [string](#string) | | | +| trust_registry_uri | [string](#string) | | | +| description | [string](#string) | | | + + + + + + + + +### RegisterIssuerRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| credential_type_uri | [string](#string) | | | +| valid_from_utc | [uint64](#uint64) | | | +| valid_until_utc | [uint64](#uint64) | | | +| governance_framework_uri | [string](#string) | | | +| options | [services.common.v1.RequestOptions](#services.common.v1.RequestOptions) | | | + + + + + + + + +### RegisterIssuerResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | +| response_data | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### RegisterVerifierRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| presentation_type_uri | [string](#string) | | | +| valid_from_utc | [uint64](#uint64) | | | +| valid_until_utc | [uint64](#uint64) | | | +| governance_framework_uri | [string](#string) | | | +| options | [services.common.v1.RequestOptions](#services.common.v1.RequestOptions) | | | + + + + + + + + +### RegisterVerifierResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | +| response_data | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### RemoveFrameworkRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| governance_framework | [GovernanceFramework](#services.trustregistry.v1.GovernanceFramework) | | | + + + + + + + + +### RemoveFrameworkResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### SearchRegistryRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| query | [string](#string) | | SELECT c from c where c.type == 'GovernanceFramework' | +| continuation_token | [string](#string) | | | +| options | [services.common.v1.RequestOptions](#services.common.v1.RequestOptions) | | | + + + + + + + + +### SearchRegistryResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| items | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | repeated | | +| has_more | [bool](#bool) | | | +| count | [int32](#int32) | | | +| continuation_token | [string](#string) | | | + + + + + + + + +### UnregisterIssuerRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| credential_type_uri | [string](#string) | | | +| governance_framework_uri | [string](#string) | | | + + + + + + + + +### UnregisterIssuerResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### UnregisterVerifierRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_uri | [string](#string) | | | +| x509_cert | [string](#string) | | | +| presentation_type_uri | [string](#string) | | | +| governance_framework_uri | [string](#string) | | | + + + + + + + + +### UnregisterVerifierResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + + + +### RegistrationStatus + + +| Name | Number | Description | +| ---- | ------ | ----------- | +| CURRENT | 0 | - the entity is currently authorized, as of time of the query. | +| EXPIRED | 1 | - entity rights have expired. | +| TERMINATED | 2 | - entity has voluntarily ceased Issuer role under the specific EGF. | +| REVOKED | 3 | - entity authority under specific EGF was terminated by the governing authority. | +| NOT_FOUND | 10 | | + + + + + + + + + +### TrustRegistry + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| AddFramework | [AddFrameworkRequest](#services.trustregistry.v1.AddFrameworkRequest) | [AddFrameworkResponse](#services.trustregistry.v1.AddFrameworkResponse) | Adds a trust registry defintion to the ecosystem | +| RemoveFramework | [RemoveFrameworkRequest](#services.trustregistry.v1.RemoveFrameworkRequest) | [RemoveFrameworkResponse](#services.trustregistry.v1.RemoveFrameworkResponse) | | +| SearchRegistry | [SearchRegistryRequest](#services.trustregistry.v1.SearchRegistryRequest) | [SearchRegistryResponse](#services.trustregistry.v1.SearchRegistryResponse) | | +| RegisterIssuer | [RegisterIssuerRequest](#services.trustregistry.v1.RegisterIssuerRequest) | [RegisterIssuerResponse](#services.trustregistry.v1.RegisterIssuerResponse) | Registers an authoritative issuer with a credential template | +| RegisterVerifier | [RegisterVerifierRequest](#services.trustregistry.v1.RegisterVerifierRequest) | [RegisterVerifierResponse](#services.trustregistry.v1.RegisterVerifierResponse) | Registers an authoritative verifier with a credential template | +| UnregisterIssuer | [UnregisterIssuerRequest](#services.trustregistry.v1.UnregisterIssuerRequest) | [UnregisterIssuerResponse](#services.trustregistry.v1.UnregisterIssuerResponse) | Removes an authoritative issuer with a credential template from the trust registry | +| UnregisterVerifier | [UnregisterVerifierRequest](#services.trustregistry.v1.UnregisterVerifierRequest) | [UnregisterVerifierResponse](#services.trustregistry.v1.UnregisterVerifierResponse) | Removes an authoritative verifier with a presentation template from the trust registry | +| CheckIssuerStatus | [CheckIssuerStatusRequest](#services.trustregistry.v1.CheckIssuerStatusRequest) | [CheckIssuerStatusResponse](#services.trustregistry.v1.CheckIssuerStatusResponse) | | +| CheckVerifierStatus | [CheckVerifierStatusRequest](#services.trustregistry.v1.CheckVerifierStatusRequest) | [CheckVerifierStatusResponse](#services.trustregistry.v1.CheckVerifierStatusResponse) | | +| FetchData | [FetchDataRequest](#services.trustregistry.v1.FetchDataRequest) | [FetchDataResponse](#services.trustregistry.v1.FetchDataResponse) stream | | + + + + + + +

Top

+ +## services/universal-wallet/v1/universal-wallet.proto + + + + + +### ConnectRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| email | [string](#string) | | | +| phone | [string](#string) | | | + + + + + + + + +### ConnectResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### CreateWalletRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| controller | [string](#string) | | | +| description | [string](#string) | | | +| security_code | [string](#string) | | (Optional) Supply an invitation id to associate this caller profile to an existing cloud wallet. | + + + + + + + + +### CreateWalletResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | +| wallet_id | [string](#string) | | | +| capability | [string](#string) | | | +| invoker | [string](#string) | | | + + + + + + + + +### GetProviderConfigurationRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| request_options | [services.common.v1.RequestOptions](#services.common.v1.RequestOptions) | | | + + + + + + + + +### GetProviderConfigurationResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| key_agreement_key_id | [string](#string) | | | + + + + + + + + +### GrantAccessRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wallet_id | [string](#string) | | | +| did | [string](#string) | | | + + + + + + + + +### GrantAccessResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### InsertItemRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| item | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| item_type | [string](#string) | | | + + + + + + + + +### InsertItemResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | +| item_id | [string](#string) | | | + + + + + + + + +### InvitationToken + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| security_code | [string](#string) | | | +| wallet_id | [string](#string) | | | +| email | [string](#string) | | | +| phone | [string](#string) | | | + + + + + + + + +### RevokeAccessRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| wallet_id | [string](#string) | | | +| did | [string](#string) | | | + + + + + + + + +### RevokeAccessResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### SearchRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| query | [string](#string) | | | +| continuation_token | [string](#string) | | | +| options | [services.common.v1.RequestOptions](#services.common.v1.RequestOptions) | | | + + + + + + + + +### SearchResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| items | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | repeated | | +| has_more | [bool](#bool) | | | +| count | [int32](#int32) | | | +| continuation_token | [string](#string) | | | + + + + + + + + +### WalletProfile +Stores profile data for accessing a wallet. +This result should be stored somewhere safe, +as it contains private key information. + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| did_document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| wallet_id | [string](#string) | | | +| invoker | [string](#string) | | | +| capability | [string](#string) | | | +| invoker_jwk | [bytes](#bytes) | | | + + + + + + + + + + + + + + +### Wallet + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| GetProviderConfiguration | [GetProviderConfigurationRequest](#services.universalwallet.v1.GetProviderConfigurationRequest) | [GetProviderConfigurationResponse](#services.universalwallet.v1.GetProviderConfigurationResponse) | | +| ConnectExternalIdentity | [ConnectRequest](#services.universalwallet.v1.ConnectRequest) | [ConnectResponse](#services.universalwallet.v1.ConnectResponse) | | +| CreateWallet | [CreateWalletRequest](#services.universalwallet.v1.CreateWalletRequest) | [CreateWalletResponse](#services.universalwallet.v1.CreateWalletResponse) | | +| CreateWalletWithWorkflow | [CreateWalletRequest](#services.universalwallet.v1.CreateWalletRequest) | [CreateWalletResponse](#services.universalwallet.v1.CreateWalletResponse) | | +| CreateWalletEncrypted | [.pbmse.v1.EncryptedMessage](#pbmse.v1.EncryptedMessage) | [.pbmse.v1.EncryptedMessage](#pbmse.v1.EncryptedMessage) | | +| Search | [SearchRequest](#services.universalwallet.v1.SearchRequest) | [SearchResponse](#services.universalwallet.v1.SearchResponse) | | +| InsertItem | [InsertItemRequest](#services.universalwallet.v1.InsertItemRequest) | [InsertItemResponse](#services.universalwallet.v1.InsertItemResponse) | | +| GrantAccess | [GrantAccessRequest](#services.universalwallet.v1.GrantAccessRequest) | [GrantAccessResponse](#services.universalwallet.v1.GrantAccessResponse) | | +| RevokeAccess | [RevokeAccessRequest](#services.universalwallet.v1.RevokeAccessRequest) | [RevokeAccessResponse](#services.universalwallet.v1.RevokeAccessResponse) | | + + + + + + +

Top

+ +## services/verifiable-credentials/templates/v1/templates.proto + + + + + +### CreateCredentialTemplateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| name | [string](#string) | | | +| schema | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| base_uri | [string](#string) | | | + + + + + + + + +### CreateCredentialTemplateResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| uri | [string](#string) | | | + + + + + + + + +### CredentialTemplate + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| name | [string](#string) | | | +| version | [string](#string) | | | +| schema | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| uri | [string](#string) | | | + + + + + + + + +### DeleteCredentialTemplateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### DeleteCredentialTemplateResponse + + + + + + + + + +### GetCredentialTemplateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | + + + + + + + + +### GetCredentialTemplateResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [CredentialTemplate](#services.verifiablecredentials.templates.v1.CredentialTemplate) | | | + + + + + + + + +### SearchCredentialTemplatesRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| query | [string](#string) | | SELECT * FROM c WHERE c.name = 'Diploma' | +| continuation_token | [string](#string) | | | + + + + + + + + +### SearchCredentialTemplatesResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| templates | [CredentialTemplate](#services.verifiablecredentials.templates.v1.CredentialTemplate) | repeated | | +| has_more | [bool](#bool) | | | +| count | [int32](#int32) | | | +| continuation_token | [string](#string) | | | + + + + + + + + +### UpdateCredentialTemplateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| id | [string](#string) | | | +| name | [string](#string) | | | +| schema | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### UpdateCredentialTemplateResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| template | [CredentialTemplate](#services.verifiablecredentials.templates.v1.CredentialTemplate) | | | + + + + + + + + + + + + + + +### CredentialTemplates + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Create | [CreateCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.CreateCredentialTemplateRequest) | [CreateCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.CreateCredentialTemplateResponse) | | +| Get | [GetCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.GetCredentialTemplateRequest) | [GetCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.GetCredentialTemplateResponse) | | +| Search | [SearchCredentialTemplatesRequest](#services.verifiablecredentials.templates.v1.SearchCredentialTemplatesRequest) | [SearchCredentialTemplatesResponse](#services.verifiablecredentials.templates.v1.SearchCredentialTemplatesResponse) | | +| Update | [UpdateCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.UpdateCredentialTemplateRequest) | [UpdateCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.UpdateCredentialTemplateResponse) | | +| Delete | [DeleteCredentialTemplateRequest](#services.verifiablecredentials.templates.v1.DeleteCredentialTemplateRequest) | [DeleteCredentialTemplateResponse](#services.verifiablecredentials.templates.v1.DeleteCredentialTemplateResponse) | | + + + + + + +

Top

+ +## services/verifiable-credentials/v1/verifiable-credentials.proto + + + + + +### CreateProofRequest +Create Proof + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| reveal_document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| document_id | [string](#string) | | | + + + + + + + + +### CreateProofResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| proof_document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### IssueFromTemplateRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| templateId | [string](#string) | | | +| attributes | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### IssueRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### IssueResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### SendRequest + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| email | [string](#string) | | | +| did_uri | [string](#string) | | | +| didcomm_invitation | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | +| document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### SendResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| status | [services.common.v1.ResponseStatus](#services.common.v1.ResponseStatus) | | | + + + + + + + + +### VerifyProofRequest +Verify Proof + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| proof_document | [services.common.v1.JsonPayload](#services.common.v1.JsonPayload) | | | + + + + + + + + +### VerifyProofResponse + + + +| Field | Type | Label | Description | +| ----- | ---- | ----- | ----------- | +| valid | [bool](#bool) | | | + + + + + + + + + + + + + + +### Credential + + +| Method Name | Request Type | Response Type | Description | +| ----------- | ------------ | ------------- | ------------| +| Issue | [IssueRequest](#services.verifiablecredentials.v1.IssueRequest) | [IssueResponse](#services.verifiablecredentials.v1.IssueResponse) | | +| IssueFromTemplate | [IssueFromTemplateRequest](#services.verifiablecredentials.v1.IssueFromTemplateRequest) | [IssueResponse](#services.verifiablecredentials.v1.IssueResponse) | | +| CreateProof | [CreateProofRequest](#services.verifiablecredentials.v1.CreateProofRequest) | [CreateProofResponse](#services.verifiablecredentials.v1.CreateProofResponse) | | +| VerifyProof | [VerifyProofRequest](#services.verifiablecredentials.v1.VerifyProofRequest) | [VerifyProofResponse](#services.verifiablecredentials.v1.VerifyProofResponse) | | +| Send | [SendRequest](#services.verifiablecredentials.v1.SendRequest) | [SendResponse](#services.verifiablecredentials.v1.SendResponse) | | + + + + + +## Scalar Value Types + +| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby | +| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- | +| double | | double | double | float | float64 | double | float | Float | +| float | | float | float | float | float32 | float | float | Float | +| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) | +| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) | +| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) | +| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum | +| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) | +| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum | +| bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | +| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) | +| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) | + diff --git a/mkdocs.yml b/mkdocs.yml index fa15f1456..5c211b515 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -32,6 +32,7 @@ nav: - Wallet Service: reference/services/wallet-service.md - Provider Service: reference/services/provider-service.md - Trust Registry Service: reference/services/trust-registry.md + - Protocol Buffers: reference/proto/index.md - External Resources: - Join the Community: https://join.slack.com/t/trinsiccommunity/shared_invite/zt-pcsdy7kn-h4vtdPEpqQUlmirU8FFzSQ # - Roadmap: roadmap.md TODO