From d4dc711902c49a4793eca5907e246841a3e0d4b7 Mon Sep 17 00:00:00 2001 From: ff137 Date: Sat, 27 May 2023 13:45:27 +0200 Subject: [PATCH] update openapi spec to 3.0.1 (new codegen in `scripts/generate-open-api-spec`) Signed-off-by: ff137 --- open-api/openapi.json | 21048 ++++++++++++++++++++++------------------ 1 file changed, 11706 insertions(+), 9342 deletions(-) diff --git a/open-api/openapi.json b/open-api/openapi.json index 2ee691f00d..a77d9ac129 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -1,11259 +1,13623 @@ { - "swagger" : "2.0", + "openapi" : "3.0.1", "info" : { - "version" : "v0.8.1", - "title" : "Aries Cloud Agent" + "title" : "Aries Cloud Agent", + "version" : "v0.8.1" }, + "servers" : [ { + "url" : "/" + } ], + "security" : [ { + "AuthorizationHeader" : [ ] + } ], "tags" : [ { - "name" : "action-menu", - "description" : "Menu interaction over connection" + "description" : "Menu interaction over connection", + "name" : "action-menu" }, { - "name" : "basicmessage", "description" : "Simple messaging", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0095-basic-message" - } + }, + "name" : "basicmessage" }, { - "name" : "connection", "description" : "Connection management", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/9b0aaa39df7e8bd434126c4b33c097aae78d65bf/features/0160-connection-protocol" - } + }, + "name" : "connection" }, { - "name" : "credential-definition", "description" : "Credential definition operations", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#cred_def" - } + }, + "name" : "credential-definition" }, { - "name" : "credentials", "description" : "Holder credential management", "externalDocs" : { "description" : "Overview", "url" : "https://w3c.github.io/vc-data-model/#credentials" - } + }, + "name" : "credentials" }, { - "name" : "did-exchange", "description" : "Connection management via DID exchange", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/25464a5c8f8a17b14edaa4310393df6094ace7b0/features/0023-did-exchange" - } + }, + "name" : "did-exchange" + }, { + "description" : "Feature discovery", + "externalDocs" : { + "description" : "Specification", + "url" : "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0031-discover-features" + }, + "name" : "discover-features" + }, { + "description" : "Feature discovery v2", + "externalDocs" : { + "description" : "Specification", + "url" : "https://github.com/hyperledger/aries-rfcs/tree/b3a3942ef052039e73cd23d847f42947f8287da2/features/0557-discover-features-v2" + }, + "name" : "discover-features v2.0" }, { - "name" : "endorse-transaction", - "description" : "Endorse a Transaction" + "description" : "Endorse a Transaction", + "name" : "endorse-transaction" }, { - "name" : "introduction", - "description" : "Introduction of known parties" + "description" : "Introduction of known parties", + "name" : "introduction" }, { - "name" : "issue-credential v1.0", "description" : "Credential issue v1.0", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/bb42a6c35e0d5543718fb36dd099551ab192f7b0/features/0036-issue-credential" - } + }, + "name" : "issue-credential v1.0" }, { - "name" : "issue-credential v2.0", "description" : "Credential issue v2.0", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/cd27fc64aa2805f756a118043d7c880354353047/features/0453-issue-credential-v2" - } + }, + "name" : "issue-credential v2.0" }, { - "name" : "jsonld", "description" : "Sign and verify json-ld data", "externalDocs" : { "description" : "Specification", "url" : "https://tools.ietf.org/html/rfc7515" - } + }, + "name" : "jsonld" }, { - "name" : "ledger", "description" : "Interaction with ledger", "externalDocs" : { "description" : "Overview", "url" : "https://hyperledger-indy.readthedocs.io/projects/plenum/en/latest/storage.html#ledger" - } + }, + "name" : "ledger" }, { - "name" : "mediation", "description" : "Mediation management", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/fa8dc4ea1e667eb07db8f9ffeaf074a4455697c0/features/0211-route-coordination" - } + }, + "name" : "mediation" }, { - "name" : "multitenancy", - "description" : "Multitenant wallet management" + "description" : "Multitenant wallet management", + "name" : "multitenancy" }, { - "name" : "out-of-band", "description" : "Out-of-band connections", "externalDocs" : { "description" : "Design", "url" : "https://github.com/hyperledger/aries-rfcs/tree/2da7fc4ee043effa3a9960150e7ba8c9a4628b68/features/0434-outofband" - } + }, + "name" : "out-of-band" }, { - "name" : "present-proof v1.0", "description" : "Proof presentation v1.0", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/4fae574c03f9f1013db30bf2c0c676b1122f7149/features/0037-present-proof" - } + }, + "name" : "present-proof v1.0" }, { - "name" : "present-proof v2.0", "description" : "Proof presentation v2.0", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/eace815c3e8598d4a8dd7881d8c731fdb2bcc0aa/features/0454-present-proof-v2" - } + }, + "name" : "present-proof v2.0" }, { - "name" : "resolver", - "description" : "DID resolver interface", + "description" : "did resolver interface.", "externalDocs" : { - "description" : "Specification", - "url" : "https://github.com/hyperledger/aries-rfcs/tree/fa4b1947c6077168d2c69f45ed6bee2bb1eae4c8/features/0124-did-resolution-protocol" - } + "description" : "Specification" + }, + "name" : "resolver" }, { - "name" : "revocation", "description" : "Revocation registry management", "externalDocs" : { "description" : "Overview", "url" : "https://github.com/hyperledger/indy-hipe/tree/master/text/0011-cred-revocation" - } + }, + "name" : "revocation" }, { - "name" : "schema", "description" : "Schema operations", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/indy-node/blob/master/design/anoncreds.md#schema" - } - }, { - "name" : "server", - "description" : "Feature discovery", - "externalDocs" : { - "description" : "Specification", - "url" : "https://github.com/hyperledger/aries-rfcs/tree/9b7ab9814f2e7d1108f74aca6f3d2e5d62899473/features/0031-discover-features" - } + }, + "name" : "schema" }, { - "name" : "trustping", "description" : "Trust-ping over connection", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/527849ec3aa2a8fd47a7bb6c57f918ff8bcb5e8c/features/0048-trust-ping" - } + }, + "name" : "trustping" }, { - "name" : "wallet", "description" : "DID and tag policy management", "externalDocs" : { "description" : "Design", "url" : "https://github.com/hyperledger/indy-sdk/tree/master/docs/design/003-wallet-storage" - } - } ], - "security" : [ { - "AuthorizationHeader" : [ ] + }, + "name" : "wallet" } ], "paths" : { "/action-menu/{conn_id}/close" : { "post" : { - "tags" : [ "action-menu" ], - "summary" : "Close the active menu associated with a connection", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ActionMenuModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActionMenuModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Close the active menu associated with a connection", + "tags" : [ "action-menu" ] } }, "/action-menu/{conn_id}/fetch" : { "post" : { - "tags" : [ "action-menu" ], - "summary" : "Fetch the active menu", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ActionMenuFetchResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActionMenuFetchResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the active menu", + "tags" : [ "action-menu" ] } }, "/action-menu/{conn_id}/perform" : { "post" : { - "tags" : [ "action-menu" ], - "summary" : "Perform an action associated with the active menu", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/PerformRequest" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/PerformRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ActionMenuModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActionMenuModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Perform an action associated with the active menu", + "tags" : [ "action-menu" ], + "x-codegen-request-body-name" : "body" } }, "/action-menu/{conn_id}/request" : { "post" : { - "tags" : [ "action-menu" ], - "summary" : "Request the active menu", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ActionMenuModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActionMenuModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Request the active menu", + "tags" : [ "action-menu" ] } }, "/action-menu/{conn_id}/send-menu" : { "post" : { - "tags" : [ "action-menu" ], - "summary" : "Send an action menu to a connection", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/SendMenu" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/SendMenu" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ActionMenuModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ActionMenuModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send an action menu to a connection", + "tags" : [ "action-menu" ], + "x-codegen-request-body-name" : "body" } }, "/connections" : { "get" : { - "tags" : [ "connection" ], - "summary" : "Query agent-to-agent connections", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "alias", - "in" : "query", "description" : "Alias", - "required" : false, - "type" : "string" - }, { - "name" : "connection_protocol", "in" : "query", - "description" : "Connection protocol used", - "required" : false, - "type" : "string", - "enum" : [ "connections/1.0", "didexchange/1.0" ] + "name" : "alias", + "schema" : { + "type" : "string" + } }, { - "name" : "invitation_key", + "description" : "Connection protocol used", "in" : "query", + "name" : "connection_protocol", + "schema" : { + "enum" : [ "connections/1.0", "didexchange/1.0" ], + "type" : "string" + } + }, { "description" : "invitation key", - "required" : false, - "type" : "string", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "in" : "query", + "name" : "invitation_key", + "schema" : { + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } }, { - "name" : "my_did", + "description" : "Identifier of the associated Invitation Mesage", "in" : "query", - "description" : "My DID", - "required" : false, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "name" : "invitation_msg_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } }, { - "name" : "state", + "description" : "My DID", "in" : "query", - "description" : "Connection state", - "required" : false, - "type" : "string", - "enum" : [ "start", "abandoned", "active", "completed", "response", "init", "invitation", "error", "request" ] + "name" : "my_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "their_did", + "description" : "Connection state", "in" : "query", + "name" : "state", + "schema" : { + "enum" : [ "start", "invitation", "request", "abandoned", "error", "init", "response", "active", "completed" ], + "type" : "string" + } + }, { "description" : "Their DID", - "required" : false, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "in" : "query", + "name" : "their_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "their_role", + "description" : "Their Public DID", "in" : "query", + "name" : "their_public_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } + }, { "description" : "Their role in the connection protocol", - "required" : false, - "type" : "string", - "enum" : [ "invitee", "requester", "inviter", "responder" ] + "in" : "query", + "name" : "their_role", + "schema" : { + "enum" : [ "invitee", "requester", "inviter", "responder" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query agent-to-agent connections", + "tags" : [ "connection" ] } }, "/connections/create-invitation" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Create a new connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Alias", + "in" : "query", + "name" : "alias", "schema" : { - "$ref" : "#/definitions/CreateInvitationRequest" + "type" : "string" } }, { - "name" : "alias", + "description" : "Auto-accept connection (defaults to configuration)", "in" : "query", - "description" : "Alias", - "required" : false, - "type" : "string" - }, { "name" : "auto_accept", - "in" : "query", - "description" : "Auto-accept connection (defaults to configuration)", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } }, { - "name" : "multi_use", - "in" : "query", "description" : "Create invitation for multiple use (default false)", - "required" : false, - "type" : "boolean" - }, { - "name" : "public", "in" : "query", + "name" : "multi_use", + "schema" : { + "type" : "boolean" + } + }, { "description" : "Create invitation from public DID (default false)", - "required" : false, - "type" : "boolean" + "in" : "query", + "name" : "public", + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/CreateInvitationRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/InvitationResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/InvitationResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a new connection invitation", + "tags" : [ "connection" ], + "x-codegen-request-body-name" : "body" } }, "/connections/create-static" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Create a new static connection", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ConnectionStaticRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionStaticRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionStaticResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionStaticResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a new static connection", + "tags" : [ "connection" ], + "x-codegen-request-body-name" : "body" } }, "/connections/receive-invitation" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Receive a new connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Alias", + "in" : "query", + "name" : "alias", "schema" : { - "$ref" : "#/definitions/ReceiveInvitationRequest" + "type" : "string" } }, { - "name" : "alias", + "description" : "Auto-accept connection (defaults to configuration)", "in" : "query", - "description" : "Alias", - "required" : false, - "type" : "string" - }, { "name" : "auto_accept", - "in" : "query", - "description" : "Auto-accept connection (defaults to configuration)", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } }, { - "name" : "mediation_id", - "in" : "query", "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "in" : "query", + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ReceiveInvitationRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Receive a new connection invitation", + "tags" : [ "connection" ], + "x-codegen-request-body-name" : "body" } }, "/connections/{conn_id}" : { - "get" : { - "tags" : [ "connection" ], - "summary" : "Fetch a single connection record", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "connection" ], + }, "summary" : "Remove an existing connection record", - "produces" : [ "application/json" ], + "tags" : [ "connection" ] + }, + "get" : { "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single connection record", + "tags" : [ "connection" ] } }, "/connections/{conn_id}/accept-invitation" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Accept a stored connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "mediation_id", - "in" : "query", "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, { - "name" : "my_endpoint", "in" : "query", - "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } }, { - "name" : "my_label", + "description" : "My URL endpoint", "in" : "query", + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } + }, { "description" : "Label for connection", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "my_label", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Accept a stored connection invitation", + "tags" : [ "connection" ] } }, "/connections/{conn_id}/accept-request" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Accept a stored connection request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "my_endpoint", - "in" : "query", "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "in" : "query", + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Accept a stored connection request", + "tags" : [ "connection" ] } }, "/connections/{conn_id}/endpoints" : { "get" : { - "tags" : [ "connection" ], - "summary" : "Fetch connection remote endpoint", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/EndpointsResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EndpointsResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch connection remote endpoint", + "tags" : [ "connection" ] } }, "/connections/{conn_id}/establish-inbound/{ref_id}" : { "post" : { - "tags" : [ "connection" ], - "summary" : "Assign another connection as the inbound connection", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "ref_id", - "in" : "path", "description" : "Inbound connection identifier", + "in" : "path", + "name" : "ref_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Assign another connection as the inbound connection", + "tags" : [ "connection" ] } }, "/connections/{conn_id}/metadata" : { "get" : { - "tags" : [ "connection" ], - "summary" : "Fetch connection metadata", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "key", - "in" : "query", "description" : "Key to retrieve.", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "key", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionMetadata" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionMetadata" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch connection metadata", + "tags" : [ "connection" ] }, "post" : { - "tags" : [ "connection" ], - "summary" : "Set connection metadata", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ConnectionMetadataSetRequest" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionMetadataSetRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnectionMetadata" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnectionMetadata" + } + } + }, + "description" : "" } - } + }, + "summary" : "Set connection metadata", + "tags" : [ "connection" ], + "x-codegen-request-body-name" : "body" } }, "/connections/{conn_id}/send-message" : { "post" : { - "tags" : [ "basicmessage" ], - "summary" : "Send a basic message to a connection", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/SendMessage" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/SendMessage" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/BasicMessageModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/BasicMessageModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a basic message to a connection", + "tags" : [ "basicmessage" ], + "x-codegen-request-body-name" : "body" } }, "/connections/{conn_id}/send-ping" : { "post" : { - "tags" : [ "trustping" ], - "summary" : "Send a trust ping to a connection", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/PingRequest" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/PingRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/PingRequestResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PingRequestResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a trust ping to a connection", + "tags" : [ "trustping" ], + "x-codegen-request-body-name" : "body" } }, "/connections/{conn_id}/start-introduction" : { "post" : { - "tags" : [ "introduction" ], - "summary" : "Start an introduction between two connections", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "target_connection_id", - "in" : "query", "description" : "Target connection identifier", + "in" : "query", + "name" : "target_connection_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "message", - "in" : "query", "description" : "Message", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "message", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/IntroModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IntroModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Start an introduction between two connections", + "tags" : [ "introduction" ] } }, "/credential-definitions" : { "post" : { - "tags" : [ "credential-definition" ], - "summary" : "Sends a credential definition to the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Connection identifier", + "in" : "query", + "name" : "conn_id", "schema" : { - "$ref" : "#/definitions/CredentialDefinitionSendRequest" + "type" : "string" } }, { - "name" : "conn_id", + "description" : "Create Transaction For Endorser's signature", "in" : "query", - "description" : "Connection identifier", - "required" : false, - "type" : "string" - }, { "name" : "create_transaction_for_endorser", - "in" : "query", - "description" : "Create Transaction For Endorser's signature", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/CredentialDefinitionSendRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/TxnOrCredentialDefinitionSendResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TxnOrCredentialDefinitionSendResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a credential definition to the ledger", + "tags" : [ "credential-definition" ], + "x-codegen-request-body-name" : "body" } }, "/credential-definitions/created" : { "get" : { - "tags" : [ "credential-definition" ], - "summary" : "Search for matching credential definitions that agent originated", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_def_id", - "in" : "query", "description" : "Credential definition id", - "required" : false, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, { - "name" : "issuer_did", "in" : "query", - "description" : "Issuer DID", - "required" : false, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "name" : "cred_def_id", + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + } }, { - "name" : "schema_id", + "description" : "Issuer DID", "in" : "query", - "description" : "Schema identifier", - "required" : false, - "type" : "string", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" + "name" : "issuer_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "schema_issuer_did", + "description" : "Schema identifier", "in" : "query", - "description" : "Schema issuer DID", - "required" : false, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "name" : "schema_id", + "schema" : { + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } }, { - "name" : "schema_name", + "description" : "Schema issuer DID", "in" : "query", - "description" : "Schema name", - "required" : false, - "type" : "string" + "name" : "schema_issuer_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "schema_version", + "description" : "Schema name", "in" : "query", + "name" : "schema_name", + "schema" : { + "type" : "string" + } + }, { "description" : "Schema version", - "required" : false, - "type" : "string", - "pattern" : "^[0-9.]+$" + "in" : "query", + "name" : "schema_version", + "schema" : { + "pattern" : "^[0-9.]+$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredentialDefinitionsCreatedResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredentialDefinitionsCreatedResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Search for matching credential definitions that agent originated", + "tags" : [ "credential-definition" ] } }, "/credential-definitions/{cred_def_id}" : { "get" : { - "tags" : [ "credential-definition" ], - "summary" : "Gets a credential definition from the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_def_id", - "in" : "path", "description" : "Credential definition identifier", + "in" : "path", + "name" : "cred_def_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredentialDefinitionGetResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredentialDefinitionGetResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Gets a credential definition from the ledger", + "tags" : [ "credential-definition" ] } }, "/credential-definitions/{cred_def_id}/write_record" : { "post" : { - "tags" : [ "credential-definition" ], - "summary" : "Writes a credential definition non-secret record to the wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_def_id", - "in" : "path", "description" : "Credential definition identifier", + "in" : "path", + "name" : "cred_def_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredentialDefinitionGetResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredentialDefinitionGetResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Writes a credential definition non-secret record to the wallet", + "tags" : [ "credential-definition" ] } }, "/credential/mime-types/{credential_id}" : { "get" : { - "tags" : [ "credentials" ], - "summary" : "Get attribute MIME types from wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AttributeMimeTypesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AttributeMimeTypesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get attribute MIME types from wallet", + "tags" : [ "credentials" ] } }, "/credential/revoked/{credential_id}" : { "get" : { - "tags" : [ "credentials" ], - "summary" : "Query credential revocation status by id", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "from", - "in" : "query", "description" : "Earliest epoch of revocation status interval of interest", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" - }, { - "name" : "to", "in" : "query", + "name" : "from", + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } + }, { "description" : "Latest epoch of revocation status interval of interest", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" + "in" : "query", + "name" : "to", + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredRevokedResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredRevokedResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query credential revocation status by id", + "tags" : [ "credentials" ] } }, "/credential/w3c/{credential_id}" : { - "get" : { - "tags" : [ "credentials" ], - "summary" : "Fetch W3C credential from wallet by id", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/VCRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/HolderModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "credentials" ], + }, "summary" : "Remove W3C credential from wallet by id", - "produces" : [ "application/json" ], + "tags" : [ "credentials" ] + }, + "get" : { "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/HolderModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VCRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch W3C credential from wallet by id", + "tags" : [ "credentials" ] } }, "/credential/{credential_id}" : { - "get" : { - "tags" : [ "credentials" ], - "summary" : "Fetch credential from wallet by id", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/IndyCredInfo" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/HolderModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "credentials" ], + }, "summary" : "Remove credential from wallet by id", - "produces" : [ "application/json" ], + "tags" : [ "credentials" ] + }, + "get" : { "parameters" : [ { - "name" : "credential_id", - "in" : "path", "description" : "Credential identifier", + "in" : "path", + "name" : "credential_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/HolderModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IndyCredInfo" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch credential from wallet by id", + "tags" : [ "credentials" ] } }, "/credentials" : { "get" : { - "tags" : [ "credentials" ], - "summary" : "Fetch credentials from wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "count", - "in" : "query", "description" : "Maximum number to retrieve", - "required" : false, - "type" : "string", - "pattern" : "^[1-9][0-9]*$" - }, { - "name" : "start", "in" : "query", - "description" : "Start index", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" + "name" : "count", + "schema" : { + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + } }, { - "name" : "wql", + "description" : "Start index", "in" : "query", + "name" : "start", + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } + }, { "description" : "(JSON) WQL query", - "required" : false, - "type" : "string", - "pattern" : "^{.*}$" + "in" : "query", + "name" : "wql", + "schema" : { + "pattern" : "^{.*}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredInfoList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredInfoList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch credentials from wallet", + "tags" : [ "credentials" ] } }, "/credentials/w3c" : { "post" : { - "tags" : [ "credentials" ], - "summary" : "Fetch W3C credentials from wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Maximum number to retrieve", + "in" : "query", + "name" : "count", "schema" : { - "$ref" : "#/definitions/W3CCredentialsListRequest" + "pattern" : "^[1-9][0-9]*$", + "type" : "string" } }, { - "name" : "count", + "description" : "Start index", "in" : "query", - "description" : "Maximum number to retrieve", - "required" : false, - "type" : "string", - "pattern" : "^[1-9][0-9]*$" - }, { "name" : "start", - "in" : "query", - "description" : "Start index", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } }, { - "name" : "wql", - "in" : "query", "description" : "(JSON) WQL query", - "required" : false, - "type" : "string", - "pattern" : "^{.*}$" + "in" : "query", + "name" : "wql", + "schema" : { + "pattern" : "^{.*}$", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/W3CCredentialsListRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/VCRecordList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VCRecordList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch W3C credentials from wallet", + "tags" : [ "credentials" ], + "x-codegen-request-body-name" : "body" } }, "/didexchange/create-request" : { "post" : { - "tags" : [ "did-exchange" ], - "summary" : "Create and send a request against public DID's implicit invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "their_public_did", - "in" : "query", "description" : "Qualified public DID to which to request connection", + "in" : "query", + "name" : "their_public_did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type" : "string" + } }, { - "name" : "mediation_id", + "description" : "Alias for connection", "in" : "query", - "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "name" : "alias", + "schema" : { + "type" : "string" + } }, { - "name" : "my_endpoint", + "description" : "Identifier for active mediation record to be used", "in" : "query", - "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } }, { - "name" : "my_label", + "description" : "My URL endpoint", "in" : "query", - "description" : "Label for connection request", - "required" : false, - "type" : "string" + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } }, { - "name" : "use_public_did", + "description" : "Label for connection request", "in" : "query", + "name" : "my_label", + "schema" : { + "type" : "string" + } + }, { "description" : "Use public DID for this connection", - "required" : false, - "type" : "boolean" + "in" : "query", + "name" : "use_public_did", + "schema" : { + "type" : "boolean" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create and send a request against public DID's implicit invitation", + "tags" : [ "did-exchange" ] } }, "/didexchange/receive-request" : { "post" : { - "tags" : [ "did-exchange" ], - "summary" : "Receive request against public DID's implicit invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Alias for connection", + "in" : "query", + "name" : "alias", "schema" : { - "$ref" : "#/definitions/DIDXRequest" + "type" : "string" } }, { - "name" : "alias", + "description" : "Auto-accept connection (defaults to configuration)", "in" : "query", - "description" : "Alias for connection", - "required" : false, - "type" : "string" - }, { "name" : "auto_accept", - "in" : "query", - "description" : "Auto-accept connection (defaults to configuration)", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } }, { - "name" : "mediation_id", - "in" : "query", "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, { - "name" : "my_endpoint", "in" : "query", + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } + }, { "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "in" : "query", + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/DIDXRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Receive request against public DID's implicit invitation", + "tags" : [ "did-exchange" ], + "x-codegen-request-body-name" : "body" } }, "/didexchange/{conn_id}/accept-invitation" : { "post" : { - "tags" : [ "did-exchange" ], - "summary" : "Accept a stored connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "my_endpoint", - "in" : "query", "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, { - "name" : "my_label", "in" : "query", + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } + }, { "description" : "Label for connection request", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "my_label", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Accept a stored connection invitation", + "tags" : [ "did-exchange" ] } }, "/didexchange/{conn_id}/accept-request" : { "post" : { - "tags" : [ "did-exchange" ], - "summary" : "Accept a stored connection request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "mediation_id", - "in" : "query", "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, { - "name" : "my_endpoint", "in" : "query", + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } + }, { "description" : "My URL endpoint", - "required" : false, - "type" : "string", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "in" : "query", + "name" : "my_endpoint", + "schema" : { + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ConnRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Accept a stored connection request", + "tags" : [ "did-exchange" ] } }, - "/features" : { + "/discover-features-2.0/queries" : { "get" : { - "tags" : [ "server" ], - "summary" : "Query supported features", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "query", + "description" : "Connection identifier, if none specified, then the query will provide features for this agent.", "in" : "query", - "description" : "Query", - "required" : false, - "type" : "string" - } ], - "responses" : { - "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/QueryResult" - } + "name" : "connection_id", + "schema" : { + "type" : "string" } - } - } - }, - "/issue-credential-2.0/create" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Create credential from attribute values", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + }, { + "description" : "Goal-code feature-type query", + "in" : "query", + "name" : "query_goal_code", + "schema" : { + "type" : "string" + } + }, { + "description" : "Protocol feature-type query", + "in" : "query", + "name" : "query_protocol", "schema" : { - "$ref" : "#/definitions/V20IssueCredSchemaCore" + "type" : "string" } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20DiscoveryExchangeResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query supported features", + "tags" : [ "discover-features v2.0" ] } }, - "/issue-credential-2.0/create-offer" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Create a credential offer, independent of any proposal or connection", - "produces" : [ "application/json" ], + "/discover-features-2.0/records" : { + "get" : { "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Connection identifier", + "in" : "query", + "name" : "connection_id", "schema" : { - "$ref" : "#/definitions/V20CredOfferConnFreeRequest" + "type" : "string" } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20DiscoveryExchangeListResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Discover Features v2.0 records", + "tags" : [ "discover-features v2.0" ] } }, - "/issue-credential-2.0/records" : { + "/discover-features/query" : { "get" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Fetch all credential exchange records", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "connection_id", - "in" : "query", - "description" : "Connection identifier", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "role", + "description" : "Comment", "in" : "query", - "description" : "Role assigned in credential exchange", - "required" : false, - "type" : "string", - "enum" : [ "issuer", "holder" ] + "name" : "comment", + "schema" : { + "type" : "string" + } }, { - "name" : "state", + "description" : "Connection identifier, if none specified, then the query will provide features for this agent.", "in" : "query", - "description" : "Credential exchange state", - "required" : false, - "type" : "string", - "enum" : [ "proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done" ] + "name" : "connection_id", + "schema" : { + "type" : "string" + } }, { - "name" : "thread_id", + "description" : "Protocol feature query", "in" : "query", - "description" : "Thread identifier", - "required" : false, - "type" : "string", - "format" : "uuid" + "name" : "query", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecordListResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10DiscoveryRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query supported features", + "tags" : [ "discover-features" ] } }, - "/issue-credential-2.0/records/{cred_ex_id}" : { + "/discover-features/records" : { "get" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Fetch a single credential exchange record", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_ex_id", - "in" : "path", - "description" : "Credential exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "description" : "Connection identifier", + "in" : "query", + "name" : "connection_id", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecordDetail" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10DiscoveryExchangeListResult" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Remove an existing credential exchange record", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "cred_ex_id", - "in" : "path", - "description" : "Credential exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - } ], + }, + "summary" : "Discover Features records", + "tags" : [ "discover-features" ] + } + }, + "/issue-credential-2.0/create" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20IssueCredSchemaCore" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20IssueCredentialModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a credential record without sending (generally for use with Out-Of-Band)", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential-2.0/records/{cred_ex_id}/issue" : { + "/issue-credential-2.0/create-offer" : { "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send holder a credential", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20CredIssueRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", - "description" : "Credential exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredOfferConnFreeRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecordDetail" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a credential offer, independent of any proposal or connection", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential-2.0/records/{cred_ex_id}/problem-report" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send a problem report for credential exchange", - "produces" : [ "application/json" ], + "/issue-credential-2.0/records" : { + "get" : { "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Connection identifier", + "in" : "query", + "name" : "connection_id", "schema" : { - "$ref" : "#/definitions/V20CredIssueProblemReportRequest" + "format" : "uuid", + "type" : "string" } }, { - "name" : "cred_ex_id", - "in" : "path", - "description" : "Credential exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - } ], - "responses" : { - "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20IssueCredentialModuleResponse" - } + "description" : "Role assigned in credential exchange", + "in" : "query", + "name" : "role", + "schema" : { + "enum" : [ "issuer", "holder" ], + "type" : "string" } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/send-offer" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send holder a credential offer in reference to a proposal with preview", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + }, { + "description" : "Credential exchange state", + "in" : "query", + "name" : "state", "schema" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest" + "enum" : [ "proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned" ], + "type" : "string" } }, { - "name" : "cred_ex_id", - "in" : "path", - "description" : "Credential exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "description" : "Thread identifier", + "in" : "query", + "name" : "thread_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecordListResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch all credential exchange records", + "tags" : [ "issue-credential v2.0" ] } }, - "/issue-credential-2.0/records/{cred_ex_id}/send-request" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send issuer a credential request", - "produces" : [ "application/json" ], + "/issue-credential-2.0/records/{cred_ex_id}" : { + "delete" : { "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20CredRequestRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20IssueCredentialModuleResponse" + } + } + }, + "description" : "" } - } - } - }, - "/issue-credential-2.0/records/{cred_ex_id}/store" : { - "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Store a received credential", - "produces" : [ "application/json" ], + }, + "summary" : "Remove an existing credential exchange record", + "tags" : [ "issue-credential v2.0" ] + }, + "get" : { "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20CredStoreRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecordDetail" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecordDetail" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single credential exchange record", + "tags" : [ "issue-credential v2.0" ] } }, - "/issue-credential-2.0/send" : { + "/issue-credential-2.0/records/{cred_ex_id}/issue" : { "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send holder a credential, automating entire flow", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V20CredExFree" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredIssueRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecordDetail" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential-2.0/send-offer" : { + "/issue-credential-2.0/records/{cred_ex_id}/problem-report" : { "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send holder a credential offer, independent of any proposal", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V20CredOfferRequest" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredIssueProblemReportRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20IssueCredentialModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a problem report for credential exchange", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential-2.0/send-proposal" : { + "/issue-credential-2.0/records/{cred_ex_id}/send-offer" : { "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send issuer a credential proposal", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V20CredExFree" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential offer in reference to a proposal with preview", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential-2.0/send-request" : { + "/issue-credential-2.0/records/{cred_ex_id}/send-request" : { "post" : { - "tags" : [ "issue-credential v2.0" ], - "summary" : "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V20CredRequestFree" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredRequestRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20CredExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send issuer a credential request", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential/create" : { + "/issue-credential-2.0/records/{cred_ex_id}/store" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send holder a credential, automating entire flow", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V10CredentialCreate" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredStoreRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecordDetail" + } + } + }, + "description" : "" } - } + }, + "summary" : "Store a received credential", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential/create-offer" : { + "/issue-credential-2.0/send" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Create a credential offer, independent of any proposal or connection", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialConnFreeOfferRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExFree" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential, automating entire flow", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" } }, - "/issue-credential/records" : { - "get" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Fetch all credential exchange records", - "produces" : [ "application/json" ], - "parameters" : [ { - "name" : "connection_id", - "in" : "query", + "/issue-credential-2.0/send-offer" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredOfferRequest" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" + } + }, + "summary" : "Send holder a credential offer, independent of any proposal", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" + } + }, + "/issue-credential-2.0/send-proposal" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExFree" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" + } + }, + "summary" : "Send issuer a credential proposal", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" + } + }, + "/issue-credential-2.0/send-request" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredRequestFree" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20CredExRecord" + } + } + }, + "description" : "" + } + }, + "summary" : "Send issuer a credential request not bound to an existing thread. Indy credentials cannot start at a request", + "tags" : [ "issue-credential v2.0" ], + "x-codegen-request-body-name" : "body" + } + }, + "/issue-credential/create" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialCreate" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" + } + }, + "summary" : "Create a credential record without sending (generally for use with Out-Of-Band)", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" + } + }, + "/issue-credential/create-offer" : { + "post" : { + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialConnFreeOfferRequest" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" + } + }, + "summary" : "Create a credential offer, independent of any proposal or connection", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" + } + }, + "/issue-credential/records" : { + "get" : { + "parameters" : [ { "description" : "Connection identifier", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "role", "in" : "query", - "description" : "Role assigned in credential exchange", - "required" : false, - "type" : "string", - "enum" : [ "issuer", "holder" ] + "name" : "connection_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } }, { - "name" : "state", + "description" : "Role assigned in credential exchange", "in" : "query", - "description" : "Credential exchange state", - "required" : false, - "type" : "string", - "enum" : [ "proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked" ] + "name" : "role", + "schema" : { + "enum" : [ "issuer", "holder" ], + "type" : "string" + } }, { - "name" : "thread_id", + "description" : "Credential exchange state", "in" : "query", + "name" : "state", + "schema" : { + "enum" : [ "proposal_sent", "proposal_received", "offer_sent", "offer_received", "request_sent", "request_received", "credential_issued", "credential_received", "credential_acked", "credential_revoked", "abandoned" ], + "type" : "string" + } + }, { "description" : "Thread identifier", - "required" : false, - "type" : "string", - "format" : "uuid" + "in" : "query", + "name" : "thread_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchangeListResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchangeListResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch all credential exchange records", + "tags" : [ "issue-credential v1.0" ] } }, "/issue-credential/records/{cred_ex_id}" : { - "get" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Fetch a single credential exchange record", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IssueCredentialModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "issue-credential v1.0" ], + }, "summary" : "Remove an existing credential exchange record", - "produces" : [ "application/json" ], + "tags" : [ "issue-credential v1.0" ] + }, + "get" : { "parameters" : [ { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/IssueCredentialModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single credential exchange record", + "tags" : [ "issue-credential v1.0" ] } }, "/issue-credential/records/{cred_ex_id}/issue" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send holder a credential", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialIssueRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialIssueRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/records/{cred_ex_id}/problem-report" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send a problem report for credential exchange", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialProblemReportRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialProblemReportRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/IssueCredentialModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/IssueCredentialModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a problem report for credential exchange", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/records/{cred_ex_id}/send-offer" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send holder a credential offer in reference to a proposal with preview", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialBoundOfferRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialBoundOfferRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential offer in reference to a proposal with preview", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/records/{cred_ex_id}/send-request" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send issuer a credential request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send issuer a credential request", + "tags" : [ "issue-credential v1.0" ] } }, "/issue-credential/records/{cred_ex_id}/store" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Store a received credential", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialStoreRequest" - } - }, { - "name" : "cred_ex_id", - "in" : "path", "description" : "Credential exchange identifier", + "in" : "path", + "name" : "cred_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialStoreRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Store a received credential", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/send" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send holder a credential, automating entire flow", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialProposalRequestMand" - } - } ], - "responses" : { - "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialProposalRequestMand" + } } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential, automating entire flow", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/send-offer" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send holder a credential offer, independent of any proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialFreeOfferRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialFreeOfferRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send holder a credential offer, independent of any proposal", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/issue-credential/send-proposal" : { "post" : { - "tags" : [ "issue-credential v1.0" ], - "summary" : "Send issuer a credential proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10CredentialProposalRequestOpt" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialProposalRequestOpt" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10CredentialExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send issuer a credential proposal", + "tags" : [ "issue-credential v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/jsonld/sign" : { "post" : { - "tags" : [ "jsonld" ], - "summary" : "Sign a JSON-LD structure and return it", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/SignRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/SignRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/SignResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SignResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sign a JSON-LD structure and return it", + "tags" : [ "jsonld" ], + "x-codegen-request-body-name" : "body" } }, "/jsonld/verify" : { "post" : { - "tags" : [ "jsonld" ], - "summary" : "Verify a JSON-LD structure.", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/VerifyRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/VerifyResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/VerifyResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Verify a JSON-LD structure.", + "tags" : [ "jsonld" ], + "x-codegen-request-body-name" : "body" } }, "/ledger/did-endpoint" : { "get" : { - "tags" : [ "ledger" ], - "summary" : "Get the endpoint for a DID from the ledger.", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "endpoint_type", - "in" : "query", "description" : "Endpoint type of interest (default 'Endpoint')", - "required" : false, - "type" : "string", - "enum" : [ "Endpoint", "Profile", "LinkedDomains" ] + "in" : "query", + "name" : "endpoint_type", + "schema" : { + "enum" : [ "Endpoint", "Profile", "LinkedDomains" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/GetDIDEndpointResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetDIDEndpointResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get the endpoint for a DID from the ledger.", + "tags" : [ "ledger" ] } }, "/ledger/did-verkey" : { "get" : { - "tags" : [ "ledger" ], - "summary" : "Get the verkey for a DID from the ledger.", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/GetDIDVerkeyResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetDIDVerkeyResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get the verkey for a DID from the ledger.", + "tags" : [ "ledger" ] } }, "/ledger/get-nym-role" : { "get" : { - "tags" : [ "ledger" ], - "summary" : "Get the role from the NYM registration of a public DID.", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/GetNymRoleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GetNymRoleResponse" + } + } + }, + "description" : "" + } + }, + "summary" : "Get the role from the NYM registration of a public DID.", + "tags" : [ "ledger" ] + } + }, + "/ledger/multiple/config" : { + "get" : { + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LedgerConfigList" + } + } + }, + "description" : "" + } + }, + "summary" : "Fetch the multiple ledger configuration currently in use", + "tags" : [ "ledger" ] + } + }, + "/ledger/multiple/get-write-ledger" : { + "get" : { + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WriteLedgerRequest" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the current write ledger", + "tags" : [ "ledger" ] } }, "/ledger/register-nym" : { "post" : { - "tags" : [ "ledger" ], - "summary" : "Send a NYM registration to the ledger.", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID to register", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } }, { - "name" : "verkey", - "in" : "query", "description" : "Verification key", + "in" : "query", + "name" : "verkey", "required" : true, - "type" : "string", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "schema" : { + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } }, { + "description" : "Alias", + "in" : "query", "name" : "alias", + "schema" : { + "type" : "string" + } + }, { + "description" : "Connection identifier", "in" : "query", - "description" : "Alias", - "required" : false, - "type" : "string" + "name" : "conn_id", + "schema" : { + "type" : "string" + } }, { - "name" : "role", + "description" : "Create Transaction For Endorser's signature", "in" : "query", + "name" : "create_transaction_for_endorser", + "schema" : { + "type" : "boolean" + } + }, { "description" : "Role", - "required" : false, - "type" : "string", - "enum" : [ "STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset" ] + "in" : "query", + "name" : "role", + "schema" : { + "enum" : [ "STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "reset" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RegisterLedgerNymResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TxnOrRegisterLedgerNymResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a NYM registration to the ledger.", + "tags" : [ "ledger" ] } }, "/ledger/rotate-public-did-keypair" : { "patch" : { - "tags" : [ "ledger" ], - "summary" : "Rotate key pair for public DID.", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/LedgerModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LedgerModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Rotate key pair for public DID.", + "tags" : [ "ledger" ] } }, "/ledger/taa" : { "get" : { - "tags" : [ "ledger" ], - "summary" : "Fetch the current transaction author agreement, if any", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/TAAResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TAAResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the current transaction author agreement, if any", + "tags" : [ "ledger" ] } }, "/ledger/taa/accept" : { "post" : { - "tags" : [ "ledger" ], - "summary" : "Accept the transaction author agreement", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/TAAAccept" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/TAAAccept" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/LedgerModulesResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LedgerModulesResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Accept the transaction author agreement", + "tags" : [ "ledger" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/default-mediator" : { - "get" : { - "tags" : [ "mediation" ], - "summary" : "Get default mediator", - "produces" : [ "application/json" ], - "parameters" : [ ], + "delete" : { "responses" : { - "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "201" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "mediation" ], + }, "summary" : "Clear default mediator", - "produces" : [ "application/json" ], - "parameters" : [ ], + "tags" : [ "mediation" ] + }, + "get" : { "responses" : { - "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get default mediator", + "tags" : [ "mediation" ] } }, "/mediation/keylists" : { "get" : { - "tags" : [ "mediation" ], - "summary" : "Retrieve keylists by connection or role", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "query", "description" : "Connection identifier (optional)", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "role", "in" : "query", + "name" : "conn_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } + }, { "description" : "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", - "required" : false, - "type" : "string", - "default" : "server", - "enum" : [ "client", "server" ] + "in" : "query", + "name" : "role", + "schema" : { + "default" : "server", + "enum" : [ "client", "server" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/Keylist" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Keylist" + } + } + }, + "description" : "" } - } + }, + "summary" : "Retrieve keylists by connection or role", + "tags" : [ "mediation" ] } }, "/mediation/keylists/{mediation_id}/send-keylist-query" : { "post" : { - "tags" : [ "mediation" ], - "summary" : "Send keylist query to mediator", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/KeylistQueryFilterRequest" - } - }, { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } }, { - "name" : "paginate_limit", - "in" : "query", "description" : "limit number of results", - "required" : false, - "type" : "integer", - "default" : -1, - "format" : "int32" - }, { - "name" : "paginate_offset", "in" : "query", + "name" : "paginate_limit", + "schema" : { + "default" : -1, + "format" : "int32", + "type" : "integer" + } + }, { "description" : "offset to use in pagination", - "required" : false, - "type" : "integer", - "default" : 0, - "format" : "int32" + "in" : "query", + "name" : "paginate_offset", + "schema" : { + "default" : 0, + "format" : "int32", + "type" : "integer" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/KeylistQueryFilterRequest" + } + } + }, + "required" : false + }, "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/KeylistQuery" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeylistQuery" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send keylist query to mediator", + "tags" : [ "mediation" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/keylists/{mediation_id}/send-keylist-update" : { "post" : { - "tags" : [ "mediation" ], - "summary" : "Send keylist update to mediator", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/KeylistUpdateRequest" - } - }, { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/KeylistUpdateRequest" + } + } + }, + "required" : false + }, "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/KeylistUpdate" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeylistUpdate" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send keylist update to mediator", + "tags" : [ "mediation" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/request/{conn_id}" : { "post" : { - "tags" : [ "mediation" ], - "summary" : "Request mediation from connection", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/MediationCreateRequest" - } - }, { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/MediationCreateRequest" + } + } + }, + "required" : false + }, "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Request mediation from connection", + "tags" : [ "mediation" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/requests" : { "get" : { - "tags" : [ "mediation" ], - "summary" : "Query mediation requests, returns list of all mediation records", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "query", "description" : "Connection identifier (optional)", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "mediator_terms", "in" : "query", - "description" : "List of mediator rules for recipient", - "required" : false, - "type" : "array", - "items" : { + "name" : "conn_id", + "schema" : { + "format" : "uuid", "type" : "string" - }, - "collectionFormat" : "multi" + } }, { - "name" : "recipient_terms", + "description" : "List of mediator rules for recipient", + "explode" : true, "in" : "query", - "description" : "List of recipient rules for mediation", - "required" : false, - "type" : "array", - "items" : { - "type" : "string" + "name" : "mediator_terms", + "schema" : { + "items" : { + "description" : "Indicate terms to which the mediator requires the recipient to agree", + "type" : "string" + }, + "type" : "array" }, - "collectionFormat" : "multi" + "style" : "form" }, { - "name" : "state", + "description" : "List of recipient rules for mediation", + "explode" : true, "in" : "query", + "name" : "recipient_terms", + "schema" : { + "items" : { + "description" : "Indicate terms to which the recipient requires the mediator to agree", + "type" : "string" + }, + "type" : "array" + }, + "style" : "form" + }, { "description" : "Mediation state (optional)", - "required" : false, - "type" : "string", - "enum" : [ "request", "granted", "denied" ] + "in" : "query", + "name" : "state", + "schema" : { + "enum" : [ "request", "granted", "denied" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query mediation requests, returns list of all mediation records", + "tags" : [ "mediation" ] } }, "/mediation/requests/{mediation_id}" : { - "get" : { - "tags" : [ "mediation" ], - "summary" : "Retrieve mediation request record", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "mediation" ], + }, "summary" : "Delete mediation request by ID", - "produces" : [ "application/json" ], + "tags" : [ "mediation" ] + }, + "get" : { "parameters" : [ { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Retrieve mediation request record", + "tags" : [ "mediation" ] } }, "/mediation/requests/{mediation_id}/deny" : { "post" : { - "tags" : [ "mediation" ], - "summary" : "Deny a stored mediation request", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/AdminMediationDeny" - } - }, { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/AdminMediationDeny" + } + } + }, + "required" : false + }, "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationDeny" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationDeny" + } + } + }, + "description" : "" } - } + }, + "summary" : "Deny a stored mediation request", + "tags" : [ "mediation" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/requests/{mediation_id}/grant" : { "post" : { - "tags" : [ "mediation" ], - "summary" : "Grant received mediation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationGrant" + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationGrant" + } + } + }, + "description" : "" + } + }, + "summary" : "Grant received mediation", + "tags" : [ "mediation" ] + } + }, + "/mediation/update-keylist/{conn_id}" : { + "post" : { + "parameters" : [ { + "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/MediationIdMatchInfo" + } } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/KeylistUpdate" + } + } + }, + "description" : "" } - } + }, + "summary" : "Update keylist for a connection", + "tags" : [ "mediation" ], + "x-codegen-request-body-name" : "body" } }, "/mediation/{mediation_id}/default-mediator" : { "put" : { - "tags" : [ "mediation" ], - "summary" : "Set default mediator", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "mediation_id", - "in" : "path", "description" : "Mediation record identifier", + "in" : "path", + "name" : "mediation_id", "required" : true, - "type" : "string", - "format" : "uuid" + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "201" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/MediationRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MediationRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Set default mediator", + "tags" : [ "mediation" ] } }, "/multitenancy/wallet" : { "post" : { - "tags" : [ "multitenancy" ], - "summary" : "Create a subwallet", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/CreateWalletRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/CreateWalletRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CreateWalletResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateWalletResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a subwallet", + "tags" : [ "multitenancy" ], + "x-codegen-request-body-name" : "body" } }, "/multitenancy/wallet/{wallet_id}" : { "get" : { - "tags" : [ "multitenancy" ], - "summary" : "Get a single subwallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "wallet_id", - "in" : "path", "description" : "Subwallet identifier", + "in" : "path", + "name" : "wallet_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/WalletRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WalletRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get a single subwallet", + "tags" : [ "multitenancy" ] }, "put" : { - "tags" : [ "multitenancy" ], - "summary" : "Update a subwallet", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/UpdateWalletRequest" - } - }, { - "name" : "wallet_id", - "in" : "path", "description" : "Subwallet identifier", + "in" : "path", + "name" : "wallet_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/UpdateWalletRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/WalletRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WalletRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Update a subwallet", + "tags" : [ "multitenancy" ], + "x-codegen-request-body-name" : "body" } }, "/multitenancy/wallet/{wallet_id}/remove" : { "post" : { - "tags" : [ "multitenancy" ], - "summary" : "Remove a subwallet", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RemoveWalletRequest" - } - }, { - "name" : "wallet_id", - "in" : "path", "description" : "Subwallet identifier", + "in" : "path", + "name" : "wallet_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/RemoveWalletRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/MultitenantModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/MultitenantModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Remove a subwallet", + "tags" : [ "multitenancy" ], + "x-codegen-request-body-name" : "body" } }, "/multitenancy/wallet/{wallet_id}/token" : { "post" : { - "tags" : [ "multitenancy" ], - "summary" : "Get auth token for a subwallet", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/CreateWalletTokenRequest" - } - }, { - "name" : "wallet_id", "in" : "path", + "name" : "wallet_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/CreateWalletTokenRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CreateWalletTokenResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CreateWalletTokenResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get auth token for a subwallet", + "tags" : [ "multitenancy" ], + "x-codegen-request-body-name" : "body" } }, "/multitenancy/wallets" : { "get" : { - "tags" : [ "multitenancy" ], - "summary" : "Query subwallets", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "wallet_name", - "in" : "query", "description" : "Wallet name", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "wallet_name", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/WalletList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WalletList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query subwallets", + "tags" : [ "multitenancy" ] } }, "/out-of-band/create-invitation" : { "post" : { - "tags" : [ "out-of-band" ], - "summary" : "Create a new connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Auto-accept connection (defaults to configuration)", + "in" : "query", + "name" : "auto_accept", "schema" : { - "$ref" : "#/definitions/InvitationCreateRequest" + "type" : "boolean" } }, { - "name" : "auto_accept", + "description" : "Create invitation for multiple use (default false)", "in" : "query", - "description" : "Auto-accept connection (defaults to configuration)", - "required" : false, - "type" : "boolean" - }, { "name" : "multi_use", - "in" : "query", - "description" : "Create invitation for multiple use (default false)", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/InvitationCreateRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/InvitationRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/InvitationRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a new connection invitation", + "tags" : [ "out-of-band" ], + "x-codegen-request-body-name" : "body" } }, "/out-of-band/receive-invitation" : { "post" : { - "tags" : [ "out-of-band" ], - "summary" : "Receive a new connection invitation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Alias for connection", + "in" : "query", + "name" : "alias", "schema" : { - "$ref" : "#/definitions/InvitationMessage" + "type" : "string" } }, { - "name" : "alias", + "description" : "Auto-accept connection (defaults to configuration)", "in" : "query", - "description" : "Alias for connection", - "required" : false, - "type" : "string" - }, { "name" : "auto_accept", - "in" : "query", - "description" : "Auto-accept connection (defaults to configuration)", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } }, { - "name" : "mediation_id", - "in" : "query", "description" : "Identifier for active mediation record to be used", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, { - "name" : "use_existing_connection", "in" : "query", + "name" : "mediation_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } + }, { "description" : "Use an existing connection, if possible", - "required" : false, - "type" : "boolean" + "in" : "query", + "name" : "use_existing_connection", + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/InvitationMessage" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/ConnRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OobRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Receive a new connection invitation", + "tags" : [ "out-of-band" ], + "x-codegen-request-body-name" : "body" } }, "/plugins" : { "get" : { - "tags" : [ "server" ], - "summary" : "Fetch the list of loaded plugins", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminModules" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminModules" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the list of loaded plugins", + "tags" : [ "server" ] } }, "/present-proof-2.0/create-request" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Creates a presentation request not bound to any proposal or connection", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20PresCreateRequestRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresCreateRequestRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Creates a presentation request not bound to any proposal or connection", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof-2.0/records" : { "get" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Fetch all present-proof exchange records", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "connection_id", - "in" : "query", "description" : "Connection identifier", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "role", "in" : "query", - "description" : "Role assigned in presentation exchange", - "required" : false, - "type" : "string", - "enum" : [ "prover", "verifier" ] + "name" : "connection_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } }, { - "name" : "state", + "description" : "Role assigned in presentation exchange", "in" : "query", - "description" : "Presentation exchange state", - "required" : false, - "type" : "string", - "enum" : [ "proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned" ] + "name" : "role", + "schema" : { + "enum" : [ "prover", "verifier" ], + "type" : "string" + } }, { - "name" : "thread_id", + "description" : "Presentation exchange state", "in" : "query", + "name" : "state", + "schema" : { + "enum" : [ "proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned" ], + "type" : "string" + } + }, { "description" : "Thread identifier", - "required" : false, - "type" : "string", - "format" : "uuid" + "in" : "query", + "name" : "thread_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecordList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecordList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch all present-proof exchange records", + "tags" : [ "present-proof v2.0" ] } }, "/present-proof-2.0/records/{pres_ex_id}" : { - "get" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Fetch a single presentation exchange record", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresentProofModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "present-proof v2.0" ], + }, "summary" : "Remove an existing presentation exchange record", - "produces" : [ "application/json" ], + "tags" : [ "present-proof v2.0" ] + }, + "get" : { "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresentProofModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single presentation exchange record", + "tags" : [ "present-proof v2.0" ] } }, "/present-proof-2.0/records/{pres_ex_id}/credentials" : { "get" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Fetch credentials from wallet for presentation request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } }, { - "name" : "count", - "in" : "query", "description" : "Maximum number to retrieve", - "required" : false, - "type" : "string", - "pattern" : "^[1-9][0-9]*$" - }, { - "name" : "extra_query", "in" : "query", - "description" : "(JSON) object mapping referents to extra WQL queries", - "required" : false, - "type" : "string", - "pattern" : "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$" + "name" : "count", + "schema" : { + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + } }, { - "name" : "referent", + "description" : "(JSON) object mapping referents to extra WQL queries", "in" : "query", - "description" : "Proof request referents of interest, comma-separated", - "required" : false, - "type" : "string" + "name" : "extra_query", + "schema" : { + "pattern" : "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "type" : "string" + } }, { - "name" : "start", + "description" : "Proof request referents of interest, comma-separated", "in" : "query", + "name" : "referent", + "schema" : { + "type" : "string" + } + }, { "description" : "Start index", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" - } ], + "in" : "query", + "name" : "start", + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } + } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/IndyCredPrecis" + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/IndyCredPrecis" + }, + "type" : "array" + } } - } + }, + "description" : "" } - } + }, + "summary" : "Fetch credentials from wallet for presentation request", + "tags" : [ "present-proof v2.0" ] } }, "/present-proof-2.0/records/{pres_ex_id}/problem-report" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Send a problem report for presentation exchange", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20PresProblemReportRequest" - } - }, { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresProblemReportRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresentProofModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresentProofModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a problem report for presentation exchange", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof-2.0/records/{pres_ex_id}/send-presentation" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Sends a proof presentation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20PresSpecByFormatRequest" - } - }, { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresSpecByFormatRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a proof presentation", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof-2.0/records/{pres_ex_id}/send-request" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Sends a presentation request in reference to a proposal", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/AdminAPIMessageTracing" - } - }, { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresentationSendRequestToProposal" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a presentation request in reference to a proposal", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof-2.0/records/{pres_ex_id}/verify-presentation" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Verify a received presentation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Verify a received presentation", + "tags" : [ "present-proof v2.0" ] } }, "/present-proof-2.0/send-proposal" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Sends a presentation proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20PresProposalRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresProposalRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a presentation proposal", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof-2.0/send-request" : { "post" : { - "tags" : [ "present-proof v2.0" ], - "summary" : "Sends a free presentation request not bound to any proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V20PresSendRequestRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresSendRequestRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V20PresExRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V20PresExRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a free presentation request not bound to any proposal", + "tags" : [ "present-proof v2.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/create-request" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Creates a presentation request not bound to any proposal or connection", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10PresentationCreateRequestRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationCreateRequestRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Creates a presentation request not bound to any proposal or connection", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/records" : { "get" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Fetch all present-proof exchange records", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "connection_id", - "in" : "query", "description" : "Connection identifier", - "required" : false, - "type" : "string", - "format" : "uuid" - }, { - "name" : "role", "in" : "query", - "description" : "Role assigned in presentation exchange", - "required" : false, - "type" : "string", - "enum" : [ "prover", "verifier" ] + "name" : "connection_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } }, { - "name" : "state", + "description" : "Role assigned in presentation exchange", "in" : "query", - "description" : "Presentation exchange state", - "required" : false, - "type" : "string", - "enum" : [ "proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked" ] + "name" : "role", + "schema" : { + "enum" : [ "prover", "verifier" ], + "type" : "string" + } }, { - "name" : "thread_id", + "description" : "Presentation exchange state", "in" : "query", + "name" : "state", + "schema" : { + "enum" : [ "proposal_sent", "proposal_received", "request_sent", "request_received", "presentation_sent", "presentation_received", "verified", "presentation_acked", "abandoned" ], + "type" : "string" + } + }, { "description" : "Thread identifier", - "required" : false, - "type" : "string", - "format" : "uuid" + "in" : "query", + "name" : "thread_id", + "schema" : { + "format" : "uuid", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchangeList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchangeList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch all present-proof exchange records", + "tags" : [ "present-proof v1.0" ] } }, "/present-proof/records/{pres_ex_id}" : { - "get" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Fetch a single presentation exchange record", - "produces" : [ "application/json" ], + "delete" : { "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentProofModuleResponse" + } + } + }, + "description" : "" } - } - }, - "delete" : { - "tags" : [ "present-proof v1.0" ], + }, "summary" : "Remove an existing presentation exchange record", - "produces" : [ "application/json" ], + "tags" : [ "present-proof v1.0" ] + }, + "get" : { "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentProofModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single presentation exchange record", + "tags" : [ "present-proof v1.0" ] } }, "/present-proof/records/{pres_ex_id}/credentials" : { "get" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Fetch credentials for a presentation request from wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } }, { - "name" : "count", - "in" : "query", "description" : "Maximum number to retrieve", - "required" : false, - "type" : "string", - "pattern" : "^[1-9][0-9]*$" - }, { - "name" : "extra_query", "in" : "query", - "description" : "(JSON) object mapping referents to extra WQL queries", - "required" : false, - "type" : "string", - "pattern" : "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$" + "name" : "count", + "schema" : { + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + } }, { - "name" : "referent", + "description" : "(JSON) object mapping referents to extra WQL queries", "in" : "query", - "description" : "Proof request referents of interest, comma-separated", - "required" : false, - "type" : "string" + "name" : "extra_query", + "schema" : { + "pattern" : "^{\\s*\".*?\"\\s*:\\s*{.*?}\\s*(,\\s*\".*?\"\\s*:\\s*{.*?}\\s*)*\\s*}$", + "type" : "string" + } }, { - "name" : "start", + "description" : "Proof request referents of interest, comma-separated", "in" : "query", + "name" : "referent", + "schema" : { + "type" : "string" + } + }, { "description" : "Start index", - "required" : false, - "type" : "string", - "pattern" : "^[0-9]*$" + "in" : "query", + "name" : "start", + "schema" : { + "pattern" : "^[0-9]*$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/IndyCredPrecis" + "content" : { + "application/json" : { + "schema" : { + "items" : { + "$ref" : "#/components/schemas/IndyCredPrecis" + }, + "type" : "array" + } } - } + }, + "description" : "" } - } + }, + "summary" : "Fetch credentials for a presentation request from wallet", + "tags" : [ "present-proof v1.0" ] } }, "/present-proof/records/{pres_ex_id}/problem-report" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Send a problem report for presentation exchange", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/V10PresentationProblemReportRequest" + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" } - }, { - "name" : "pres_ex_id", - "in" : "path", - "description" : "Presentation exchange identifier", - "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationProblemReportRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentProofModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentProofModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send a problem report for presentation exchange", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/records/{pres_ex_id}/send-presentation" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Sends a proof presentation", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/IndyPresSpec" - } - }, { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/IndyPresSpec" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a proof presentation", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/records/{pres_ex_id}/send-request" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Sends a presentation request in reference to a proposal", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/AdminAPIMessageTracing" - } - }, { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationSendRequestToProposal" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a presentation request in reference to a proposal", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/records/{pres_ex_id}/verify-presentation" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Verify a received presentation", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "pres_ex_id", - "in" : "path", "description" : "Presentation exchange identifier", + "in" : "path", + "name" : "pres_ex_id", "required" : true, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Verify a received presentation", + "tags" : [ "present-proof v1.0" ] } }, "/present-proof/send-proposal" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Sends a presentation proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10PresentationProposalRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationProposalRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a presentation proposal", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/present-proof/send-request" : { "post" : { - "tags" : [ "present-proof v1.0" ], - "summary" : "Sends a free presentation request not bound to any proposal", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/V10PresentationSendRequestRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationSendRequestRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/V10PresentationExchange" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a free presentation request not bound to any proposal", + "tags" : [ "present-proof v1.0" ], + "x-codegen-request-body-name" : "body" } }, "/resolver/resolve/{did}" : { "get" : { - "tags" : [ "resolver" ], - "summary" : "Retrieve doc for requested did", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "path", "description" : "DID", + "in" : "path", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$" + "schema" : { + "pattern" : "^did:([a-z0-9]+):((?:[a-zA-Z0-9._%-]*:)*[a-zA-Z0-9._%-]+)$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/ResolutionResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/ResolutionResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Retrieve doc for requested did", + "tags" : [ "resolver" ] } }, "/revocation/active-registry/{cred_def_id}" : { "get" : { - "tags" : [ "revocation" ], - "summary" : "Get current active revocation registry by credential definition id", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_def_id", - "in" : "path", "description" : "Credential definition identifier", + "in" : "path", + "name" : "cred_def_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get current active revocation registry by credential definition id", + "tags" : [ "revocation" ] } }, "/revocation/clear-pending-revocations" : { "post" : { - "tags" : [ "revocation" ], - "summary" : "Clear pending revocations", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/ClearPendingRevocationsRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/ClearPendingRevocationsRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/PublishRevocations" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PublishRevocations" + } + } + }, + "description" : "" } - } + }, + "summary" : "Clear pending revocations", + "tags" : [ "revocation" ], + "x-codegen-request-body-name" : "body" } }, "/revocation/create-registry" : { "post" : { - "tags" : [ "revocation" ], - "summary" : "Creates a new revocation registry", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RevRegCreateRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegCreateRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Creates a new revocation registry", + "tags" : [ "revocation" ], + "x-codegen-request-body-name" : "body" } }, "/revocation/credential-record" : { "get" : { - "tags" : [ "revocation" ], - "summary" : "Get credential revocation status", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "cred_ex_id", - "in" : "query", "description" : "Credential exchange identifier", - "required" : false, - "type" : "string", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, { - "name" : "cred_rev_id", "in" : "query", - "description" : "Credential revocation identifier", - "required" : false, - "type" : "string", - "pattern" : "^[1-9][0-9]*$" + "name" : "cred_ex_id", + "schema" : { + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + } }, { - "name" : "rev_reg_id", + "description" : "Credential revocation identifier", "in" : "query", + "name" : "cred_rev_id", + "schema" : { + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + } + }, { "description" : "Revocation registry identifier", - "required" : false, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "in" : "query", + "name" : "rev_reg_id", + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/CredRevRecordResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredRevRecordResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get credential revocation status", + "tags" : [ "revocation" ] } }, "/revocation/publish-revocations" : { "post" : { - "tags" : [ "revocation" ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/PublishRevocations" + } + } + }, + "required" : false + }, + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TxnOrPublishRevocationsResult" + } + } + }, + "description" : "" + } + }, "summary" : "Publish pending revocations to ledger", - "produces" : [ "application/json" ], + "tags" : [ "revocation" ], + "x-codegen-request-body-name" : "body" + } + }, + "/revocation/registries/created" : { + "get" : { "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Credential definition identifier", + "in" : "query", + "name" : "cred_def_id", "schema" : { - "$ref" : "#/definitions/PublishRevocations" + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" } }, { - "name" : "conn_id", - "in" : "query", - "description" : "Connection identifier", - "required" : false, - "type" : "string" - }, { - "name" : "create_transaction_for_endorser", + "description" : "Revocation registry state", "in" : "query", - "description" : "Create Transaction For Endorser's signature", - "required" : false, - "type" : "boolean" + "name" : "state", + "schema" : { + "enum" : [ "init", "generated", "posted", "active", "full" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/TxnOrPublishRevocationsResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegsCreated" + } + } + }, + "description" : "" } - } + }, + "summary" : "Search for matching revocation registries that current agent created", + "tags" : [ "revocation" ] } }, - "/revocation/registries/created" : { - "get" : { - "tags" : [ "revocation" ], - "summary" : "Search for matching revocation registries that current agent created", - "produces" : [ "application/json" ], + "/revocation/registry/delete-tails-file" : { + "delete" : { "parameters" : [ { - "name" : "cred_def_id", - "in" : "query", "description" : "Credential definition identifier", - "required" : false, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" + "in" : "query", + "name" : "cred_def_id", + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + } }, { - "name" : "state", + "description" : "Revocation registry identifier", "in" : "query", - "description" : "Revocation registry state", - "required" : false, - "type" : "string", - "enum" : [ "init", "generated", "posted", "active", "full" ] + "name" : "rev_reg_id", + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegsCreated" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TailsDeleteResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Delete the tail files", + "tags" : [ "revocation" ] } }, "/revocation/registry/{rev_reg_id}" : { "get" : { - "tags" : [ "revocation" ], - "summary" : "Get revocation registry by revocation registry id", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get revocation registry by revocation registry id", + "tags" : [ "revocation" ] }, "patch" : { - "tags" : [ "revocation" ], - "summary" : "Update revocation registry with new public URI to its tails file", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RevRegUpdateTailsFileUri" - } - }, { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegUpdateTailsFileUri" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Update revocation registry with new public URI to its tails file", + "tags" : [ "revocation" ], + "x-codegen-request-body-name" : "body" } }, "/revocation/registry/{rev_reg_id}/definition" : { "post" : { - "tags" : [ "revocation" ], - "summary" : "Send revocation registry definition to ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } }, { - "name" : "conn_id", - "in" : "query", "description" : "Connection identifier", - "required" : false, - "type" : "string" - }, { - "name" : "create_transaction_for_endorser", "in" : "query", + "name" : "conn_id", + "schema" : { + "type" : "string" + } + }, { "description" : "Create Transaction For Endorser's signature", - "required" : false, - "type" : "boolean" + "in" : "query", + "name" : "create_transaction_for_endorser", + "schema" : { + "type" : "boolean" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/TxnOrRevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TxnOrRevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Send revocation registry definition to ledger", + "tags" : [ "revocation" ] } }, "/revocation/registry/{rev_reg_id}/entry" : { "post" : { - "tags" : [ "revocation" ], - "summary" : "Send revocation registry entry to ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } }, { - "name" : "conn_id", - "in" : "query", "description" : "Connection identifier", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "conn_id", + "schema" : { + "type" : "string" + } }, { + "description" : "Create Transaction For Endorser's signature", + "in" : "query", "name" : "create_transaction_for_endorser", + "schema" : { + "type" : "boolean" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" + } + }, + "summary" : "Send revocation registry entry to ledger", + "tags" : [ "revocation" ] + } + }, + "/revocation/registry/{rev_reg_id}/fix-revocation-entry-state" : { + "put" : { + "parameters" : [ { + "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", + "required" : true, + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } + }, { + "description" : "Apply updated accumulator transaction to ledger", "in" : "query", - "description" : "Create Transaction For Endorser's signature", - "required" : false, - "type" : "boolean" + "name" : "apply_ledger_update", + "required" : true, + "schema" : { + "type" : "boolean" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegWalletUpdatedResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fix revocation state in wallet and return number of updated entries", + "tags" : [ "revocation" ] } }, "/revocation/registry/{rev_reg_id}/issued" : { "get" : { - "tags" : [ "revocation" ], - "summary" : "Get number of credentials issued against revocation registry", - "produces" : [ "application/json" ], "parameters" : [ { + "description" : "Revocation Registry identifier", + "in" : "path", "name" : "rev_reg_id", + "required" : true, + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegIssuedResult" + } + } + }, + "description" : "" + } + }, + "summary" : "Get number of credentials issued against revocation registry", + "tags" : [ "revocation" ] + } + }, + "/revocation/registry/{rev_reg_id}/issued/details" : { + "get" : { + "parameters" : [ { + "description" : "Revocation Registry identifier", "in" : "path", + "name" : "rev_reg_id", + "required" : true, + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } + } ], + "responses" : { + "200" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredRevRecordDetailsResult" + } + } + }, + "description" : "" + } + }, + "summary" : "Get details of credentials issued against revocation registry", + "tags" : [ "revocation" ] + } + }, + "/revocation/registry/{rev_reg_id}/issued/indy_recs" : { + "get" : { + "parameters" : [ { "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegIssuedResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CredRevIndyRecordsResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Get details of revoked credentials from ledger", + "tags" : [ "revocation" ] } }, "/revocation/registry/{rev_reg_id}/set-state" : { "patch" : { - "tags" : [ "revocation" ], - "summary" : "Set revocation registry state manually", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } }, { - "name" : "state", - "in" : "query", "description" : "Revocation registry state to set", + "in" : "query", + "name" : "state", "required" : true, - "type" : "string", - "enum" : [ "init", "generated", "posted", "active", "full" ] + "schema" : { + "enum" : [ "init", "generated", "posted", "active", "full" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevRegResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevRegResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Set revocation registry state manually", + "tags" : [ "revocation" ] } }, "/revocation/registry/{rev_reg_id}/tails-file" : { "get" : { - "tags" : [ "revocation" ], - "summary" : "Download tails file", - "produces" : [ "application/octet-stream" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "tails file", - "schema" : { - "type" : "string", - "format" : "binary" - } + "content" : { + "application/octet-stream" : { + "schema" : { + "format" : "binary", + "type" : "string" + } + } + }, + "description" : "tails file" } - } + }, + "summary" : "Download tails file", + "tags" : [ "revocation" ] }, "put" : { - "tags" : [ "revocation" ], - "summary" : "Upload local tails file to server", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "rev_reg_id", - "in" : "path", "description" : "Revocation Registry identifier", + "in" : "path", + "name" : "rev_reg_id", "required" : true, - "type" : "string", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "schema" : { + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevocationModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevocationModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Upload local tails file to server", + "tags" : [ "revocation" ] } }, "/revocation/revoke" : { "post" : { - "tags" : [ "revocation" ], - "summary" : "Revoke an issued credential", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/RevokeRequest" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/RevokeRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/RevocationModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RevocationModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Revoke an issued credential", + "tags" : [ "revocation" ], + "x-codegen-request-body-name" : "body" } }, "/schemas" : { "post" : { - "tags" : [ "schema" ], - "summary" : "Sends a schema to the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Connection identifier", + "in" : "query", + "name" : "conn_id", "schema" : { - "$ref" : "#/definitions/SchemaSendRequest" + "type" : "string" } }, { - "name" : "conn_id", + "description" : "Create Transaction For Endorser's signature", "in" : "query", - "description" : "Connection identifier", - "required" : false, - "type" : "string" - }, { "name" : "create_transaction_for_endorser", - "in" : "query", - "description" : "Create Transaction For Endorser's signature", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/SchemaSendRequest" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/TxnOrSchemaSendResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TxnOrSchemaSendResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Sends a schema to the ledger", + "tags" : [ "schema" ], + "x-codegen-request-body-name" : "body" } }, "/schemas/created" : { "get" : { - "tags" : [ "schema" ], - "summary" : "Search for matching schema that agent originated", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "schema_id", - "in" : "query", "description" : "Schema identifier", - "required" : false, - "type" : "string", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, { - "name" : "schema_issuer_did", "in" : "query", - "description" : "Schema issuer DID", - "required" : false, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "name" : "schema_id", + "schema" : { + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } }, { - "name" : "schema_name", + "description" : "Schema issuer DID", "in" : "query", - "description" : "Schema name", - "required" : false, - "type" : "string" - }, { - "name" : "schema_version", + "name" : "schema_issuer_did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } + }, { + "description" : "Schema name", "in" : "query", + "name" : "schema_name", + "schema" : { + "type" : "string" + } + }, { "description" : "Schema version", - "required" : false, - "type" : "string", - "pattern" : "^[0-9.]+$" + "in" : "query", + "name" : "schema_version", + "schema" : { + "pattern" : "^[0-9.]+$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/SchemasCreatedResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SchemasCreatedResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Search for matching schema that agent originated", + "tags" : [ "schema" ] } }, "/schemas/{schema_id}" : { "get" : { - "tags" : [ "schema" ], - "summary" : "Gets a schema from the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "schema_id", - "in" : "path", "description" : "Schema identifier", + "in" : "path", + "name" : "schema_id", "required" : true, - "type" : "string", - "pattern" : "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" + "schema" : { + "pattern" : "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/SchemaGetResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SchemaGetResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Gets a schema from the ledger", + "tags" : [ "schema" ] } }, "/schemas/{schema_id}/write_record" : { "post" : { - "tags" : [ "schema" ], - "summary" : "Writes a schema non-secret record to the wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "schema_id", - "in" : "path", "description" : "Schema identifier", + "in" : "path", + "name" : "schema_id", "required" : true, - "type" : "string", - "pattern" : "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" + "schema" : { + "pattern" : "^[1-9][0-9]*|[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/SchemaGetResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SchemaGetResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Writes a schema non-secret record to the wallet", + "tags" : [ "schema" ] } }, "/shutdown" : { "get" : { - "tags" : [ "server" ], - "summary" : "Shut down server", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminShutdown" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminShutdown" + } + } + }, + "description" : "" } - } + }, + "summary" : "Shut down server", + "tags" : [ "server" ] } }, "/status" : { "get" : { - "tags" : [ "server" ], - "summary" : "Fetch the server status", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminStatus" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminStatus" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the server status", + "tags" : [ "server" ] } }, "/status/config" : { "get" : { - "tags" : [ "server" ], - "summary" : "Fetch the server configuration", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminConfig" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminConfig" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the server configuration", + "tags" : [ "server" ] } }, "/status/live" : { "get" : { - "tags" : [ "server" ], - "summary" : "Liveliness check", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminStatusLiveliness" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminStatusLiveliness" + } + } + }, + "description" : "" } - } + }, + "summary" : "Liveliness check", + "tags" : [ "server" ] } }, "/status/ready" : { "get" : { - "tags" : [ "server" ], - "summary" : "Readiness check", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminStatusReadiness" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminStatusReadiness" + } + } + }, + "description" : "" } - } + }, + "summary" : "Readiness check", + "tags" : [ "server" ] } }, "/status/reset" : { "post" : { - "tags" : [ "server" ], - "summary" : "Reset statistics", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/AdminReset" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AdminReset" + } + } + }, + "description" : "" } - } + }, + "summary" : "Reset statistics", + "tags" : [ "server" ] } }, "/transaction/{tran_id}/resend" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For Author to resend a particular transaction request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For Author to resend a particular transaction request", + "tags" : [ "endorse-transaction" ] } }, "/transactions" : { "get" : { - "tags" : [ "endorse-transaction" ], - "summary" : "Query transactions", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionList" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query transactions", + "tags" : [ "endorse-transaction" ] } }, "/transactions/create-request" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For author to send a transaction request", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Transaction identifier", + "in" : "query", + "name" : "tran_id", + "required" : true, "schema" : { - "$ref" : "#/definitions/Date" + "type" : "string" } }, { - "name" : "tran_id", + "description" : "Endorser will write the transaction after endorsing it", "in" : "query", - "description" : "Transaction identifier", - "required" : true, - "type" : "string" - }, { "name" : "endorser_write_txn", - "in" : "query", - "description" : "Endorser will write the transaction after endorsing it", - "required" : false, - "type" : "boolean" + "schema" : { + "type" : "boolean" + } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/Date" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For author to send a transaction request", + "tags" : [ "endorse-transaction" ], + "x-codegen-request-body-name" : "body" } }, "/transactions/{conn_id}/set-endorser-info" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "Set Endorser Info", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "endorser_did", - "in" : "query", "description" : "Endorser DID", + "in" : "query", + "name" : "endorser_did", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "endorser_name", - "in" : "query", "description" : "Endorser Name", - "required" : false, - "type" : "string" + "in" : "query", + "name" : "endorser_name", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/EndorserInfo" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/EndorserInfo" + } + } + }, + "description" : "" } - } + }, + "summary" : "Set Endorser Info", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{conn_id}/set-endorser-role" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "Set transaction jobs", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "conn_id", - "in" : "path", "description" : "Connection identifier", + "in" : "path", + "name" : "conn_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } }, { - "name" : "transaction_my_job", - "in" : "query", "description" : "Transaction related jobs", - "required" : false, - "type" : "string", - "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ] + "in" : "query", + "name" : "transaction_my_job", + "schema" : { + "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ], + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionJobs" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionJobs" + } + } + }, + "description" : "" } - } + }, + "summary" : "Set transaction jobs", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{tran_id}" : { "get" : { - "tags" : [ "endorse-transaction" ], - "summary" : "Fetch a single transaction record", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch a single transaction record", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{tran_id}/cancel" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For Author to cancel a particular transaction request", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For Author to cancel a particular transaction request", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{tran_id}/endorse" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For Endorser to endorse a particular transaction record", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } + }, { + "description" : "Endorser DID", + "in" : "query", + "name" : "endorser_did", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For Endorser to endorse a particular transaction record", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{tran_id}/refuse" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For Endorser to refuse a particular transaction record", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For Endorser to refuse a particular transaction record", + "tags" : [ "endorse-transaction" ] } }, "/transactions/{tran_id}/write" : { "post" : { - "tags" : [ "endorse-transaction" ], - "summary" : "For Author / Endorser to write an endorsed transaction to the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "tran_id", - "in" : "path", "description" : "Transaction identifier", + "in" : "path", + "name" : "tran_id", "required" : true, - "type" : "string" + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "null", - "schema" : { - "$ref" : "#/definitions/TransactionRecord" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/TransactionRecord" + } + } + }, + "description" : "" } - } + }, + "summary" : "For Author / Endorser to write an endorsed transaction to the ledger", + "tags" : [ "endorse-transaction" ] } }, "/wallet/did" : { "get" : { - "tags" : [ "wallet" ], - "summary" : "List wallet DIDs", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", - "required" : false, - "type" : "string", - "pattern" : "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, { - "name" : "key_type", "in" : "query", - "description" : "Key type to query for.", - "required" : false, - "type" : "string", - "enum" : [ "ed25519", "bls12381g2" ] + "name" : "did", + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type" : "string" + } }, { - "name" : "method", + "description" : "Key type to query for.", "in" : "query", - "description" : "DID method to query for. e.g. sov to only fetch indy/sov DIDs", - "required" : false, - "type" : "string", - "enum" : [ "key", "sov" ] + "name" : "key_type", + "schema" : { + "enum" : [ "ed25519", "bls12381g2" ], + "type" : "string" + } }, { - "name" : "posture", + "description" : "DID method to query for. e.g. sov to only fetch indy/sov DIDs", "in" : "query", - "description" : "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", - "required" : false, - "type" : "string", - "enum" : [ "public", "posted", "wallet_only" ] + "name" : "method", + "schema" : { + "enum" : [ "key", "sov" ], + "type" : "string" + } }, { - "name" : "verkey", + "description" : "Whether DID is current public DID, posted to ledger but current public DID, or local to the wallet", "in" : "query", + "name" : "posture", + "schema" : { + "enum" : [ "public", "posted", "wallet_only" ], + "type" : "string" + } + }, { "description" : "Verification key of interest", - "required" : false, - "type" : "string", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "in" : "query", + "name" : "verkey", + "schema" : { + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/DIDList" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DIDList" + } + } + }, + "description" : "" } - } + }, + "summary" : "List wallet DIDs", + "tags" : [ "wallet" ] } }, "/wallet/did/create" : { "post" : { - "tags" : [ "wallet" ], - "summary" : "Create a local DID", - "produces" : [ "application/json" ], - "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, - "schema" : { - "$ref" : "#/definitions/DIDCreate" - } - } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/DIDCreate" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/DIDResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DIDResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Create a local DID", + "tags" : [ "wallet" ], + "x-codegen-request-body-name" : "body" } }, "/wallet/did/local/rotate-keypair" : { "patch" : { - "tags" : [ "wallet" ], - "summary" : "Rotate keypair for a DID not posted to the ledger", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/WalletModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WalletModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Rotate keypair for a DID not posted to the ledger", + "tags" : [ "wallet" ] } }, "/wallet/did/public" : { "get" : { - "tags" : [ "wallet" ], - "summary" : "Fetch the current public DID", - "produces" : [ "application/json" ], - "parameters" : [ ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/DIDResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DIDResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Fetch the current public DID", + "tags" : [ "wallet" ] }, "post" : { - "tags" : [ "wallet" ], - "summary" : "Assign the current public DID", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } + }, { + "description" : "Connection identifier", + "in" : "query", + "name" : "conn_id", + "schema" : { + "type" : "string" + } + }, { + "description" : "Create Transaction For Endorser's signature", + "in" : "query", + "name" : "create_transaction_for_endorser", + "schema" : { + "type" : "boolean" + } + }, { + "description" : "Mediation identifier", + "in" : "query", + "name" : "mediation_id", + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/DIDResult" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DIDResult" + } + } + }, + "description" : "" } - } + }, + "summary" : "Assign the current public DID", + "tags" : [ "wallet" ] } }, "/wallet/get-did-endpoint" : { "get" : { - "tags" : [ "wallet" ], - "summary" : "Query DID endpoint in wallet", - "produces" : [ "application/json" ], "parameters" : [ { - "name" : "did", - "in" : "query", "description" : "DID of interest", + "in" : "query", + "name" : "did", "required" : true, - "type" : "string", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "schema" : { + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/DIDEndpoint" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/DIDEndpoint" + } + } + }, + "description" : "" } - } + }, + "summary" : "Query DID endpoint in wallet", + "tags" : [ "wallet" ] } }, "/wallet/set-did-endpoint" : { "post" : { - "tags" : [ "wallet" ], - "summary" : "Update endpoint in wallet and on ledger if posted to it", - "produces" : [ "application/json" ], "parameters" : [ { - "in" : "body", - "name" : "body", - "required" : false, + "description" : "Connection identifier", + "in" : "query", + "name" : "conn_id", + "schema" : { + "type" : "string" + } + }, { + "description" : "Create Transaction For Endorser's signature", + "in" : "query", + "name" : "create_transaction_for_endorser", "schema" : { - "$ref" : "#/definitions/DIDEndpointWithType" + "type" : "boolean" } } ], + "requestBody" : { + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/DIDEndpointWithType" + } + } + }, + "required" : false + }, "responses" : { "200" : { - "description" : "", - "schema" : { - "$ref" : "#/definitions/WalletModuleResponse" - } + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/WalletModuleResponse" + } + } + }, + "description" : "" } - } + }, + "summary" : "Update endpoint in wallet and on ledger if posted to it", + "tags" : [ "wallet" ], + "x-codegen-request-body-name" : "body" } } }, - "securityDefinitions" : { - "AuthorizationHeader" : { - "description" : "Bearer token. Be sure to preprend token with 'Bearer '", - "type" : "apiKey", - "name" : "Authorization", - "in" : "header" - } - }, - "definitions" : { - "AMLRecord" : { - "type" : "object", - "properties" : { - "aml" : { - "type" : "object", - "additionalProperties" : { + "components" : { + "schemas" : { + "AMLRecord" : { + "properties" : { + "aml" : { + "additionalProperties" : { + "type" : "string" + }, + "type" : "object" + }, + "amlContext" : { + "type" : "string" + }, + "version" : { "type" : "string" } }, - "amlContext" : { - "type" : "string" + "type" : "object" + }, + "ActionMenuFetchResult" : { + "properties" : { + "result" : { + "$ref" : "#/components/schemas/ActionMenuFetchResult_result" + } }, - "version" : { - "type" : "string" - } - } - }, - "ActionMenuFetchResult" : { - "type" : "object", - "properties" : { - "result" : { - "$ref" : "#/definitions/ActionMenuFetchResult_result" - } - } - }, - "ActionMenuModulesResult" : { - "type" : "object" - }, - "AdminAPIMessageTracing" : { - "type" : "object", - "properties" : { - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "AdminConfig" : { - "type" : "object", - "properties" : { - "config" : { - "type" : "object", - "description" : "Configuration settings", - "properties" : { } - } - } - }, - "AdminMediationDeny" : { - "type" : "object", - "properties" : { - "mediator_terms" : { - "type" : "array", - "description" : "List of mediator rules for recipient", - "items" : { - "type" : "string", - "description" : "Indicate terms to which the mediator requires the recipient to agree" + "type" : "object" + }, + "ActionMenuModulesResult" : { + "type" : "object" + }, + "AdminConfig" : { + "properties" : { + "config" : { + "description" : "Configuration settings", + "properties" : { }, + "type" : "object" } }, - "recipient_terms" : { - "type" : "array", - "description" : "List of recipient rules for mediation", - "items" : { - "type" : "string", - "description" : "Indicate terms to which the recipient requires the mediator to agree" - } - } - } - }, - "AdminModules" : { - "type" : "object", - "properties" : { - "result" : { - "type" : "array", - "description" : "List of admin modules", - "items" : { - "type" : "string", - "description" : "admin module" - } - } - } - }, - "AdminReset" : { - "type" : "object" - }, - "AdminShutdown" : { - "type" : "object" - }, - "AdminStatus" : { - "type" : "object", - "properties" : { - "conductor" : { - "type" : "object", - "description" : "Conductor statistics", - "properties" : { } - }, - "label" : { - "type" : "string", - "description" : "Default label", - "x-nullable" : true - }, - "timing" : { - "type" : "object", - "description" : "Timing results", - "properties" : { } - }, - "version" : { - "type" : "string", - "description" : "Version code" - } - } - }, - "AdminStatusLiveliness" : { - "type" : "object", - "properties" : { - "alive" : { - "type" : "boolean", - "example" : true, - "description" : "Liveliness status" - } - } - }, - "AdminStatusReadiness" : { - "type" : "object", - "properties" : { - "ready" : { - "type" : "boolean", - "example" : true, - "description" : "Readiness status" - } - } - }, - "AttachDecorator" : { - "type" : "object", - "required" : [ "data" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Attachment identifier" - }, - "byte_count" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Byte count of data included by reference" - }, - "data" : { - "$ref" : "#/definitions/AttachDecoratorData" - }, - "description" : { - "type" : "string", - "example" : "view from doorway, facing east, with lights off", - "description" : "Human-readable description of content" - }, - "filename" : { - "type" : "string", - "example" : "IMG1092348.png", - "description" : "File name" - }, - "lastmod_time" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Hint regarding last modification datetime, in ISO-8601 format", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "mime-type" : { - "type" : "string", - "example" : "image/png", - "description" : "MIME type" - } - } - }, - "AttachDecoratorData" : { - "type" : "object", - "properties" : { - "base64" : { - "type" : "string", - "example" : "ey4uLn0=", - "description" : "Base64-encoded data", - "pattern" : "^[a-zA-Z0-9+/]*={0,2}$" - }, - "json" : { - "type" : "object", - "example" : "{\"sample\": \"content\"}", - "description" : "JSON-serialized data", - "properties" : { } - }, - "jws" : { - "$ref" : "#/definitions/AttachDecoratorData_jws" - }, - "links" : { - "type" : "array", - "description" : "List of hypertext links to data", - "items" : { - "type" : "string", - "example" : "https://link.to/data" - } - }, - "sha256" : { - "type" : "string", - "example" : "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", - "description" : "SHA256 hash (binhex encoded) of content", - "pattern" : "^[a-fA-F0-9+/]{64}$" - } - } - }, - "AttachDecoratorData1JWS" : { - "type" : "object", - "required" : [ "header", "signature" ], - "properties" : { - "header" : { - "$ref" : "#/definitions/AttachDecoratorDataJWSHeader" - }, - "protected" : { - "type" : "string", - "example" : "ey4uLn0", - "description" : "protected JWS header", - "pattern" : "^[-_a-zA-Z0-9]*$" - }, - "signature" : { - "type" : "string", - "example" : "ey4uLn0", - "description" : "signature", - "pattern" : "^[-_a-zA-Z0-9]*$" - } - } - }, - "AttachDecoratorDataJWS" : { - "type" : "object", - "properties" : { - "header" : { - "$ref" : "#/definitions/AttachDecoratorDataJWSHeader" - }, - "protected" : { - "type" : "string", - "example" : "ey4uLn0", - "description" : "protected JWS header", - "pattern" : "^[-_a-zA-Z0-9]*$" - }, - "signature" : { - "type" : "string", - "example" : "ey4uLn0", - "description" : "signature", - "pattern" : "^[-_a-zA-Z0-9]*$" - }, - "signatures" : { - "type" : "array", - "description" : "List of signatures", - "items" : { - "$ref" : "#/definitions/AttachDecoratorData1JWS" - } - } - } - }, - "AttachDecoratorDataJWSHeader" : { - "type" : "object", - "required" : [ "kid" ], - "properties" : { - "kid" : { - "type" : "string", - "example" : "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", - "description" : "Key identifier, in W3C did:key or DID URL format", - "pattern" : "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$" - } - } - }, - "AttachmentDef" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "example" : "attachment-0", - "description" : "Attachment identifier" - }, - "type" : { - "type" : "string", - "example" : "present-proof", - "description" : "Attachment type", - "enum" : [ "credential-offer", "present-proof" ] - } - } - }, - "AttributeMimeTypesResult" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "MIME type" - }, - "x-nullable" : true - } - } - }, - "BasicMessageModuleResponse" : { - "type" : "object" - }, - "ClaimFormat" : { - "type" : "object", - "properties" : { - "jwt" : { - "type" : "object", - "properties" : { } - }, - "jwt_vc" : { - "type" : "object", - "properties" : { } - }, - "jwt_vp" : { - "type" : "object", - "properties" : { } - }, - "ldp" : { - "type" : "object", - "properties" : { } - }, - "ldp_vc" : { - "type" : "object", - "properties" : { } - }, - "ldp_vp" : { - "type" : "object", - "properties" : { } - } - } - }, - "ClearPendingRevocationsRequest" : { - "type" : "object", - "properties" : { - "purge" : { - "type" : "object", - "description" : "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", - "additionalProperties" : { - "type" : "array", + "type" : "object" + }, + "AdminMediationDeny" : { + "properties" : { + "mediator_terms" : { + "description" : "List of mediator rules for recipient", "items" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier", - "pattern" : "^[1-9][0-9]*$" - } + "description" : "Indicate terms to which the mediator requires the recipient to agree", + "type" : "string" + }, + "type" : "array" + }, + "recipient_terms" : { + "description" : "List of recipient rules for mediation", + "items" : { + "description" : "Indicate terms to which the recipient requires the mediator to agree", + "type" : "string" + }, + "type" : "array" } - } - } - }, - "ConnRecord" : { - "type" : "object", - "properties" : { - "accept" : { - "type" : "string", - "example" : "auto", - "description" : "Connection acceptance: manual or auto", - "enum" : [ "manual", "auto" ] - }, - "alias" : { - "type" : "string", - "example" : "Bob, providing quotes", - "description" : "Optional alias to apply to connection for later use" }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "connection_protocol" : { - "type" : "string", - "example" : "connections/1.0", - "description" : "Connection protocol used", - "enum" : [ "connections/1.0", "didexchange/1.0" ] - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg" : { - "type" : "string", - "example" : "No DIDDoc provided; cannot connect to public DID", - "description" : "Error message" - }, - "inbound_connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Inbound routing connection id to use" - }, - "invitation_key" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Public key for connection", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "invitation_mode" : { - "type" : "string", - "example" : "once", - "description" : "Invitation mode", - "enum" : [ "once", "multi", "static" ] - }, - "invitation_msg_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "ID of out-of-band invitation message" - }, - "my_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Our DID for connection", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "request_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection request identifier" - }, - "rfc23_state" : { - "type" : "string", - "example" : "invitation-sent", - "description" : "State per RFC 23", - "readOnly" : true - }, - "routing_state" : { - "type" : "string", - "example" : "active", - "description" : "Routing state of connection", - "enum" : [ "none", "request", "active", "error" ] - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "their_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Their DID for connection", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "their_label" : { - "type" : "string", - "example" : "Bob", - "description" : "Their label for connection" - }, - "their_public_did" : { - "type" : "string", - "example" : "2cpBmR3FqGKWi5EyUbpRY8", - "description" : "Other agent's public DID for connection" - }, - "their_role" : { - "type" : "string", - "example" : "requester", - "description" : "Their role in the connection protocol", - "enum" : [ "invitee", "requester", "inviter", "responder" ] - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "ConnectionInvitation" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID for connection invitation", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "imageUrl" : { - "type" : "string", - "format" : "url", - "example" : "http://192.168.56.101/img/logo.jpg", - "description" : "Optional image URL for connection invitation", - "x-nullable" : true - }, - "label" : { - "type" : "string", - "example" : "Bob", - "description" : "Optional label for connection invitation" - }, - "recipientKeys" : { - "type" : "array", - "description" : "List of recipient keys", - "items" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Recipient public key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "type" : "object" + }, + "AdminModules" : { + "properties" : { + "result" : { + "description" : "List of admin modules", + "items" : { + "description" : "admin module", + "type" : "string" + }, + "type" : "array" } }, - "routingKeys" : { - "type" : "array", - "description" : "List of routing keys", - "items" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Routing key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "serviceEndpoint" : { - "type" : "string", - "example" : "http://192.168.56.101:8020", - "description" : "Service endpoint at which to reach this agent" - } - } - }, - "ConnectionList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "List of connection records", - "items" : { - "$ref" : "#/definitions/ConnRecord" - } - } - } - }, - "ConnectionMetadata" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "object", - "description" : "Dictionary of metadata associated with connection.", - "properties" : { } - } - } - }, - "ConnectionMetadataSetRequest" : { - "type" : "object", - "required" : [ "metadata" ], - "properties" : { - "metadata" : { - "type" : "object", - "description" : "Dictionary of metadata to set for connection.", - "properties" : { } - } - } - }, - "ConnectionModuleResponse" : { - "type" : "object" - }, - "ConnectionStaticRequest" : { - "type" : "object", - "properties" : { - "alias" : { - "type" : "string", - "description" : "Alias to assign to this connection" - }, - "my_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Local DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "my_seed" : { - "type" : "string", - "description" : "Seed to use for the local DID" - }, - "their_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Remote DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "their_endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "URL endpoint for other party", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "their_label" : { - "type" : "string", - "description" : "Other party's label for this connection" - }, - "their_seed" : { - "type" : "string", - "description" : "Seed to use for the remote DID" - }, - "their_verkey" : { - "type" : "string", - "description" : "Remote verification key" - } - } - }, - "ConnectionStaticResult" : { - "type" : "object", - "required" : [ "mv_verkey", "my_did", "my_endpoint", "record", "their_did", "their_verkey" ], - "properties" : { - "mv_verkey" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "My verification key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "my_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Local DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "my_endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "My URL endpoint", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "record" : { - "$ref" : "#/definitions/ConnRecord" - }, - "their_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Remote DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" + "type" : "object" + }, + "AdminReset" : { + "type" : "object" + }, + "AdminShutdown" : { + "type" : "object" + }, + "AdminStatus" : { + "properties" : { + "conductor" : { + "description" : "Conductor statistics", + "properties" : { }, + "type" : "object" + }, + "label" : { + "description" : "Default label", + "nullable" : true, + "type" : "string" + }, + "timing" : { + "description" : "Timing results", + "properties" : { }, + "type" : "object" + }, + "version" : { + "description" : "Version code", + "type" : "string" + } }, - "their_verkey" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Remote verification key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "Constraints" : { - "type" : "object", - "properties" : { - "fields" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/DIFField" + "type" : "object" + }, + "AdminStatusLiveliness" : { + "properties" : { + "alive" : { + "description" : "Liveliness status", + "example" : true, + "type" : "boolean" } }, - "is_holder" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/DIFHolder" + "type" : "object" + }, + "AdminStatusReadiness" : { + "properties" : { + "ready" : { + "description" : "Readiness status", + "example" : true, + "type" : "boolean" } }, - "limit_disclosure" : { - "type" : "string", - "description" : "LimitDisclosure" + "type" : "object" + }, + "AttachDecorator" : { + "properties" : { + "@id" : { + "description" : "Attachment identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "byte_count" : { + "description" : "Byte count of data included by reference", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "data" : { + "$ref" : "#/components/schemas/AttachDecoratorData" + }, + "description" : { + "description" : "Human-readable description of content", + "example" : "view from doorway, facing east, with lights off", + "type" : "string" + }, + "filename" : { + "description" : "File name", + "example" : "IMG1092348.png", + "type" : "string" + }, + "lastmod_time" : { + "description" : "Hint regarding last modification datetime, in ISO-8601 format", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "mime-type" : { + "description" : "MIME type", + "example" : "image/png", + "type" : "string" + } }, - "status_active" : { - "type" : "string", - "enum" : [ "required", "allowed", "disallowed" ] + "required" : [ "data" ], + "type" : "object" + }, + "AttachDecoratorData" : { + "properties" : { + "base64" : { + "description" : "Base64-encoded data", + "example" : "ey4uLn0=", + "pattern" : "^[a-zA-Z0-9+/]*={0,2}$", + "type" : "string" + }, + "json" : { + "description" : "JSON-serialized data", + "example" : "{\"sample\": \"content\"}", + "type" : "object" + }, + "jws" : { + "$ref" : "#/components/schemas/AttachDecoratorData_jws" + }, + "links" : { + "description" : "List of hypertext links to data", + "items" : { + "example" : "https://link.to/data", + "type" : "string" + }, + "type" : "array" + }, + "sha256" : { + "description" : "SHA256 hash (binhex encoded) of content", + "example" : "617a48c7c8afe0521efdc03e5bb0ad9e655893e6b4b51f0e794d70fba132aacb", + "pattern" : "^[a-fA-F0-9+/]{64}$", + "type" : "string" + } }, - "status_revoked" : { - "type" : "string", - "enum" : [ "required", "allowed", "disallowed" ] + "type" : "object" + }, + "AttachDecoratorData1JWS" : { + "properties" : { + "header" : { + "$ref" : "#/components/schemas/AttachDecoratorDataJWSHeader" + }, + "protected" : { + "description" : "protected JWS header", + "example" : "ey4uLn0", + "pattern" : "^[-_a-zA-Z0-9]*$", + "type" : "string" + }, + "signature" : { + "description" : "signature", + "example" : "ey4uLn0", + "pattern" : "^[-_a-zA-Z0-9]*$", + "type" : "string" + } }, - "status_suspended" : { - "type" : "string", - "enum" : [ "required", "allowed", "disallowed" ] + "required" : [ "header", "signature" ], + "type" : "object" + }, + "AttachDecoratorDataJWS" : { + "properties" : { + "header" : { + "$ref" : "#/components/schemas/AttachDecoratorDataJWSHeader" + }, + "protected" : { + "description" : "protected JWS header", + "example" : "ey4uLn0", + "pattern" : "^[-_a-zA-Z0-9]*$", + "type" : "string" + }, + "signature" : { + "description" : "signature", + "example" : "ey4uLn0", + "pattern" : "^[-_a-zA-Z0-9]*$", + "type" : "string" + }, + "signatures" : { + "description" : "List of signatures", + "items" : { + "$ref" : "#/components/schemas/AttachDecoratorData1JWS" + }, + "type" : "array" + } }, - "subject_is_issuer" : { - "type" : "string", - "description" : "SubjectIsIssuer", - "enum" : [ "required", "preferred" ] - } - } - }, - "CreateInvitationRequest" : { - "type" : "object", - "properties" : { - "mediation_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Identifier for active mediation record to be used", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, - "metadata" : { - "type" : "object", - "description" : "Optional metadata to attach to the connection created with the invitation", - "properties" : { } - }, - "my_label" : { - "type" : "string", - "example" : "Bob", - "description" : "Optional label for connection invitation" - }, - "recipient_keys" : { - "type" : "array", - "description" : "List of recipient keys", - "items" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Recipient public key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "type" : "object" + }, + "AttachDecoratorDataJWSHeader" : { + "properties" : { + "kid" : { + "description" : "Key identifier, in W3C did:key or DID URL format", + "example" : "did:sov:LjgpST2rjsoxYegQDRm7EL#keys-4", + "pattern" : "^did:(?:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+|sov:[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}(;.*)?(\\?.*)?#.+)$", + "type" : "string" } }, - "routing_keys" : { - "type" : "array", - "description" : "List of routing keys", - "items" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Routing key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "service_endpoint" : { - "type" : "string", - "example" : "http://192.168.56.102:8020", - "description" : "Connection endpoint" - } - } - }, - "CreateWalletRequest" : { - "type" : "object", - "properties" : { - "image_url" : { - "type" : "string", - "example" : "https://aries.ca/images/sample.png", - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." - }, - "key_management_mode" : { - "type" : "string", - "example" : "managed", - "description" : "Key management method to use for this wallet.", - "enum" : [ "managed" ] - }, - "label" : { - "type" : "string", - "example" : "Alice", - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." - }, - "wallet_dispatch_type" : { - "type" : "string", - "example" : "default", - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", - "enum" : [ "default", "both", "base" ] - }, - "wallet_key" : { - "type" : "string", - "example" : "MySecretKey123", - "description" : "Master key used for key derivation." - }, - "wallet_name" : { - "type" : "string", - "example" : "MyNewWallet", - "description" : "Wallet name" - }, - "wallet_type" : { - "type" : "string", - "example" : "indy", - "description" : "Type of the wallet to create", - "enum" : [ "askar", "in_memory", "indy" ] - }, - "wallet_webhook_urls" : { - "type" : "array", - "description" : "List of Webhook URLs associated with this subwallet", - "items" : { - "type" : "string", - "example" : "http://localhost:8022/webhooks", - "description" : "Optional webhook URL to receive webhook messages" - } - } - } - }, - "CreateWalletResponse" : { - "type" : "object", - "required" : [ "key_management_mode", "wallet_id" ], - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "key_management_mode" : { - "type" : "string", - "description" : "Mode regarding management of wallet key", - "enum" : [ "managed", "unmanaged" ] - }, - "settings" : { - "type" : "object", - "description" : "Settings for this wallet.", - "properties" : { } - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "token" : { - "type" : "string", - "example" : "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - "description" : "Authorization token to authenticate wallet requests" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Wallet record ID" - } - } - }, - "CreateWalletTokenRequest" : { - "type" : "object", - "properties" : { - "wallet_key" : { - "type" : "string", - "example" : "MySecretKey123", - "description" : "Master key used for key derivation. Only required for unamanged wallets." - } - } - }, - "CreateWalletTokenResponse" : { - "type" : "object", - "properties" : { - "token" : { - "type" : "string", - "example" : "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", - "description" : "Authorization token to authenticate wallet requests" - } - } - }, - "CredAttrSpec" : { - "type" : "object", - "required" : [ "name", "value" ], - "properties" : { - "mime-type" : { - "type" : "string", - "example" : "image/jpeg", - "description" : "MIME type: omit for (null) default", - "x-nullable" : true - }, - "name" : { - "type" : "string", - "example" : "favourite_drink", - "description" : "Attribute name" - }, - "value" : { - "type" : "string", - "example" : "martini", - "description" : "Attribute value: base64-encode if MIME type is present" - } - } - }, - "CredDefValue" : { - "type" : "object", - "properties" : { - "primary" : { - "$ref" : "#/definitions/CredDefValue_primary" - }, - "revocation" : { - "$ref" : "#/definitions/CredDefValue_revocation" - } - } - }, - "CredDefValuePrimary" : { - "type" : "object", - "properties" : { - "n" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "r" : { - "$ref" : "#/definitions/Generated" - }, - "rctxt" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "s" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "z" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - } - } - }, - "CredDefValueRevocation" : { - "type" : "object", - "properties" : { - "g" : { - "type" : "string", - "example" : "1 1F14F&ECB578F 2 095E45DDF417D" - }, - "g_dash" : { - "type" : "string", - "example" : "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D" - }, - "h" : { - "type" : "string", - "example" : "1 16675DAE54BFAE8 2 095E45DD417D" - }, - "h0" : { - "type" : "string", - "example" : "1 21E5EF9476EAF18 2 095E45DDF417D" - }, - "h1" : { - "type" : "string", - "example" : "1 236D1D99236090 2 095E45DDF417D" - }, - "h2" : { - "type" : "string", - "example" : "1 1C3AE8D1F1E277 2 095E45DDF417D" - }, - "h_cap" : { - "type" : "string", - "example" : "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000" - }, - "htilde" : { - "type" : "string", - "example" : "1 1D8549E8C0F8 2 095E45DDF417D" - }, - "pk" : { - "type" : "string", - "example" : "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D" - }, - "u" : { - "type" : "string", - "example" : "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000" - }, - "y" : { - "type" : "string", - "example" : "1 153558BD903312 2 095E45DDF417D 1 0000000000000000" - } - } - }, - "CredInfoList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/IndyCredInfo" - } - } - } - }, - "CredRevRecordResult" : { - "type" : "object", - "properties" : { - "result" : { - "$ref" : "#/definitions/IssuerCredRevRecord" - } - } - }, - "CredRevokedResult" : { - "type" : "object", - "properties" : { - "revoked" : { - "type" : "boolean", - "description" : "Whether credential is revoked on the ledger" - } - } - }, - "Credential" : { - "type" : "object", - "required" : [ "@context", "credentialSubject", "issuanceDate", "issuer", "type" ], - "properties" : { - "@context" : { - "type" : "array", - "example" : [ "https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1" ], - "description" : "The JSON-LD context of the credential", - "items" : { } - }, - "credentialSubject" : { - "example" : "" - }, - "expirationDate" : { - "type" : "string", - "example" : "2010-01-01T19:23:24Z", - "description" : "The expiration date", - "pattern" : "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "id" : { - "type" : "string", - "example" : "http://example.edu/credentials/1872", - "pattern" : "\\w+:(\\/?\\/?)[^\\s]+" - }, - "issuanceDate" : { - "type" : "string", - "example" : "2010-01-01T19:23:24Z", - "description" : "The issuance date", - "pattern" : "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$" - }, - "issuer" : { - "example" : "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", - "description" : "The JSON-LD Verifiable Credential Issuer. Either string of object with id field." - }, - "proof" : { - "$ref" : "#/definitions/Credential_proof" - }, - "type" : { - "type" : "array", - "example" : [ "VerifiableCredential", "AlumniCredential" ], - "description" : "The JSON-LD type of the credential", - "items" : { - "type" : "string" - } - } - } - }, - "CredentialDefinition" : { - "type" : "object", - "properties" : { - "id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "schemaId" : { - "type" : "string", - "example" : "20", - "description" : "Schema identifier within credential definition identifier" - }, - "tag" : { - "type" : "string", - "example" : "tag", - "description" : "Tag within credential definition identifier" - }, - "type" : { - "example" : "CL", - "description" : "Signature type: CL for Camenisch-Lysyanskaya" - }, - "value" : { - "$ref" : "#/definitions/CredentialDefinition_value" - }, - "ver" : { - "type" : "string", - "example" : "1.0", - "description" : "Node protocol version", - "pattern" : "^[0-9.]+$" - } - } - }, - "CredentialDefinitionGetResult" : { - "type" : "object", - "properties" : { - "credential_definition" : { - "$ref" : "#/definitions/CredentialDefinition" - } - } - }, - "CredentialDefinitionSendRequest" : { - "type" : "object", - "properties" : { - "revocation_registry_size" : { - "type" : "integer", - "format" : "int32", - "example" : 1000, - "description" : "Revocation registry size", - "minimum" : 4, - "maximum" : 32768 - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "support_revocation" : { - "type" : "boolean", - "description" : "Revocation supported flag" - }, - "tag" : { - "type" : "string", - "example" : "default", - "description" : "Credential definition identifier tag" - } - } - }, - "CredentialDefinitionSendResult" : { - "type" : "object", - "properties" : { - "credential_definition_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - } - }, - "CredentialDefinitionsCreatedResult" : { - "type" : "object", - "properties" : { - "credential_definition_ids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifiers", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - } - } - } - }, - "CredentialOffer" : { - "type" : "object", - "required" : [ "offers~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credential_preview" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "offers~attach" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - } - } - }, - "CredentialPreview" : { - "type" : "object", - "required" : [ "attributes" ], - "properties" : { - "@type" : { - "type" : "string", - "example" : "issue-credential/1.0/credential-preview", - "description" : "Message type identifier" - }, - "attributes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/CredAttrSpec" - } - } - } - }, - "CredentialProposal" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name" : { - "type" : "string" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "pattern" : "^[0-9.]+$" - } - } - }, - "CredentialStatusOptions" : { - "type" : "object", - "required" : [ "type" ], - "properties" : { - "type" : { - "type" : "string", - "example" : "CredentialStatusList2017", - "description" : "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry" - } - } - }, - "DID" : { - "type" : "object", - "properties" : { - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID of interest", - "pattern" : "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "key_type" : { - "type" : "string", - "example" : "ed25519", - "description" : "Key type associated with the DID", - "enum" : [ "ed25519", "bls12381g2" ] - }, - "method" : { - "type" : "string", - "example" : "sov", - "description" : "Did method associated with the DID", - "enum" : [ "sov", "key" ] - }, - "posture" : { - "type" : "string", - "example" : "wallet_only", - "description" : "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", - "enum" : [ "public", "posted", "wallet_only" ] - }, - "verkey" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Public verification key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "DIDCreate" : { - "type" : "object", - "properties" : { - "method" : { - "type" : "string", - "example" : "sov", - "enum" : [ "key", "sov" ] - }, - "options" : { - "$ref" : "#/definitions/DIDCreate_options" - } - } - }, - "DIDCreateOptions" : { - "type" : "object", - "required" : [ "key_type" ], - "properties" : { - "key_type" : { - "type" : "string", - "example" : "ed25519", - "enum" : [ "ed25519", "bls12381g2" ] - } - } - }, - "DIDEndpoint" : { - "type" : "object", - "required" : [ "did" ], - "properties" : { - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID of interest", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Endpoint to set (omit to delete)", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - }, - "DIDEndpointWithType" : { - "type" : "object", - "required" : [ "did" ], - "properties" : { - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID of interest", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Endpoint to set (omit to delete)", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "endpoint_type" : { - "type" : "string", - "example" : "Endpoint", - "description" : "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", - "enum" : [ "Endpoint", "Profile", "LinkedDomains" ] - } - } - }, - "DIDList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "DID list", - "items" : { - "$ref" : "#/definitions/DID" - } - } - } - }, - "DIDResult" : { - "type" : "object", - "properties" : { - "result" : { - "$ref" : "#/definitions/DID" - } - } - }, - "DIDXRequest" : { - "type" : "object", - "required" : [ "label" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID of exchange", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "did_doc~attach" : { - "$ref" : "#/definitions/DIDXRequest_did_docattach" - }, - "label" : { - "type" : "string", - "example" : "Request to connect with Bob", - "description" : "Label for DID exchange request" - } - } - }, - "DIFField" : { - "type" : "object", - "properties" : { - "filter" : { - "$ref" : "#/definitions/Filter" - }, - "id" : { - "type" : "string", - "description" : "ID" - }, - "path" : { - "type" : "array", - "items" : { - "type" : "string", - "description" : "Path" - } - }, - "predicate" : { - "type" : "string", - "description" : "Preference", - "enum" : [ "required", "preferred" ] - }, - "purpose" : { - "type" : "string", - "description" : "Purpose" - } - } - }, - "DIFHolder" : { - "type" : "object", - "properties" : { - "directive" : { - "type" : "string", - "description" : "Preference", - "enum" : [ "required", "preferred" ] - }, - "field_id" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "FieldID", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - } - } - } - }, - "DIFOptions" : { - "type" : "object", - "properties" : { - "challenge" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Challenge protect against replay attack", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, - "domain" : { - "type" : "string", - "example" : "4jt78h47fh47", - "description" : "Domain protect against replay attack" - } - } - }, - "DIFPresSpec" : { - "type" : "object", - "properties" : { - "issuer_id" : { - "type" : "string", - "description" : "Issuer identifier to sign the presentation, if different from current public DID" - }, - "presentation_definition" : { - "$ref" : "#/definitions/PresentationDefinition" - }, - "record_ids" : { - "type" : "object", - "example" : { - "" : [ "", "" ], - "" : [ "" ] - }, - "description" : "Mapping of input_descriptor id to list of stored W3C credential record_id", - "properties" : { } - }, - "reveal_doc" : { - "type" : "object", - "example" : { - "@context": [ - "https://www.w3.org/2018/credentials/v1", - "https://w3id.org/security/bbs/v1" - ], - "type": ["VerifiableCredential", "LabReport"], - "@explicit": true, - "@requireAll": true, - "issuanceDate": {}, - "issuer": {}, - "credentialSubject": { - "Observation": [ - {"effectiveDateTime": {}, "@explicit": true, "@requireAll": true} - ], - "@explicit": true, - "@requireAll": true - } + "required" : [ "kid" ], + "type" : "object" + }, + "AttachmentDef" : { + "properties" : { + "id" : { + "description" : "Attachment identifier", + "example" : "attachment-0", + "type" : "string" }, - "description" : "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", - "properties" : { } - } - } - }, - "DIFProofProposal" : { - "type" : "object", - "properties" : { - "input_descriptors" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/InputDescriptors" - } - } - } - }, - "DIFProofRequest" : { - "type" : "object", - "required" : [ "presentation_definition" ], - "properties" : { - "options" : { - "$ref" : "#/definitions/DIFOptions" - }, - "presentation_definition" : { - "$ref" : "#/definitions/PresentationDefinition" - } - } - }, - "Date" : { - "type" : "object", - "required" : [ "expires_time" ], - "properties" : { - "expires_time" : { - "type" : "string", - "format" : "date-time", - "example" : "2021-03-29T05:22:19Z", - "description" : "Expiry Date" - } - } - }, - "Doc" : { - "type" : "object", - "required" : [ "credential", "options" ], - "properties" : { - "credential" : { - "type" : "object", - "description" : "Credential to sign", - "properties" : { } - }, - "options" : { - "$ref" : "#/definitions/Doc_options" - } - } - }, - "EndorserInfo" : { - "type" : "object", - "required" : [ "endorser_did" ], - "properties" : { - "endorser_did" : { - "type" : "string", - "description" : "Endorser DID" - }, - "endorser_name" : { - "type" : "string", - "description" : "Endorser Name" - } - } - }, - "EndpointsResult" : { - "type" : "object", - "properties" : { - "my_endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "My endpoint", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - }, - "their_endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Their endpoint", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - }, - "Filter" : { - "type" : "object", - "properties" : { - "const" : { - "description" : "Const" - }, - "enum" : { - "type" : "array", - "items" : { - "description" : "Enum" - } - }, - "exclusiveMaximum" : { - "description" : "ExclusiveMaximum" - }, - "exclusiveMinimum" : { - "description" : "ExclusiveMinimum" - }, - "format" : { - "type" : "string", - "description" : "Format" - }, - "maxLength" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Max Length" - }, - "maximum" : { - "description" : "Maximum" - }, - "minLength" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Min Length" - }, - "minimum" : { - "description" : "Minimum" - }, - "not" : { - "type" : "boolean", - "example" : false, - "description" : "Not" - }, - "pattern" : { - "type" : "string", - "description" : "Pattern" - }, - "type" : { - "type" : "string", - "description" : "Type" - } - } - }, - "Generated" : { - "type" : "object", - "properties" : { - "master_secret" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "number" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "remainder" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - } - } - }, - "GetDIDEndpointResponse" : { - "type" : "object", - "properties" : { - "endpoint" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Full verification key", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", - "x-nullable" : true - } - } - }, - "GetDIDVerkeyResponse" : { - "type" : "object", - "properties" : { - "verkey" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Full verification key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", - "x-nullable" : true - } - } - }, - "GetNymRoleResponse" : { - "type" : "object", - "properties" : { - "role" : { - "type" : "string", - "example" : "ENDORSER", - "description" : "Ledger role", - "enum" : [ "STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE" ] - } - } - }, - "HolderModuleResponse" : { - "type" : "object" - }, - "IndyAttrValue" : { - "type" : "object", - "required" : [ "encoded", "raw" ], - "properties" : { - "encoded" : { - "type" : "string", - "example" : "0", - "description" : "Attribute encoded value", - "pattern" : "^[0-9]*$" - }, - "raw" : { - "type" : "string", - "description" : "Attribute raw value" - } - } - }, - "IndyCredAbstract" : { - "type" : "object", - "required" : [ "cred_def_id", "key_correctness_proof", "nonce", "schema_id" ], - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "key_correctness_proof" : { - "$ref" : "#/definitions/IndyCredAbstract_key_correctness_proof" - }, - "nonce" : { - "type" : "string", - "example" : "0", - "description" : "Nonce in credential abstract", - "pattern" : "^[0-9]*$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "IndyCredInfo" : { - "type" : "object", - "properties" : { - "attrs" : { - "type" : "object", - "description" : "Attribute names and value", - "additionalProperties" : { - "type" : "string", - "example" : "alice" + "type" : { + "description" : "Attachment type", + "enum" : [ "credential-offer", "present-proof" ], + "example" : "present-proof", + "type" : "string" } }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "cred_rev_id" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier", - "pattern" : "^[1-9][0-9]*$", - "x-nullable" : true - }, - "referent" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Wallet referent" - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable" : true - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "IndyCredPrecis" : { - "type" : "object", - "properties" : { - "cred_info" : { - "$ref" : "#/definitions/IndyCredPrecis_cred_info" - }, - "interval" : { - "$ref" : "#/definitions/IndyCredPrecis_interval" - }, - "presentation_referents" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "1_age_uuid", - "description" : "presentation referent" - } - } - } - }, - "IndyCredRequest" : { - "type" : "object", - "required" : [ "blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce" ], - "properties" : { - "blinded_ms" : { - "type" : "object", - "description" : "Blinded master secret", - "properties" : { } - }, - "blinded_ms_correctness_proof" : { - "type" : "object", - "description" : "Blinded master secret correctness proof", - "properties" : { } - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "nonce" : { - "type" : "string", - "example" : "0", - "description" : "Nonce in credential request", - "pattern" : "^[0-9]*$" - }, - "prover_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Prover DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - } - } - }, - "IndyCredential" : { - "type" : "object", - "required" : [ "cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values" ], - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "rev_reg" : { - "type" : "object", - "description" : "Revocation registry state", - "properties" : { }, - "x-nullable" : true - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable" : true - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "signature" : { - "type" : "object", - "description" : "Credential signature", - "properties" : { } - }, - "signature_correctness_proof" : { - "type" : "object", - "description" : "Credential signature correctness proof", - "properties" : { } - }, - "values" : { - "type" : "object", - "description" : "Credential attributes", - "additionalProperties" : { - "type" : "object", - "description" : "Attribute value", - "allOf" : [ { - "$ref" : "#/definitions/IndyAttrValue" - } ] - } - }, - "witness" : { - "type" : "object", - "description" : "Witness for revocation proof", - "properties" : { }, - "x-nullable" : true - } - } - }, - "IndyEQProof" : { - "type" : "object", - "properties" : { - "a_prime" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "e" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "m" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" + "type" : "object" + }, + "AttributeMimeTypesResult" : { + "properties" : { + "results" : { + "additionalProperties" : { + "description" : "MIME type", + "type" : "string" + }, + "nullable" : true, + "type" : "object" } }, - "m2" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "revealed_attrs" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" + "type" : "object" + }, + "BasicMessageModuleResponse" : { + "type" : "object" + }, + "ClaimFormat" : { + "properties" : { + "jwt" : { + "properties" : { }, + "type" : "object" + }, + "jwt_vc" : { + "properties" : { }, + "type" : "object" + }, + "jwt_vp" : { + "properties" : { }, + "type" : "object" + }, + "ldp" : { + "properties" : { }, + "type" : "object" + }, + "ldp_vc" : { + "properties" : { }, + "type" : "object" + }, + "ldp_vp" : { + "properties" : { }, + "type" : "object" } }, - "v" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - } - } - }, - "IndyGEProof" : { - "type" : "object", - "properties" : { - "alpha" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "mj" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - }, - "predicate" : { - "$ref" : "#/definitions/IndyGEProofPred" - }, - "r" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" + "type" : "object" + }, + "ClearPendingRevocationsRequest" : { + "properties" : { + "purge" : { + "additionalProperties" : { + "items" : { + "description" : "Credential revocation identifier", + "example" : "12345", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "type" : "array" + }, + "description" : "Credential revocation ids by revocation registry id: omit for all, specify null or empty list for all pending per revocation registry", + "type" : "object" } }, - "t" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" + "type" : "object" + }, + "ConnRecord" : { + "properties" : { + "accept" : { + "description" : "Connection acceptance: manual or auto", + "enum" : [ "manual", "auto" ], + "example" : "auto", + "type" : "string" + }, + "alias" : { + "description" : "Optional alias to apply to connection for later use", + "example" : "Bob, providing quotes", + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "connection_protocol" : { + "description" : "Connection protocol used", + "enum" : [ "connections/1.0", "didexchange/1.0" ], + "example" : "connections/1.0", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "error_msg" : { + "description" : "Error message", + "example" : "No DIDDoc provided; cannot connect to public DID", + "type" : "string" + }, + "inbound_connection_id" : { + "description" : "Inbound routing connection id to use", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "invitation_key" : { + "description" : "Public key for connection", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "invitation_mode" : { + "description" : "Invitation mode", + "enum" : [ "once", "multi", "static" ], + "example" : "once", + "type" : "string" + }, + "invitation_msg_id" : { + "description" : "ID of out-of-band invitation message", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "my_did" : { + "description" : "Our DID for connection", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "request_id" : { + "description" : "Connection request identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "rfc23_state" : { + "description" : "State per RFC 23", + "example" : "invitation-sent", + "readOnly" : true, + "type" : "string" + }, + "routing_state" : { + "description" : "Routing state of connection", + "enum" : [ "none", "request", "active", "error" ], + "example" : "active", + "type" : "string" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "their_did" : { + "description" : "Their DID for connection", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "their_label" : { + "description" : "Their label for connection", + "example" : "Bob", + "type" : "string" + }, + "their_public_did" : { + "description" : "Other agent's public DID for connection", + "example" : "2cpBmR3FqGKWi5EyUbpRY8", + "type" : "string" + }, + "their_role" : { + "description" : "Their role in the connection protocol", + "enum" : [ "invitee", "requester", "inviter", "responder" ], + "example" : "requester", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" } }, - "u" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "0", - "pattern" : "^[0-9]*$" - } - } - } - }, - "IndyGEProofPred" : { - "type" : "object", - "properties" : { - "attr_name" : { - "type" : "string", - "description" : "Attribute name, indy-canonicalized" - }, - "p_type" : { - "type" : "string", - "description" : "Predicate type", - "enum" : [ "LT", "LE", "GE", "GT" ] - }, - "value" : { - "type" : "integer", - "format" : "int32", - "description" : "Predicate threshold value" - } - } - }, - "IndyKeyCorrectnessProof" : { - "type" : "object", - "required" : [ "c", "xr_cap", "xz_cap" ], - "properties" : { - "c" : { - "type" : "string", - "example" : "0", - "description" : "c in key correctness proof", - "pattern" : "^[0-9]*$" - }, - "xr_cap" : { - "type" : "array", - "description" : "xr_cap in key correctness proof", - "items" : { - "type" : "array", - "description" : "xr_cap components in key correctness proof", + "type" : "object" + }, + "ConnectionInvitation" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "did" : { + "description" : "DID for connection invitation", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "imageUrl" : { + "description" : "Optional image URL for connection invitation", + "example" : "http://192.168.56.101/img/logo.jpg", + "format" : "url", + "nullable" : true, + "type" : "string" + }, + "label" : { + "description" : "Optional label for connection invitation", + "example" : "Bob", + "type" : "string" + }, + "recipientKeys" : { + "description" : "List of recipient keys", "items" : { - "type" : "string", - "description" : "xr_cap component values in key correctness proof" - } - } - }, - "xz_cap" : { - "type" : "string", - "example" : "0", - "description" : "xz_cap in key correctness proof", - "pattern" : "^[0-9]*$" - } - } - }, - "IndyNonRevocProof" : { - "type" : "object", - "properties" : { - "c_list" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - }, - "x_list" : { - "type" : "object", - "additionalProperties" : { - "type" : "string" - } - } - } - }, - "IndyNonRevocationInterval" : { - "type" : "object", - "properties" : { - "from" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Earliest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - }, - "to" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Latest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "IndyPresAttrSpec" : { - "type" : "object", - "required" : [ "name" ], - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "mime-type" : { - "type" : "string", - "example" : "image/jpeg", - "description" : "MIME type (default null)" - }, - "name" : { - "type" : "string", - "example" : "favourite_drink", - "description" : "Attribute name" - }, - "referent" : { - "type" : "string", - "example" : "0", - "description" : "Credential referent" - }, - "value" : { - "type" : "string", - "example" : "martini", - "description" : "Attribute value" - } - } - }, - "IndyPresPredSpec" : { - "type" : "object", - "required" : [ "name", "predicate", "threshold" ], - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "name" : { - "type" : "string", - "example" : "high_score", - "description" : "Attribute name" - }, - "predicate" : { - "type" : "string", - "example" : ">=", - "description" : "Predicate type ('<', '<=', '>=', or '>')", - "enum" : [ "<", "<=", ">=", ">" ] - }, - "threshold" : { - "type" : "integer", - "format" : "int32", - "description" : "Threshold value" - } - } - }, - "IndyPresPreview" : { - "type" : "object", - "required" : [ "attributes", "predicates" ], - "properties" : { - "@type" : { - "type" : "string", - "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", - "description" : "Message type identifier" - }, - "attributes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/IndyPresAttrSpec" - } - }, - "predicates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/IndyPresPredSpec" - } - } - } - }, - "IndyPresSpec" : { - "type" : "object", - "required" : [ "requested_attributes", "requested_predicates", "self_attested_attributes" ], - "properties" : { - "requested_attributes" : { - "type" : "object", - "description" : "Nested object mapping proof request attribute referents to requested-attribute specifiers", - "additionalProperties" : { - "$ref" : "#/definitions/IndyRequestedCredsRequestedAttr" - } - }, - "requested_predicates" : { - "type" : "object", - "description" : "Nested object mapping proof request predicate referents to requested-predicate specifiers", - "additionalProperties" : { - "$ref" : "#/definitions/IndyRequestedCredsRequestedPred" - } - }, - "self_attested_attributes" : { - "type" : "object", - "description" : "Self-attested attributes to build into proof", - "additionalProperties" : { - "type" : "string", - "example" : "self_attested_value", - "description" : "Self-attested attribute values to use in requested-credentials structure for proof construction" - } - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "IndyPrimaryProof" : { - "type" : "object", - "properties" : { - "eq_proof" : { - "$ref" : "#/definitions/IndyPrimaryProof_eq_proof" - }, - "ge_proofs" : { - "type" : "array", - "description" : "Indy GE proofs", - "items" : { - "$ref" : "#/definitions/IndyGEProof" - }, - "x-nullable" : true - } - } - }, - "IndyProof" : { - "type" : "object", - "properties" : { - "identifiers" : { - "type" : "array", - "description" : "Indy proof.identifiers content", - "items" : { - "$ref" : "#/definitions/IndyProofIdentifier" - } - }, - "proof" : { - "$ref" : "#/definitions/IndyProof_proof" - }, - "requested_proof" : { - "$ref" : "#/definitions/IndyProof_requested_proof" - } - } - }, - "IndyProofIdentifier" : { - "type" : "object", - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", - "x-nullable" : true - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "timestamp" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Timestamp epoch", - "minimum" : 0, - "maximum" : 18446744073709551615, - "x-nullable" : true - } - } - }, - "IndyProofProof" : { - "type" : "object", - "properties" : { - "aggregated_proof" : { - "$ref" : "#/definitions/IndyProofProof_aggregated_proof" - }, - "proofs" : { - "type" : "array", - "description" : "Indy proof proofs", - "items" : { - "$ref" : "#/definitions/IndyProofProofProofsProof" - } - } - } - }, - "IndyProofProofAggregatedProof" : { - "type" : "object", - "properties" : { - "c_hash" : { - "type" : "string", - "description" : "c_hash value" - }, - "c_list" : { - "type" : "array", - "description" : "c_list value", - "items" : { - "type" : "array", + "description" : "Recipient public key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "routingKeys" : { + "description" : "List of routing keys", "items" : { - "type" : "integer", - "format" : "int32" - } - } - } - } - }, - "IndyProofProofProofsProof" : { - "type" : "object", - "properties" : { - "non_revoc_proof" : { - "$ref" : "#/definitions/IndyProofProofProofsProof_non_revoc_proof" - }, - "primary_proof" : { - "$ref" : "#/definitions/IndyProofProofProofsProof_primary_proof" - } - } - }, - "IndyProofReqAttrSpec" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "example" : "favouriteDrink", - "description" : "Attribute name" - }, - "names" : { - "type" : "array", - "description" : "Attribute name group", - "items" : { - "type" : "string", - "example" : "age" - } - }, - "non_revoked" : { - "$ref" : "#/definitions/IndyProofReqAttrSpec_non_revoked" - }, - "restrictions" : { - "type" : "array", - "description" : "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" - } - } - } - } - }, - "IndyProofReqAttrSpecNonRevoked" : { - "type" : "object", - "properties" : { - "from" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Earliest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - }, - "to" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Latest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "IndyProofReqPredSpec" : { - "type" : "object", - "required" : [ "name", "p_type", "p_value" ], - "properties" : { - "name" : { - "type" : "string", - "example" : "index", - "description" : "Attribute name" - }, - "non_revoked" : { - "$ref" : "#/definitions/IndyProofReqAttrSpec_non_revoked" - }, - "p_type" : { - "type" : "string", - "example" : ">=", - "description" : "Predicate type ('<', '<=', '>=', or '>')", - "enum" : [ "<", "<=", ">=", ">" ] - }, - "p_value" : { - "type" : "integer", - "format" : "int32", - "description" : "Threshold value" - }, - "restrictions" : { - "type" : "array", - "description" : "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", - "items" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag" - } - } - } - } - }, - "IndyProofReqPredSpecNonRevoked" : { - "type" : "object", - "properties" : { - "from" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Earliest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - }, - "to" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Latest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "IndyProofRequest" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "example" : "Proof request", - "description" : "Proof request name" - }, - "non_revoked" : { - "$ref" : "#/definitions/IndyProofReqAttrSpec_non_revoked" - }, - "nonce" : { - "type" : "string", - "example" : "1", - "description" : "Nonce", - "pattern" : "^[1-9][0-9]*$" - }, - "requested_attributes" : { - "type" : "object", - "description" : "Requested attribute specifications of proof request", - "additionalProperties" : { - "$ref" : "#/definitions/IndyProofReqAttrSpec" - } - }, - "requested_predicates" : { - "type" : "object", - "description" : "Requested predicate specifications of proof request", - "additionalProperties" : { - "$ref" : "#/definitions/IndyProofReqPredSpec" - } - }, - "version" : { - "type" : "string", - "example" : "1.0", - "description" : "Proof request version", - "pattern" : "^[0-9.]+$" - } - } - }, - "IndyProofRequestNonRevoked" : { - "type" : "object", - "properties" : { - "from" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Earliest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - }, - "to" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Latest time of interest in non-revocation interval", - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "IndyProofRequestedProof" : { - "type" : "object", - "properties" : { - "predicates" : { - "type" : "object", - "description" : "Proof requested proof predicates.", - "additionalProperties" : { - "$ref" : "#/definitions/IndyProofRequestedProofPredicate" - } - }, - "revealed_attr_groups" : { - "type" : "object", - "description" : "Proof requested proof revealed attribute groups", - "additionalProperties" : { - "$ref" : "#/definitions/IndyProofRequestedProofRevealedAttrGroup" - }, - "x-nullable" : true - }, - "revealed_attrs" : { - "type" : "object", - "description" : "Proof requested proof revealed attributes", - "additionalProperties" : { - "$ref" : "#/definitions/IndyProofRequestedProofRevealedAttr" - }, - "x-nullable" : true - }, - "self_attested_attrs" : { - "type" : "object", - "description" : "Proof requested proof self-attested attributes", - "properties" : { } - }, - "unrevealed_attrs" : { - "type" : "object", - "description" : "Unrevealed attributes", - "properties" : { } - } - } - }, - "IndyProofRequestedProofPredicate" : { - "type" : "object", - "properties" : { - "sub_proof_index" : { - "type" : "integer", - "format" : "int32", - "description" : "Sub-proof index" - } - } - }, - "IndyProofRequestedProofRevealedAttr" : { - "type" : "object", - "properties" : { - "encoded" : { - "type" : "string", - "example" : "0", - "description" : "Encoded value", - "pattern" : "^[0-9]*$" - }, - "raw" : { - "type" : "string", - "description" : "Raw value" - }, - "sub_proof_index" : { - "type" : "integer", - "format" : "int32", - "description" : "Sub-proof index" - } - } - }, - "IndyProofRequestedProofRevealedAttrGroup" : { - "type" : "object", - "properties" : { - "sub_proof_index" : { - "type" : "integer", - "format" : "int32", - "description" : "Sub-proof index" - }, - "values" : { - "type" : "object", - "description" : "Indy proof requested proof revealed attr groups group value", - "additionalProperties" : { - "$ref" : "#/definitions/RawEncoded" - } - } - } - }, - "IndyRequestedCredsRequestedAttr" : { - "type" : "object", - "required" : [ "cred_id" ], - "properties" : { - "cred_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Wallet credential identifier (typically but not necessarily a UUID)" - }, - "revealed" : { - "type" : "boolean", - "description" : "Whether to reveal attribute in proof (default true)" - } - } - }, - "IndyRequestedCredsRequestedPred" : { - "type" : "object", - "required" : [ "cred_id" ], - "properties" : { - "cred_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Wallet credential identifier (typically but not necessarily a UUID)" - }, - "timestamp" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "description" : "Epoch timestamp of interest for non-revocation proof", - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "IndyRevRegDef" : { - "type" : "object", - "properties" : { - "credDefId" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Indy revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "revocDefType" : { - "type" : "string", - "example" : "CL_ACCUM", - "description" : "Revocation registry type (specify CL_ACCUM)", - "enum" : [ "CL_ACCUM" ] - }, - "tag" : { - "type" : "string", - "description" : "Revocation registry tag" - }, - "value" : { - "$ref" : "#/definitions/IndyRevRegDef_value" - }, - "ver" : { - "type" : "string", - "example" : "1.0", - "description" : "Version of revocation registry definition", - "pattern" : "^[0-9.]+$" - } - } - }, - "IndyRevRegDefValue" : { - "type" : "object", - "properties" : { - "issuanceType" : { - "type" : "string", - "description" : "Issuance type", - "enum" : [ "ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT" ] - }, - "maxCredNum" : { - "type" : "integer", - "format" : "int32", - "example" : 10, - "description" : "Maximum number of credentials; registry size", - "minimum" : 1 - }, - "publicKeys" : { - "$ref" : "#/definitions/IndyRevRegDefValue_publicKeys" - }, - "tailsHash" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Tails hash value", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "tailsLocation" : { - "type" : "string", - "description" : "Tails file location" - } - } - }, - "IndyRevRegDefValuePublicKeys" : { - "type" : "object", - "properties" : { - "accumKey" : { - "$ref" : "#/definitions/IndyRevRegDefValuePublicKeysAccumKey" - } - } - }, - "IndyRevRegDefValuePublicKeysAccumKey" : { - "type" : "object", - "properties" : { - "z" : { - "type" : "string", - "example" : "1 120F522F81E6B7 1 09F7A59005C4939854", - "description" : "Value for z" - } - } - }, - "IndyRevRegEntry" : { - "type" : "object", - "properties" : { - "value" : { - "$ref" : "#/definitions/IndyRevRegEntry_value" - }, - "ver" : { - "type" : "string", - "example" : "1.0", - "description" : "Version of revocation registry entry", - "pattern" : "^[0-9.]+$" - } - } - }, - "IndyRevRegEntryValue" : { - "type" : "object", - "properties" : { - "accum" : { - "type" : "string", - "example" : "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", - "description" : "Accumulator value" - }, - "prevAccum" : { - "type" : "string", - "example" : "21 137AC810975E4 6 76F0384B6F23", - "description" : "Previous accumulator value" - }, - "revoked" : { - "type" : "array", - "description" : "Revoked credential revocation identifiers", - "items" : { - "type" : "integer", - "format" : "int32" - } - } - } - }, - "InputDescriptors" : { - "type" : "object", - "properties" : { - "constraints" : { - "$ref" : "#/definitions/Constraints" - }, - "group" : { - "type" : "array", - "items" : { - "type" : "string", - "description" : "Group" - } - }, - "id" : { - "type" : "string", - "description" : "ID" - }, - "metadata" : { - "type" : "object", - "description" : "Metadata dictionary", - "properties" : { } - }, - "name" : { - "type" : "string", - "description" : "Name" - }, - "purpose" : { - "type" : "string", - "description" : "Purpose" - } - } - }, - "IntroModuleResponse" : { - "type" : "object" - }, - "InvitationCreateRequest" : { - "type" : "object", - "properties" : { - "alias" : { - "type" : "string", - "example" : "Barry", - "description" : "Alias for connection" - }, - "attachments" : { - "type" : "array", - "description" : "Optional invitation attachments", - "items" : { - "$ref" : "#/definitions/AttachmentDef" - } - }, - "handshake_protocols" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", - "description" : "Handshake protocol to specify in invitation" - } - }, - "accept" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "didcomm/aip1", - "description" : "Mime type list in order of preference to be used in response" - } - }, - "mediation_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Identifier for active mediation record to be used", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, - "metadata" : { - "type" : "object", - "description" : "Optional metadata to attach to the connection created with the invitation", - "properties" : { } - }, - "my_label" : { - "type" : "string", - "example" : "Invitation to Barry", - "description" : "Label for connection invitation" - }, - "use_public_did" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to use public DID in invitation" - } - } - }, - "InvitationMessage" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "handshake_protocols" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", - "description" : "Handshake protocol" - } - }, - "accept" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "didcomm/aip1", - "description" : "Mime type list in order of preference to be used in response" - } - }, - "label" : { - "type" : "string", - "example" : "Bob", - "description" : "Optional label" - }, - "requests~attach" : { - "type" : "array", - "description" : "Optional request attachment", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - }, - "services" : { - "type" : "array", - "example" : [ { - "did" : "WgWxqztrNooG92RXvxSTWv", - "id" : "string", - "recipientKeys" : [ "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" ], - "routingKeys" : [ "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" ], - "serviceEndpoint" : "http://192.168.56.101:8020", - "type" : "string" - }, "did:sov:WgWxqztrNooG92RXvxSTWv" ], - "items" : { - "description" : "Either a DIDComm service object (as per RFC0067) or a DID string." - } - } - } - }, - "InvitationRecord" : { - "type" : "object", - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "invi_msg_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Invitation message identifier" - }, - "invitation" : { - "$ref" : "#/definitions/InvitationRecord_invitation" - }, - "invitation_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Invitation record identifier" - }, - "invitation_url" : { - "type" : "string", - "example" : "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", - "description" : "Invitation message URL" - }, - "state" : { - "type" : "string", - "example" : "await_response", - "description" : "Out of band message exchange state" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "InvitationResult" : { - "type" : "object", - "properties" : { - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "invitation" : { - "$ref" : "#/definitions/ConnectionInvitation" - }, - "invitation_url" : { - "type" : "string", - "example" : "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", - "description" : "Invitation URL" - } - } - }, - "IssueCredentialModuleResponse" : { - "type" : "object" - }, - "IssuerCredRevRecord" : { - "type" : "object", - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "cred_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential exchange record identifier at credential issue" - }, - "cred_rev_id" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier", - "pattern" : "^[1-9][0-9]*$" - }, - "record_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Issuer credential revocation record identifier" - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state" : { - "type" : "string", - "example" : "issued", - "description" : "Issue credential revocation record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "IssuerRevRegRecord" : { - "type" : "object", - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "error_msg" : { - "type" : "string", - "example" : "Revocation registry undefined", - "description" : "Error message" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "max_cred_num" : { - "type" : "integer", - "format" : "int32", - "example" : 1000, - "description" : "Maximum number of credentials for revocation registry" - }, - "pending_pub" : { - "type" : "array", - "description" : "Credential revocation identifier for credential revoked and pending publication to ledger", - "items" : { - "type" : "string", - "example" : "23" - } - }, - "record_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Issuer revocation registry record identifier" - }, - "revoc_def_type" : { - "type" : "string", - "example" : "CL_ACCUM", - "description" : "Revocation registry type (specify CL_ACCUM)", - "enum" : [ "CL_ACCUM" ] - }, - "revoc_reg_def" : { - "$ref" : "#/definitions/IssuerRevRegRecord_revoc_reg_def" - }, - "revoc_reg_entry" : { - "$ref" : "#/definitions/IssuerRevRegRecord_revoc_reg_entry" - }, - "revoc_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Issue revocation registry record state" - }, - "tag" : { - "type" : "string", - "description" : "Tag within issuer revocation registry identifier" - }, - "tails_hash" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Tails hash", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - }, - "tails_local_path" : { - "type" : "string", - "description" : "Local path to tails file" - }, - "tails_public_uri" : { - "type" : "string", - "description" : "Public URI for tails file" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "Keylist" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "List of keylist records", - "items" : { - "$ref" : "#/definitions/RouteRecord" - } - } - } - }, - "KeylistQuery" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "filter" : { - "type" : "object", - "example" : { - "filter" : { } - }, - "description" : "Query dictionary object", - "properties" : { } - }, - "paginate" : { - "$ref" : "#/definitions/KeylistQuery_paginate" - } - } - }, - "KeylistQueryFilterRequest" : { - "type" : "object", - "properties" : { - "filter" : { - "type" : "object", - "description" : "Filter for keylist query", - "properties" : { } - } - } - }, - "KeylistQueryPaginate" : { - "type" : "object", - "properties" : { - "limit" : { - "type" : "integer", - "format" : "int32", - "example" : 30, - "description" : "Limit for keylist query" - }, - "offset" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Offset value for query" - } - } - }, - "KeylistUpdate" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "updates" : { - "type" : "array", - "description" : "List of update rules", - "items" : { - "$ref" : "#/definitions/KeylistUpdateRule" - } - } - } - }, - "KeylistUpdateRequest" : { - "type" : "object", - "properties" : { - "updates" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/KeylistUpdateRule" - } - } - } - }, - "KeylistUpdateRule" : { - "type" : "object", - "required" : [ "action", "recipient_key" ], - "properties" : { - "action" : { - "type" : "string", - "example" : "add", - "description" : "Action for specific key", - "enum" : [ "add", "remove" ] - }, - "recipient_key" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Key to remove or add", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - } - }, - "LDProofVCDetail" : { - "type" : "object", - "required" : [ "credential", "options" ], - "properties" : { - "credential" : { - "$ref" : "#/definitions/LDProofVCDetail_credential" - }, - "options" : { - "$ref" : "#/definitions/LDProofVCDetail_options" - } - } - }, - "LDProofVCDetailOptions" : { - "type" : "object", - "required" : [ "proofType" ], - "properties" : { - "challenge" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)" - }, - "created" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "credentialStatus" : { - "$ref" : "#/definitions/LDProofVCDetailOptions_credentialStatus" - }, - "domain" : { - "type" : "string", - "example" : "example.com", - "description" : "The intended domain of validity for the proof" - }, - "proofPurpose" : { - "type" : "string", - "example" : "assertionMethod", - "description" : "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification" - }, - "proofType" : { - "type" : "string", - "example" : "Ed25519Signature2018", - "description" : "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry" - } - } - }, - "LedgerModulesResult" : { - "type" : "object" - }, - "LinkedDataProof" : { - "type" : "object", - "required" : [ "created", "proofPurpose", "type", "verificationMethod" ], - "properties" : { - "challenge" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Associates a challenge with a proof, for use with a proofPurpose such as authentication" - }, - "created" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "domain" : { - "type" : "string", - "example" : "example.com", - "description" : "A string value specifying the restricted domain of the signature.", - "pattern" : "\\w+:(\\/?\\/?)[^\\s]+" - }, - "jws" : { - "type" : "string", - "example" : "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", - "description" : "Associates a Detached Json Web Signature with a proof" - }, - "nonce" : { - "type" : "string", - "example" : "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", - "description" : "The nonce" - }, - "proofPurpose" : { - "type" : "string", - "example" : "assertionMethod", - "description" : "Proof purpose" - }, - "proofValue" : { - "type" : "string", - "example" : "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", - "description" : "The proof value of a proof" - }, - "type" : { - "type" : "string", - "example" : "Ed25519Signature2018", - "description" : "Identifies the digital signature suite that was used to create the signature" - }, - "verificationMethod" : { - "type" : "string", - "example" : "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", - "description" : "Information used for proof verification", - "pattern" : "\\w+:(\\/?\\/?)[^\\s]+" - } - } - }, - "MediationCreateRequest" : { - "type" : "object", - "properties" : { - "mediator_terms" : { - "type" : "array", - "description" : "List of mediator rules for recipient", - "items" : { - "type" : "string", - "description" : "Indicate terms to which the mediator requires the recipient to agree" - } - }, - "recipient_terms" : { - "type" : "array", - "description" : "List of recipient rules for mediation", - "items" : { - "type" : "string", - "description" : "Indicate terms to which the recipient requires the mediator to agree" + "description" : "Routing key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "serviceEndpoint" : { + "description" : "Service endpoint at which to reach this agent", + "example" : "http://192.168.56.101:8020", + "type" : "string" } - } - } - }, - "MediationDeny" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "mediator_terms" : { - "type" : "array", - "items" : { - "type" : "string", - "description" : "Terms for mediator to agree" + "type" : "object" + }, + "ConnectionList" : { + "properties" : { + "results" : { + "description" : "List of connection records", + "items" : { + "$ref" : "#/components/schemas/ConnRecord" + }, + "type" : "array" } }, - "recipient_terms" : { - "type" : "array", - "items" : { - "type" : "string", - "description" : "Terms for recipient to agree" + "type" : "object" + }, + "ConnectionMetadata" : { + "properties" : { + "results" : { + "description" : "Dictionary of metadata associated with connection.", + "properties" : { }, + "type" : "object" } - } - } - }, - "MediationGrant" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true }, - "endpoint" : { - "type" : "string", - "example" : "http://192.168.56.102:8020/", - "description" : "endpoint on which messages destined for the recipient are received." - }, - "routing_keys" : { - "type" : "array", - "items" : { - "type" : "string", - "description" : "Keys to use for forward message packaging" - } - } - } - }, - "MediationList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "List of mediation records", - "items" : { - "$ref" : "#/definitions/MediationRecord" + "type" : "object" + }, + "ConnectionMetadataSetRequest" : { + "properties" : { + "metadata" : { + "description" : "Dictionary of metadata to set for connection.", + "properties" : { }, + "type" : "object" } - } - } - }, - "MediationRecord" : { - "type" : "object", - "required" : [ "connection_id", "role" ], - "properties" : { - "connection_id" : { - "type" : "string" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "endpoint" : { - "type" : "string" - }, - "mediation_id" : { - "type" : "string" }, - "mediator_terms" : { - "type" : "array", - "items" : { + "required" : [ "metadata" ], + "type" : "object" + }, + "ConnectionModuleResponse" : { + "type" : "object" + }, + "ConnectionStaticRequest" : { + "properties" : { + "alias" : { + "description" : "Alias to assign to this connection", "type" : "string" - } - }, - "recipient_terms" : { - "type" : "array", - "items" : { + }, + "my_did" : { + "description" : "Local DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "my_seed" : { + "description" : "Seed to use for the local DID", + "type" : "string" + }, + "their_did" : { + "description" : "Remote DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "their_endpoint" : { + "description" : "URL endpoint for other party", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "their_label" : { + "description" : "Other party's label for this connection", + "type" : "string" + }, + "their_seed" : { + "description" : "Seed to use for the remote DID", + "type" : "string" + }, + "their_verkey" : { + "description" : "Remote verification key", "type" : "string" } }, - "role" : { - "type" : "string" - }, - "routing_keys" : { - "type" : "array", - "items" : { - "type" : "string", + "type" : "object" + }, + "ConnectionStaticResult" : { + "properties" : { + "my_did" : { + "description" : "Local DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "my_endpoint" : { + "description" : "My URL endpoint", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "my_verkey" : { + "description" : "My verification key", "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "Menu" : { - "type" : "object", - "required" : [ "options" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "description" : { - "type" : "string", - "example" : "This menu presents options", - "description" : "Introductory text for the menu" - }, - "errormsg" : { - "type" : "string", - "example" : "Error: item not found", - "description" : "An optional error message to display in menu header" - }, - "options" : { - "type" : "array", - "description" : "List of menu options", - "items" : { - "$ref" : "#/definitions/MenuOption" - } - }, - "title" : { - "type" : "string", - "example" : "My Menu", - "description" : "Menu title" - } - } - }, - "MenuForm" : { - "type" : "object", - "properties" : { - "description" : { - "type" : "string", - "example" : "Window preference settings", - "description" : "Additional descriptive text for menu form" - }, - "params" : { - "type" : "array", - "description" : "List of form parameters", - "items" : { - "$ref" : "#/definitions/MenuFormParam" - } - }, - "submit-label" : { - "type" : "string", - "example" : "Send", - "description" : "Alternative label for form submit button" - }, - "title" : { - "type" : "string", - "example" : "Preferences", - "description" : "Menu form title" - } - } - }, - "MenuFormParam" : { - "type" : "object", - "required" : [ "name", "title" ], - "properties" : { - "default" : { - "type" : "string", - "example" : "0", - "description" : "Default parameter value" - }, - "description" : { - "type" : "string", - "example" : "Delay in seconds before starting", - "description" : "Additional descriptive text for menu form parameter" - }, - "name" : { - "type" : "string", - "example" : "delay", - "description" : "Menu parameter name" - }, - "required" : { - "type" : "boolean", - "example" : false, - "description" : "Whether parameter is required" - }, - "title" : { - "type" : "string", - "example" : "Delay in seconds", - "description" : "Menu parameter title" - }, - "type" : { - "type" : "string", - "example" : "int", - "description" : "Menu form parameter input type" - } - } - }, - "MenuJson" : { - "type" : "object", - "required" : [ "options" ], - "properties" : { - "description" : { - "type" : "string", - "example" : "User preferences for window settings", - "description" : "Introductory text for the menu" - }, - "errormsg" : { - "type" : "string", - "example" : "Error: item not present", - "description" : "Optional error message to display in menu header" - }, - "options" : { - "type" : "array", - "description" : "List of menu options", - "items" : { - "$ref" : "#/definitions/MenuOption" - } - }, - "title" : { - "type" : "string", - "example" : "My Menu", - "description" : "Menu title" - } - } - }, - "MenuOption" : { - "type" : "object", - "required" : [ "name", "title" ], - "properties" : { - "description" : { - "type" : "string", - "example" : "Window display preferences", - "description" : "Additional descriptive text for menu option" - }, - "disabled" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to show option as disabled" - }, - "form" : { - "$ref" : "#/definitions/MenuForm" - }, - "name" : { - "type" : "string", - "example" : "window_prefs", - "description" : "Menu option name (unique identifier)" - }, - "title" : { - "type" : "string", - "example" : "Window Preferences", - "description" : "Menu option title" - } - } - }, - "MultitenantModuleResponse" : { - "type" : "object" - }, - "PerformRequest" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "example" : "Query", - "description" : "Menu option name" - }, - "params" : { - "type" : "object", - "description" : "Input parameter values", - "additionalProperties" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" - } - } - } - }, - "PingRequest" : { - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Comment for the ping message", - "x-nullable" : true - } - } - }, - "PingRequestResponse" : { - "type" : "object", - "properties" : { - "thread_id" : { - "type" : "string", - "description" : "Thread ID of the ping message" - } - } - }, - "PresentationDefinition" : { - "type" : "object", - "properties" : { - "format" : { - "$ref" : "#/definitions/ClaimFormat" - }, - "id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Unique Resource Identifier", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, - "input_descriptors" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/InputDescriptors" - } - }, - "name" : { - "type" : "string", - "description" : "Human-friendly name that describes what the presentation definition pertains to" - }, - "purpose" : { - "type" : "string", - "description" : "Describes the purpose for which the Presentation Definition's inputs are being requested" - }, - "submission_requirements" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SubmissionRequirements" - } - } - } - }, - "PresentationProposal" : { - "type" : "object", - "required" : [ "presentation_proposal" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "presentation_proposal" : { - "$ref" : "#/definitions/IndyPresPreview" - } - } - }, - "PresentationRequest" : { - "type" : "object", - "required" : [ "request_presentations~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "request_presentations~attach" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - } - } - }, - "PublishRevocations" : { - "type" : "object", - "properties" : { - "rrid2crid" : { - "type" : "object", - "description" : "Credential revocation ids by revocation registry id", - "additionalProperties" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier", - "pattern" : "^[1-9][0-9]*$" - } - } - } - } - }, - "QueryResult" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "object", - "description" : "Query results keyed by protocol", - "additionalProperties" : { - "type" : "object", - "description" : "Protocol descriptor", - "properties" : { } - } - } - } - }, - "RawEncoded" : { - "type" : "object", - "properties" : { - "encoded" : { - "type" : "string", - "example" : "0", - "description" : "Encoded value", - "pattern" : "^[0-9]*$" - }, - "raw" : { - "type" : "string", - "description" : "Raw value" - } - } - }, - "ReceiveInvitationRequest" : { - "type" : "object", - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "DID for connection invitation", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "imageUrl" : { - "type" : "string", - "format" : "url", - "example" : "http://192.168.56.101/img/logo.jpg", - "description" : "Optional image URL for connection invitation", - "x-nullable" : true - }, - "label" : { - "type" : "string", - "example" : "Bob", - "description" : "Optional label for connection invitation" - }, - "recipientKeys" : { - "type" : "array", - "description" : "List of recipient keys", - "items" : { - "type" : "string", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "record" : { + "$ref" : "#/components/schemas/ConnRecord" + }, + "their_did" : { + "description" : "Remote DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "their_verkey" : { + "description" : "Remote verification key", "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Recipient public key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" } }, - "routingKeys" : { - "type" : "array", - "description" : "List of routing keys", - "items" : { - "type" : "string", - "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", - "description" : "Routing key", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$" - } - }, - "serviceEndpoint" : { - "type" : "string", - "example" : "http://192.168.56.101:8020", - "description" : "Service endpoint at which to reach this agent" - } - } - }, - "RegisterLedgerNymResponse" : { - "type" : "object", - "properties" : { - "success" : { - "type" : "boolean", - "example" : true, - "description" : "Success of nym registration operation" - } - } - }, - "RemoveWalletRequest" : { - "type" : "object", - "properties" : { - "wallet_key" : { - "type" : "string", - "example" : "MySecretKey123", - "description" : "Master key used for key derivation. Only required for unmanaged wallets." - } - } - }, - "ResolutionResult" : { - "type" : "object", - "required" : [ "did_doc", "metadata" ], - "properties" : { - "did_doc" : { - "type" : "object", - "description" : "DID Document", - "properties" : { } - }, - "metadata" : { - "type" : "object", - "description" : "Resolution metadata", - "properties" : { } - } - } - }, - "RevRegCreateRequest" : { - "type" : "object", - "properties" : { - "credential_definition_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "max_cred_num" : { - "type" : "integer", - "format" : "int32", - "example" : 1000, - "description" : "Revocation registry size", - "minimum" : 4, - "maximum" : 32768 - } - } - }, - "RevRegIssuedResult" : { - "type" : "object", - "properties" : { - "result" : { - "type" : "integer", - "format" : "int32", - "example" : 0, - "description" : "Number of credentials issued against revocation registry", - "minimum" : 0 - } - } - }, - "RevRegResult" : { - "type" : "object", - "properties" : { - "result" : { - "$ref" : "#/definitions/IssuerRevRegRecord" - } - } - }, - "RevRegUpdateTailsFileUri" : { - "type" : "object", - "required" : [ "tails_public_uri" ], - "properties" : { - "tails_public_uri" : { - "type" : "string", - "format" : "url", - "example" : "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", - "description" : "Public URI to the tails file" - } - } - }, - "RevRegsCreated" : { - "type" : "object", - "properties" : { - "rev_reg_ids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifiers", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" + "required" : [ "my_did", "my_endpoint", "my_verkey", "record", "their_did", "their_verkey" ], + "type" : "object" + }, + "Constraints" : { + "properties" : { + "fields" : { + "items" : { + "$ref" : "#/components/schemas/DIFField" + }, + "type" : "array" + }, + "is_holder" : { + "items" : { + "$ref" : "#/components/schemas/DIFHolder" + }, + "type" : "array" + }, + "limit_disclosure" : { + "description" : "LimitDisclosure", + "type" : "string" + }, + "status_active" : { + "enum" : [ "required", "allowed", "disallowed" ], + "type" : "string" + }, + "status_revoked" : { + "enum" : [ "required", "allowed", "disallowed" ], + "type" : "string" + }, + "status_suspended" : { + "enum" : [ "required", "allowed", "disallowed" ], + "type" : "string" + }, + "subject_is_issuer" : { + "description" : "SubjectIsIssuer", + "enum" : [ "required", "preferred" ], + "type" : "string" } - } - } - }, - "RevocationModuleResponse" : { - "type" : "object" - }, - "RevokeRequest" : { - "type" : "object", - "properties" : { - "cred_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential exchange identifier", - "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" - }, - "cred_rev_id" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier", - "pattern" : "^[1-9][0-9]*$" - }, - "publish" : { - "type" : "boolean", - "description" : "(True) publish revocation to ledger immediately, or (default, False) mark it pending" - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - } - } - }, - "RouteRecord" : { - "type" : "object", - "required" : [ "recipient_key" ], - "properties" : { - "connection_id" : { - "type" : "string" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "recipient_key" : { - "type" : "string" - }, - "record_id" : { - "type" : "string" - }, - "role" : { - "type" : "string" - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id" : { - "type" : "string" - } - } - }, - "Schema" : { - "type" : "object", - "properties" : { - "attrNames" : { - "type" : "array", - "description" : "Schema attribute names", - "items" : { - "type" : "string", - "example" : "score", - "description" : "Attribute name" - } - }, - "id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "name" : { - "type" : "string", - "example" : "schema_name", - "description" : "Schema name" - }, - "seqNo" : { - "type" : "integer", - "format" : "int32", - "example" : 10, - "description" : "Schema sequence number", - "minimum" : 1 - }, - "ver" : { - "type" : "string", - "example" : "1.0", - "description" : "Node protocol version", - "pattern" : "^[0-9.]+$" - }, - "version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - } - } - }, - "SchemaGetResult" : { - "type" : "object", - "properties" : { - "schema" : { - "$ref" : "#/definitions/Schema" - } - } - }, - "SchemaInputDescriptor" : { - "type" : "object", - "properties" : { - "required" : { - "type" : "boolean", - "description" : "Required" - }, - "uri" : { - "type" : "string", - "description" : "URI" - } - } - }, - "SchemaSendRequest" : { - "type" : "object", - "required" : [ "attributes", "schema_name", "schema_version" ], - "properties" : { - "attributes" : { - "type" : "array", - "description" : "List of schema attributes", - "items" : { - "type" : "string", - "example" : "score", - "description" : "attribute name" - } - }, - "schema_name" : { - "type" : "string", - "example" : "prefs", - "description" : "Schema name" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - } - } - }, - "SchemaSendResult" : { - "type" : "object", - "required" : [ "schema_id" ], - "properties" : { - "schema" : { - "$ref" : "#/definitions/SchemaSendResult_schema" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - }, - "SchemasCreatedResult" : { - "type" : "object", - "properties" : { - "schema_ids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifiers", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - } - } - } - }, - "SendMenu" : { - "type" : "object", - "required" : [ "menu" ], - "properties" : { - "menu" : { - "$ref" : "#/definitions/SendMenu_menu" - } - } - }, - "SendMessage" : { - "type" : "object", - "properties" : { - "content" : { - "type" : "string", - "example" : "Hello", - "description" : "Message content" - } - } - }, - "SignRequest" : { - "type" : "object", - "required" : [ "doc", "verkey" ], - "properties" : { - "doc" : { - "$ref" : "#/definitions/Doc" - }, - "verkey" : { - "type" : "string", - "description" : "Verkey to use for signing" - } - } - }, - "SignResponse" : { - "type" : "object", - "properties" : { - "error" : { - "type" : "string", - "description" : "Error text" - }, - "signed_doc" : { - "type" : "object", - "description" : "Signed document", - "properties" : { } - } - } - }, - "SignatureOptions" : { - "type" : "object", - "required" : [ "proofPurpose", "verificationMethod" ], - "properties" : { - "challenge" : { - "type" : "string" - }, - "domain" : { - "type" : "string" - }, - "proofPurpose" : { - "type" : "string" - }, - "type" : { - "type" : "string" - }, - "verificationMethod" : { - "type" : "string" - } - } - }, - "SignedDoc" : { - "type" : "object", - "required" : [ "proof" ], - "properties" : { - "proof" : { - "$ref" : "#/definitions/SignedDoc_proof" - } - } - }, - "SubmissionRequirements" : { - "type" : "object", - "properties" : { - "count" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Count Value" - }, - "from" : { - "type" : "string", - "description" : "From" }, - "from_nested" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/SubmissionRequirements" - } - }, - "max" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Max Value" - }, - "min" : { - "type" : "integer", - "format" : "int32", - "example" : 1234, - "description" : "Min Value" - }, - "name" : { - "type" : "string", - "description" : "Name" - }, - "purpose" : { - "type" : "string", - "description" : "Purpose" - }, - "rule" : { - "type" : "string", - "description" : "Selection", - "enum" : [ "all", "pick" ] - } - } - }, - "TAAAccept" : { - "type" : "object", - "properties" : { - "mechanism" : { - "type" : "string" - }, - "text" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } - }, - "TAAAcceptance" : { - "type" : "object", - "properties" : { - "mechanism" : { - "type" : "string" - }, - "time" : { - "type" : "integer", - "format" : "int32", - "example" : 1640995199, - "minimum" : 0, - "maximum" : 18446744073709551615 - } - } - }, - "TAAInfo" : { - "type" : "object", - "properties" : { - "aml_record" : { - "$ref" : "#/definitions/AMLRecord" - }, - "taa_accepted" : { - "$ref" : "#/definitions/TAAAcceptance" - }, - "taa_record" : { - "$ref" : "#/definitions/TAARecord" - }, - "taa_required" : { - "type" : "boolean" - } - } - }, - "TAARecord" : { - "type" : "object", - "properties" : { - "digest" : { - "type" : "string" - }, - "text" : { - "type" : "string" - }, - "version" : { - "type" : "string" - } - } - }, - "TAAResult" : { - "type" : "object", - "properties" : { - "result" : { - "$ref" : "#/definitions/TAAInfo" - } - } - }, - "TransactionJobs" : { - "type" : "object", - "properties" : { - "transaction_my_job" : { - "type" : "string", - "description" : "My transaction related job", - "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ] - }, - "transaction_their_job" : { - "type" : "string", - "description" : "Their transaction related job", - "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ] - } - } - }, - "TransactionList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "List of transaction records", - "items" : { - "$ref" : "#/definitions/TransactionRecord" - } - } - } - }, - "TransactionRecord" : { - "type" : "object", - "properties" : { - "_type" : { - "type" : "string", - "example" : "101", - "description" : "Transaction type" - }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "The connection identifier for thie particular transaction record" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "endorser_write_txn" : { - "type" : "boolean", - "example" : true, - "description" : "If True, Endorser will write the transaction after endorsing it" - }, - "formats" : { - "type" : "array", - "items" : { - "type" : "object", - "example" : { - "attach_id" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "format" : "dif/endorse-transaction/request@v1.0" - }, - "additionalProperties" : { + "type" : "object" + }, + "CreateInvitationRequest" : { + "properties" : { + "mediation_id" : { + "description" : "Identifier for active mediation record to be used", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "metadata" : { + "description" : "Optional metadata to attach to the connection created with the invitation", + "properties" : { }, + "type" : "object" + }, + "my_label" : { + "description" : "Optional label for connection invitation", + "example" : "Bob", + "type" : "string" + }, + "recipient_keys" : { + "description" : "List of recipient keys", + "items" : { + "description" : "Recipient public key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", "type" : "string" - } - } - }, - "messages_attach" : { - "type" : "array", - "items" : { - "type" : "object", - "example" : { - "@id" : "143c458d-1b1c-40c7-ab85-4d16808ddf0a", - "data" : { - "json" : "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"},\"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}" - }, - "mime-type" : "application/json" }, - "properties" : { } - } - }, - "signature_request" : { - "type" : "array", - "items" : { - "type" : "object", - "example" : { - "author_goal_code" : "transaction.ledger.write", - "context" : "did:sov", - "method" : "add-signature", - "signature_type" : "", - "signer_goal_code" : "transaction.endorse" + "type" : "array" + }, + "routing_keys" : { + "description" : "List of routing keys", + "items" : { + "description" : "Routing key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" }, - "properties" : { } + "type" : "array" + }, + "service_endpoint" : { + "description" : "Connection endpoint", + "example" : "http://192.168.56.102:8020", + "type" : "string" } }, - "signature_response" : { - "type" : "array", - "items" : { - "type" : "object", - "example" : { - "context" : "did:sov", - "message_id" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "method" : "add-signature", - "signer_goal_code" : "transaction.refuse" + "type" : "object" + }, + "CreateWalletRequest" : { + "properties" : { + "image_url" : { + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "example" : "https://aries.ca/images/sample.png", + "type" : "string" + }, + "key_management_mode" : { + "description" : "Key management method to use for this wallet.", + "enum" : [ "managed" ], + "example" : "managed", + "type" : "string" + }, + "label" : { + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "example" : "Alice", + "type" : "string" + }, + "wallet_dispatch_type" : { + "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "enum" : [ "default", "both", "base" ], + "example" : "default", + "type" : "string" + }, + "wallet_key" : { + "description" : "Master key used for key derivation.", + "example" : "MySecretKey123", + "type" : "string" + }, + "wallet_key_derivation" : { + "description" : "Key derivation", + "enum" : [ "ARGON2I_MOD", "ARGON2I_INT", "RAW" ], + "example" : "RAW", + "type" : "string" + }, + "wallet_name" : { + "description" : "Wallet name", + "example" : "MyNewWallet", + "type" : "string" + }, + "wallet_type" : { + "description" : "Type of the wallet to create", + "enum" : [ "askar", "in_memory", "indy" ], + "example" : "indy", + "type" : "string" + }, + "wallet_webhook_urls" : { + "description" : "List of Webhook URLs associated with this subwallet", + "items" : { + "description" : "Optional webhook URL to receive webhook messages", + "example" : "http://localhost:8022/webhooks", + "type" : "string" }, - "properties" : { } + "type" : "array" } }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Thread Identifier" - }, - "timing" : { - "type" : "object", - "example" : { - "expires_time" : "2020-12-13T17:29:06+0000" + "type" : "object" + }, + "CreateWalletResponse" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" }, - "properties" : { } - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "transaction_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Transaction identifier" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "TxnOrCredentialDefinitionSendResult" : { - "type" : "object", - "properties" : { - "sent" : { - "$ref" : "#/definitions/CredentialDefinitionSendResult" - }, - "txn" : { - "$ref" : "#/definitions/TxnOrCredentialDefinitionSendResult_txn" - } - } - }, - "TxnOrPublishRevocationsResult" : { - "type" : "object", - "properties" : { - "sent" : { - "$ref" : "#/definitions/PublishRevocations" - }, - "txn" : { - "$ref" : "#/definitions/TxnOrPublishRevocationsResult_txn" - } - } - }, - "TxnOrRevRegResult" : { - "type" : "object", - "properties" : { - "sent" : { - "$ref" : "#/definitions/RevRegResult" - }, - "txn" : { - "$ref" : "#/definitions/TxnOrRevRegResult_txn" - } - } - }, - "TxnOrSchemaSendResult" : { - "type" : "object", - "properties" : { - "sent" : { - "$ref" : "#/definitions/TxnOrSchemaSendResult_sent" - }, - "txn" : { - "$ref" : "#/definitions/TxnOrSchemaSendResult_txn" - } - } - }, - "UpdateWalletRequest" : { - "type" : "object", - "properties" : { - "image_url" : { - "type" : "string", - "example" : "https://aries.ca/images/sample.png", - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." - }, - "label" : { - "type" : "string", - "example" : "Alice", - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." - }, - "wallet_dispatch_type" : { - "type" : "string", - "example" : "default", - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", - "enum" : [ "default", "both", "base" ] - }, - "wallet_webhook_urls" : { - "type" : "array", - "description" : "List of Webhook URLs associated with this subwallet", - "items" : { - "type" : "string", - "example" : "http://localhost:8022/webhooks", - "description" : "Optional webhook URL to receive webhook messages" - } - } - } - }, - "V10CredentialBoundOfferRequest" : { - "type" : "object", - "properties" : { - "counter_proposal" : { - "$ref" : "#/definitions/V10CredentialBoundOfferRequest_counter_proposal" - } - } - }, - "V10CredentialConnFreeOfferRequest" : { - "type" : "object", - "required" : [ "cred_def_id", "credential_preview" ], - "properties" : { - "auto_issue" : { - "type" : "boolean", - "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_preview" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialCreate" : { - "type" : "object", - "required" : [ "credential_proposal" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Credential issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Schema issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name" : { - "type" : "string", - "example" : "preferences", - "description" : "Schema name" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialExchange" : { - "type" : "object", - "properties" : { - "auto_issue" : { - "type" : "boolean", - "example" : false, - "description" : "Issuer choice to issue to request in this credential exchange" - }, - "auto_offer" : { - "type" : "boolean", - "example" : false, - "description" : "Holder choice to accept offer in this credential exchange" - }, - "auto_remove" : { - "type" : "boolean", - "example" : false, - "description" : "Issuer choice to remove this credential exchange record when complete" - }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "credential" : { - "$ref" : "#/definitions/V10CredentialExchange_credential" - }, - "credential_definition_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_exchange_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential exchange identifier" - }, - "credential_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential identifier" - }, - "credential_offer" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_offer" - }, - "credential_offer_dict" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_offer_dict" - }, - "credential_proposal_dict" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_proposal_dict" - }, - "credential_request" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_request" - }, - "credential_request_metadata" : { - "type" : "object", - "description" : "(Indy) credential request metadata", - "properties" : { } - }, - "error_msg" : { - "type" : "string", - "example" : "Credential definition identifier is not set in proposal", - "description" : "Error message" - }, - "initiator" : { - "type" : "string", - "example" : "self", - "description" : "Issue-credential exchange initiator: self or external", - "enum" : [ "self", "external" ] - }, - "parent_thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Parent thread identifier" - }, - "raw_credential" : { - "$ref" : "#/definitions/V10CredentialExchange_raw_credential" - }, - "revoc_reg_id" : { - "type" : "string", - "description" : "Revocation registry identifier" - }, - "revocation_id" : { - "type" : "string", - "description" : "Credential identifier within revocation registry" - }, - "role" : { - "type" : "string", - "example" : "issuer", - "description" : "Issue-credential exchange role: holder or issuer", - "enum" : [ "holder", "issuer" ] - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "state" : { - "type" : "string", - "example" : "credential_acked", - "description" : "Issue-credential exchange state" - }, - "thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Thread identifier" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V10CredentialExchangeListResult" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "Aries#0036 v1.0 credential exchange records", - "items" : { - "$ref" : "#/definitions/V10CredentialExchange" - } - } - } - }, - "V10CredentialFreeOfferRequest" : { - "type" : "object", - "required" : [ "connection_id", "cred_def_id", "credential_preview" ], - "properties" : { - "auto_issue" : { - "type" : "boolean", - "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_preview" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialIssueRequest" : { - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - } - } - }, - "V10CredentialProblemReportRequest" : { - "type" : "object", - "required" : [ "description" ], - "properties" : { - "description" : { - "type" : "string" - } - } - }, - "V10CredentialProposalRequestMand" : { - "type" : "object", - "required" : [ "connection_id", "credential_proposal" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Credential issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Schema issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name" : { - "type" : "string", - "example" : "preferences", - "description" : "Schema name" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialProposalRequestOpt" : { - "type" : "object", - "required" : [ "connection_id" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "credential_proposal" : { - "$ref" : "#/definitions/CredentialPreview" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Credential issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Schema issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name" : { - "type" : "string", - "example" : "preferences", - "description" : "Schema name" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V10CredentialStoreRequest" : { - "type" : "object", - "properties" : { - "credential_id" : { - "type" : "string" - } - } - }, - "V10PresentProofModuleResponse" : { - "type" : "object" - }, - "V10PresentationCreateRequestRequest" : { - "type" : "object", - "required" : [ "proof_request" ], - "properties" : { - "comment" : { - "type" : "string", - "x-nullable" : true - }, - "proof_request" : { - "$ref" : "#/definitions/IndyProofRequest" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V10PresentationExchange" : { - "type" : "object", - "properties" : { - "auto_present" : { - "type" : "boolean", - "example" : false, - "description" : "Prover choice to auto-present proof as verifier requests" - }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg" : { - "type" : "string", - "example" : "Invalid structure", - "description" : "Error message" - }, - "initiator" : { - "type" : "string", - "example" : "self", - "description" : "Present-proof exchange initiator: self or external", - "enum" : [ "self", "external" ] - }, - "presentation" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation" - }, - "presentation_exchange_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Presentation exchange identifier" - }, - "presentation_proposal_dict" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation_proposal_dict" - }, - "presentation_request" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation_request" - }, - "presentation_request_dict" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation_request_dict" - }, - "role" : { - "type" : "string", - "example" : "prover", - "description" : "Present-proof exchange role: prover or verifier", - "enum" : [ "prover", "verifier" ] - }, - "state" : { - "type" : "string", - "example" : "verified", - "description" : "Present-proof exchange state" - }, - "thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Thread identifier" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "verified" : { - "type" : "string", - "example" : "true", - "description" : "Whether presentation is verified: true or false", - "enum" : [ "true", "false" ] - } - } - }, - "V10PresentationExchangeList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "Aries RFC 37 v1.0 presentation exchange records", - "items" : { - "$ref" : "#/definitions/V10PresentationExchange" - } - } - } - }, - "V10PresentationProblemReportRequest" : { - "type" : "object", - "required" : [ "description" ], - "properties" : { - "description" : { - "type" : "string" - } - } - }, - "V10PresentationProposalRequest" : { - "type" : "object", - "required" : [ "connection_id", "presentation_proposal" ], - "properties" : { - "auto_present" : { - "type" : "boolean", - "description" : "Whether to respond automatically to presentation requests, building and presenting requested proof" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "presentation_proposal" : { - "$ref" : "#/definitions/IndyPresPreview" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V10PresentationSendRequestRequest" : { - "type" : "object", - "required" : [ "connection_id", "proof_request" ], - "properties" : { - "comment" : { - "type" : "string", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "proof_request" : { - "$ref" : "#/definitions/IndyProofRequest" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V20CredAttrSpec" : { - "type" : "object", - "required" : [ "name", "value" ], - "properties" : { - "mime-type" : { - "type" : "string", - "example" : "image/jpeg", - "description" : "MIME type: omit for (null) default", - "x-nullable" : true - }, - "name" : { - "type" : "string", - "example" : "favourite_drink", - "description" : "Attribute name" - }, - "value" : { - "type" : "string", - "example" : "martini", - "description" : "Attribute value: base64-encode if MIME type is present" - } - } - }, - "V20CredBoundOfferRequest" : { - "type" : "object", - "properties" : { - "counter_preview" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_counter_preview" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - } - } - }, - "V20CredExFree" : { - "type" : "object", - "required" : [ "connection_id", "filter" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredPreview" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V20CredExRecord" : { - "type" : "object", - "properties" : { - "auto_issue" : { - "type" : "boolean", - "example" : false, - "description" : "Issuer choice to issue to request in this credential exchange" - }, - "auto_offer" : { - "type" : "boolean", - "example" : false, - "description" : "Holder choice to accept offer in this credential exchange" - }, - "auto_remove" : { - "type" : "boolean", - "example" : false, - "description" : "Issuer choice to remove this credential exchange record when complete" - }, - "by_format" : { - "$ref" : "#/definitions/V20CredExRecord_by_format" - }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential exchange identifier" - }, - "cred_issue" : { - "$ref" : "#/definitions/V20CredExRecord_cred_issue" - }, - "cred_offer" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_offer_dict" - }, - "cred_preview" : { - "$ref" : "#/definitions/V20CredExRecord_cred_preview" - }, - "cred_proposal" : { - "$ref" : "#/definitions/V10CredentialExchange_credential_proposal_dict" - }, - "cred_request" : { - "$ref" : "#/definitions/V20CredExRecord_cred_request" - }, - "error_msg" : { - "type" : "string", - "example" : "The front fell off", - "description" : "Error message" - }, - "initiator" : { - "type" : "string", - "example" : "self", - "description" : "Issue-credential exchange initiator: self or external", - "enum" : [ "self", "external" ] - }, - "parent_thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Parent thread identifier" - }, - "role" : { - "type" : "string", - "example" : "issuer", - "description" : "Issue-credential exchange role: holder or issuer", - "enum" : [ "issuer", "holder" ] - }, - "state" : { - "type" : "string", - "example" : "done", - "description" : "Issue-credential exchange state", - "enum" : [ "proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done" ] - }, - "thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Thread identifier" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordByFormat" : { - "type" : "object", - "properties" : { - "cred_issue" : { - "type" : "object", - "properties" : { } - }, - "cred_offer" : { - "type" : "object", - "properties" : { } - }, - "cred_proposal" : { - "type" : "object", - "properties" : { } - }, - "cred_request" : { - "type" : "object", - "properties" : { } - } - } - }, - "V20CredExRecordDetail" : { - "type" : "object", - "properties" : { - "cred_ex_record" : { - "$ref" : "#/definitions/V20CredExRecordDetail_cred_ex_record" - }, - "indy" : { - "$ref" : "#/definitions/V20CredExRecordIndy" - }, - "ld_proof" : { - "$ref" : "#/definitions/V20CredExRecordLDProof" - } - } - }, - "V20CredExRecordIndy" : { - "type" : "object", - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Corresponding v2.0 credential exchange record identifier" - }, - "cred_ex_indy_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Record identifier" - }, - "cred_id_stored" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential identifier stored in wallet" - }, - "cred_request_metadata" : { - "type" : "object", - "description" : "Credential request metadata for indy holder", - "properties" : { } - }, - "cred_rev_id" : { - "type" : "string", - "example" : "12345", - "description" : "Credential revocation identifier within revocation registry", - "pattern" : "^[1-9][0-9]*$" - }, - "rev_reg_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", - "description" : "Revocation registry identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)" - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordLDProof" : { - "type" : "object", - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "cred_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Corresponding v2.0 credential exchange record identifier" - }, - "cred_ex_ld_proof_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Record identifier" - }, - "cred_id_stored" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Credential identifier stored in wallet" - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - } - } - }, - "V20CredExRecordListResult" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "Credential exchange records and corresponding detail records", - "items" : { - "$ref" : "#/definitions/V20CredExRecordDetail" - } - } - } - }, - "V20CredFilter" : { - "type" : "object", - "properties" : { - "indy" : { - "$ref" : "#/definitions/V20CredFilter_indy" - }, - "ld_proof" : { - "$ref" : "#/definitions/V20CredFilter_ld_proof" - } - } - }, - "V20CredFilterIndy" : { - "type" : "object", - "properties" : { - "cred_def_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", - "description" : "Credential definition identifier", - "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$" - }, - "issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Credential issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_id" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", - "description" : "Schema identifier", - "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$" - }, - "schema_issuer_did" : { - "type" : "string", - "example" : "WgWxqztrNooG92RXvxSTWv", - "description" : "Schema issuer DID", - "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$" - }, - "schema_name" : { - "type" : "string", - "example" : "preferences", - "description" : "Schema name" - }, - "schema_version" : { - "type" : "string", - "example" : "1.0", - "description" : "Schema version", - "pattern" : "^[0-9.]+$" - } - } - }, - "V20CredFilterLDProof" : { - "type" : "object", - "required" : [ "ld_proof" ], - "properties" : { - "ld_proof" : { - "$ref" : "#/definitions/V20CredFilter_ld_proof" - } - } - }, - "V20CredFormat" : { - "type" : "object", - "required" : [ "attach_id", "format" ], - "properties" : { - "attach_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Attachment identifier" - }, - "format" : { - "type" : "string", - "example" : "aries/ld-proof-vc-detail@v1.0", - "description" : "Attachment format specifier" - } - } - }, - "V20CredIssue" : { - "type" : "object", - "required" : [ "credentials~attach", "formats" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credentials~attach" : { - "type" : "array", - "description" : "Credential attachments", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - }, - "formats" : { - "type" : "array", - "description" : "Acceptable attachment formats", - "items" : { - "$ref" : "#/definitions/V20CredFormat" - } - }, - "replacement_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Issuer-unique identifier to coordinate credential replacement" - } - } - }, - "V20CredIssueProblemReportRequest" : { - "type" : "object", - "required" : [ "description" ], - "properties" : { - "description" : { - "type" : "string" - } - } - }, - "V20CredIssueRequest" : { - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - } - } - }, - "V20CredOffer" : { - "type" : "object", - "required" : [ "formats", "offers~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredPreview" - }, - "formats" : { - "type" : "array", - "description" : "Acceptable credential formats", - "items" : { - "$ref" : "#/definitions/V20CredFormat" - } - }, - "offers~attach" : { - "type" : "array", - "description" : "Offer attachments", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - }, - "replacement_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Issuer-unique identifier to coordinate credential replacement" - } - } - }, - "V20CredOfferConnFreeRequest" : { - "type" : "object", - "required" : [ "filter" ], - "properties" : { - "auto_issue" : { - "type" : "boolean", - "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredPreview" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V20CredOfferRequest" : { - "type" : "object", - "required" : [ "connection_id", "filter" ], - "properties" : { - "auto_issue" : { - "type" : "boolean", - "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials" - }, - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredPreview" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V20CredPreview" : { - "type" : "object", - "required" : [ "attributes" ], - "properties" : { - "@type" : { - "type" : "string", - "example" : "issue-credential/2.0/credential-preview", - "description" : "Message type identifier" - }, - "attributes" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/V20CredAttrSpec" - } - } - } - }, - "V20CredProposal" : { - "type" : "object", - "required" : [ "filters~attach", "formats" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredProposal_credential_preview" - }, - "filters~attach" : { - "type" : "array", - "description" : "Credential filter per acceptable format on corresponding identifier", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - }, - "formats" : { - "type" : "array", - "description" : "Attachment formats", - "items" : { - "$ref" : "#/definitions/V20CredFormat" - } - } - } - }, - "V20CredRequest" : { - "type" : "object", - "required" : [ "formats", "requests~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "formats" : { - "type" : "array", - "description" : "Acceptable attachment formats", - "items" : { - "$ref" : "#/definitions/V20CredFormat" - } - }, - "requests~attach" : { - "type" : "array", - "description" : "Request attachments", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - } - } - }, - "V20CredRequestFree" : { - "type" : "object", - "required" : [ "connection_id", "filter" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - }, - "holder_did" : { - "type" : "string", - "example" : "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", - "description" : "Holder DID to substitute for the credentialSubject.id", - "x-nullable" : true - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V20CredRequestRequest" : { - "type" : "object", - "properties" : { - "holder_did" : { - "type" : "string", - "example" : "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", - "description" : "Holder DID to substitute for the credentialSubject.id", - "x-nullable" : true - } - } - }, - "V20CredStoreRequest" : { - "type" : "object", - "properties" : { - "credential_id" : { - "type" : "string" - } - } - }, - "V20IssueCredSchemaCore" : { - "type" : "object", - "required" : [ "filter" ], - "properties" : { - "auto_remove" : { - "type" : "boolean", - "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "credential_preview" : { - "$ref" : "#/definitions/V20CredPreview" - }, - "filter" : { - "$ref" : "#/definitions/V20CredBoundOfferRequest_filter" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V20IssueCredentialModuleResponse" : { - "type" : "object" - }, - "V20Pres" : { - "type" : "object", - "required" : [ "formats", "presentations~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "formats" : { - "type" : "array", - "description" : "Acceptable attachment formats", - "items" : { - "$ref" : "#/definitions/V20PresFormat" - } - }, - "presentations~attach" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - } - } - }, - "V20PresCreateRequestRequest" : { - "type" : "object", - "required" : [ "presentation_request" ], - "properties" : { - "comment" : { - "type" : "string", - "x-nullable" : true - }, - "presentation_request" : { - "$ref" : "#/definitions/V20PresRequestByFormat" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V20PresExRecord" : { - "type" : "object", - "properties" : { - "auto_present" : { - "type" : "boolean", - "example" : false, - "description" : "Prover choice to auto-present proof as verifier requests" - }, - "by_format" : { - "$ref" : "#/definitions/V20PresExRecord_by_format" - }, - "connection_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "error_msg" : { - "type" : "string", - "example" : "Invalid structure", - "description" : "Error message" - }, - "initiator" : { - "type" : "string", - "example" : "self", - "description" : "Present-proof exchange initiator: self or external", - "enum" : [ "self", "external" ] - }, - "pres" : { - "$ref" : "#/definitions/V20PresExRecord_pres" - }, - "pres_ex_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Presentation exchange identifier" - }, - "pres_proposal" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation_proposal_dict" - }, - "pres_request" : { - "$ref" : "#/definitions/V10PresentationExchange_presentation_request_dict" - }, - "role" : { - "type" : "string", - "example" : "prover", - "description" : "Present-proof exchange role: prover or verifier", - "enum" : [ "prover", "verifier" ] - }, - "state" : { - "type" : "string", - "description" : "Present-proof exchange state", - "enum" : [ "proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned" ] - }, - "thread_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Thread identifier" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "verified" : { - "type" : "string", - "example" : "true", - "description" : "Whether presentation is verified: 'true' or 'false'", - "enum" : [ "true", "false" ] - } - } - }, - "V20PresExRecordByFormat" : { - "type" : "object", - "properties" : { - "pres" : { - "type" : "object", - "properties" : { } - }, - "pres_proposal" : { - "type" : "object", - "properties" : { } - }, - "pres_request" : { - "type" : "object", - "properties" : { } - } - } - }, - "V20PresExRecordList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "Presentation exchange records", - "items" : { - "$ref" : "#/definitions/V20PresExRecord" - } - } - } - }, - "V20PresFormat" : { - "type" : "object", - "required" : [ "attach_id", "format" ], - "properties" : { - "attach_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Attachment identifier" - }, - "format" : { - "type" : "string", - "example" : "dif/presentation-exchange/submission@v1.0", - "description" : "Attachment format specifier" - } - } - }, - "V20PresProblemReportRequest" : { - "type" : "object", - "required" : [ "description" ], - "properties" : { - "description" : { - "type" : "string" - } - } - }, - "V20PresProposal" : { - "type" : "object", - "required" : [ "formats", "proposals~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment" - }, - "formats" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/V20PresFormat" - } - }, - "proposals~attach" : { - "type" : "array", - "description" : "Attachment per acceptable format on corresponding identifier", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - } - } - }, - "V20PresProposalByFormat" : { - "type" : "object", - "properties" : { - "dif" : { - "$ref" : "#/definitions/V20PresProposalByFormat_dif" - }, - "indy" : { - "$ref" : "#/definitions/V20PresProposalByFormat_indy" - } - } - }, - "V20PresProposalRequest" : { - "type" : "object", - "required" : [ "connection_id", "presentation_proposal" ], - "properties" : { - "auto_present" : { - "type" : "boolean", - "description" : "Whether to respond automatically to presentation requests, building and presenting requested proof" - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "presentation_proposal" : { - "$ref" : "#/definitions/V20PresProposalByFormat" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V20PresRequest" : { - "type" : "object", - "required" : [ "formats", "request_presentations~attach" ], - "properties" : { - "@id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Message identifier" - }, - "@type" : { - "type" : "string", - "example" : "https://didcomm.org/my-family/1.0/my-message-type", - "description" : "Message type", - "readOnly" : true - }, - "comment" : { - "type" : "string", - "description" : "Human-readable comment" - }, - "formats" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/V20PresFormat" - } - }, - "request_presentations~attach" : { - "type" : "array", - "description" : "Attachment per acceptable format on corresponding identifier", - "items" : { - "$ref" : "#/definitions/AttachDecorator" - } - }, - "will_confirm" : { - "type" : "boolean", - "description" : "Whether verifier will send confirmation ack" - } - } - }, - "V20PresRequestByFormat" : { - "type" : "object", - "properties" : { - "dif" : { - "$ref" : "#/definitions/V20PresRequestByFormat_dif" - }, - "indy" : { - "$ref" : "#/definitions/V20PresRequestByFormat_indy" - } - } - }, - "V20PresSendRequestRequest" : { - "type" : "object", - "required" : [ "connection_id", "presentation_request" ], - "properties" : { - "comment" : { - "type" : "string", - "x-nullable" : true - }, - "connection_id" : { - "type" : "string", - "format" : "uuid", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Connection identifier" - }, - "presentation_request" : { - "$ref" : "#/definitions/V20PresRequestByFormat" - }, - "trace" : { - "type" : "boolean", - "example" : false, - "description" : "Whether to trace event (default false)" - } - } - }, - "V20PresSpecByFormatRequest" : { - "type" : "object", - "properties" : { - "dif" : { - "$ref" : "#/definitions/V20PresSpecByFormatRequest_dif" - }, - "indy" : { - "$ref" : "#/definitions/V20PresSpecByFormatRequest_indy" - }, - "trace" : { - "type" : "boolean", - "description" : "Record trace information, based on agent configuration" - } - } - }, - "V20PresentProofModuleResponse" : { - "type" : "object" - }, - "VCRecord" : { - "type" : "object", - "properties" : { - "contexts" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Context", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "key_management_mode" : { + "description" : "Mode regarding management of wallet key", + "enum" : [ "managed", "unmanaged" ], + "type" : "string" + }, + "settings" : { + "description" : "Settings for this wallet.", + "properties" : { }, + "type" : "object" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "token" : { + "description" : "Authorization token to authenticate wallet requests", + "example" : "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "wallet_id" : { + "description" : "Wallet record ID", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" } }, - "cred_tags" : { - "type" : "object", - "additionalProperties" : { - "type" : "string", - "description" : "Retrieval tag value" + "required" : [ "key_management_mode", "wallet_id" ], + "type" : "object" + }, + "CreateWalletTokenRequest" : { + "properties" : { + "wallet_key" : { + "description" : "Master key used for key derivation. Only required for unamanged wallets.", + "example" : "MySecretKey123", + "type" : "string" } }, - "cred_value" : { - "type" : "object", - "description" : "(JSON-serializable) credential value", - "properties" : { } - }, - "expanded_types" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "https://w3id.org/citizenship#PermanentResidentCard", - "description" : "JSON-LD expanded type extracted from type and context" + "type" : "object" + }, + "CreateWalletTokenResponse" : { + "properties" : { + "token" : { + "description" : "Authorization token to authenticate wallet requests", + "example" : "eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk", + "type" : "string" } }, - "given_id" : { - "type" : "string", - "example" : "http://example.edu/credentials/3732", - "description" : "Credential identifier" - }, - "issuer_id" : { - "type" : "string", - "example" : "https://example.edu/issuers/14", - "description" : "Issuer identifier" + "type" : "object" + }, + "CredAttrSpec" : { + "properties" : { + "mime-type" : { + "description" : "MIME type: omit for (null) default", + "example" : "image/jpeg", + "nullable" : true, + "type" : "string" + }, + "name" : { + "description" : "Attribute name", + "example" : "favourite_drink", + "type" : "string" + }, + "value" : { + "description" : "Attribute value: base64-encode if MIME type is present", + "example" : "martini", + "type" : "string" + } }, - "proof_types" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "Ed25519Signature2018", - "description" : "Signature suite used for proof" + "required" : [ "name", "value" ], + "type" : "object" + }, + "CredDefValue" : { + "properties" : { + "primary" : { + "$ref" : "#/components/schemas/CredDefValue_primary" + }, + "revocation" : { + "$ref" : "#/components/schemas/CredDefValue_revocation" } }, - "record_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Record identifier" + "type" : "object" + }, + "CredDefValuePrimary" : { + "properties" : { + "n" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "r" : { + "$ref" : "#/components/schemas/Generated" + }, + "rctxt" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "s" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "z" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + } }, - "schema_ids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "https://example.org/examples/degree.json", - "description" : "Schema identifier" + "type" : "object" + }, + "CredDefValueRevocation" : { + "properties" : { + "g" : { + "example" : "1 1F14F&ECB578F 2 095E45DDF417D", + "type" : "string" + }, + "g_dash" : { + "example" : "1 1D64716fCDC00C 1 0C781960FA66E3D3 2 095E45DDF417D", + "type" : "string" + }, + "h" : { + "example" : "1 16675DAE54BFAE8 2 095E45DD417D", + "type" : "string" + }, + "h0" : { + "example" : "1 21E5EF9476EAF18 2 095E45DDF417D", + "type" : "string" + }, + "h1" : { + "example" : "1 236D1D99236090 2 095E45DDF417D", + "type" : "string" + }, + "h2" : { + "example" : "1 1C3AE8D1F1E277 2 095E45DDF417D", + "type" : "string" + }, + "h_cap" : { + "example" : "1 1B2A32CF3167 1 2490FEBF6EE55 1 0000000000000000", + "type" : "string" + }, + "htilde" : { + "example" : "1 1D8549E8C0F8 2 095E45DDF417D", + "type" : "string" + }, + "pk" : { + "example" : "1 142CD5E5A7DC 1 153885BD903312 2 095E45DDF417D", + "type" : "string" + }, + "u" : { + "example" : "1 0C430AAB2B4710 1 1CB3A0932EE7E 1 0000000000000000", + "type" : "string" + }, + "y" : { + "example" : "1 153558BD903312 2 095E45DDF417D 1 0000000000000000", + "type" : "string" } }, - "subject_ids" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "did:example:ebfeb1f712ebc6f1c276e12ec21", - "description" : "Subject identifier" + "type" : "object" + }, + "CredInfoList" : { + "properties" : { + "results" : { + "items" : { + "$ref" : "#/components/schemas/IndyCredInfo" + }, + "type" : "array" } - } - } - }, - "VCRecordList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "items" : { - "$ref" : "#/definitions/VCRecord" + }, + "type" : "object" + }, + "CredRevIndyRecordsResult" : { + "properties" : { + "rev_reg_delta" : { + "description" : "Indy revocation registry delta", + "properties" : { }, + "type" : "object" } - } - } - }, - "VerifyRequest" : { - "type" : "object", - "required" : [ "doc" ], - "properties" : { - "doc" : { - "$ref" : "#/definitions/VerifyRequest_doc" }, - "verkey" : { - "type" : "string", - "description" : "Verkey to use for doc verification" - } - } - }, - "VerifyResponse" : { - "type" : "object", - "required" : [ "valid" ], - "properties" : { - "error" : { - "type" : "string", - "description" : "Error text" + "type" : "object" + }, + "CredRevRecordDetailsResult" : { + "properties" : { + "results" : { + "items" : { + "$ref" : "#/components/schemas/IssuerCredRevRecord" + }, + "type" : "array" + } }, - "valid" : { - "type" : "boolean" - } - } - }, - "W3CCredentialsListRequest" : { - "type" : "object", - "properties" : { - "contexts" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Credential context to match", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "type" : "object" + }, + "CredRevRecordResult" : { + "properties" : { + "result" : { + "$ref" : "#/components/schemas/IssuerCredRevRecord" } }, - "given_id" : { - "type" : "string", - "description" : "Given credential id to match" + "type" : "object" + }, + "CredRevokedResult" : { + "properties" : { + "revoked" : { + "description" : "Whether credential is revoked on the ledger", + "type" : "boolean" + } }, - "issuer_id" : { - "type" : "string", - "description" : "Credential issuer identifier to match" + "type" : "object" + }, + "Credential" : { + "properties" : { + "@context" : { + "description" : "The JSON-LD context of the credential", + "example" : [ "https://www.w3.org/2018/credentials/v1", "https://www.w3.org/2018/credentials/examples/v1" ], + "items" : { + "type" : "object" + }, + "type" : "array" + }, + "credentialSubject" : { + "example" : "", + "type" : "object" + }, + "expirationDate" : { + "description" : "The expiration date", + "example" : "2010-01-01T19:23:24Z", + "pattern" : "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", + "type" : "string" + }, + "id" : { + "example" : "http://example.edu/credentials/1872", + "pattern" : "\\w+:(\\/?\\/?)[^\\s]+", + "type" : "string" + }, + "issuanceDate" : { + "description" : "The issuance date", + "example" : "2010-01-01T19:23:24Z", + "pattern" : "^([0-9]{4})-([0-9]{2})-([0-9]{2})([Tt ]([0-9]{2}):([0-9]{2}):([0-9]{2})(\\.[0-9]+)?)?(([Zz]|([+-])([0-9]{2}):([0-9]{2})))?$", + "type" : "string" + }, + "issuer" : { + "description" : "The JSON-LD Verifiable Credential Issuer. Either string of object with id field.", + "example" : "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "type" : "object" + }, + "proof" : { + "$ref" : "#/components/schemas/Credential_proof" + }, + "type" : { + "description" : "The JSON-LD type of the credential", + "example" : [ "VerifiableCredential", "AlumniCredential" ], + "items" : { + "type" : "string" + }, + "type" : "array" + } }, - "max_results" : { - "type" : "integer", - "format" : "int32", - "description" : "Maximum number of results to return" + "required" : [ "@context", "credentialSubject", "issuanceDate", "issuer", "type" ], + "type" : "object" + }, + "CredentialDefinition" : { + "properties" : { + "id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "schemaId" : { + "description" : "Schema identifier within credential definition identifier", + "example" : "20", + "type" : "string" + }, + "tag" : { + "description" : "Tag within credential definition identifier", + "example" : "tag", + "type" : "string" + }, + "type" : { + "description" : "Signature type: CL for Camenisch-Lysyanskaya", + "example" : "CL", + "type" : "object" + }, + "value" : { + "$ref" : "#/components/schemas/CredentialDefinition_value" + }, + "ver" : { + "description" : "Node protocol version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } }, - "proof_types" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "Ed25519Signature2018", - "description" : "Signature suite used for proof" + "type" : "object" + }, + "CredentialDefinitionGetResult" : { + "properties" : { + "credential_definition" : { + "$ref" : "#/components/schemas/CredentialDefinition" } }, - "schema_ids" : { - "type" : "array", - "description" : "Schema identifiers, all of which to match", - "items" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Credential schema identifier", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" + "type" : "object" + }, + "CredentialDefinitionSendRequest" : { + "properties" : { + "revocation_registry_size" : { + "description" : "Revocation registry size", + "example" : 1000, + "format" : "int32", + "maximum" : 32768, + "minimum" : 4, + "type" : "integer" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "support_revocation" : { + "description" : "Revocation supported flag", + "type" : "boolean" + }, + "tag" : { + "description" : "Credential definition identifier tag", + "example" : "default", + "type" : "string" } }, - "subject_ids" : { - "type" : "array", - "description" : "Subject identifiers, all of which to match", - "items" : { - "type" : "string", - "description" : "Subject identifier" + "type" : "object" + }, + "CredentialDefinitionSendResult" : { + "properties" : { + "credential_definition_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" } }, - "tag_query" : { - "type" : "object", - "description" : "Tag filter", - "additionalProperties" : { - "type" : "string", - "description" : "Tag value" + "type" : "object" + }, + "CredentialDefinitionsCreatedResult" : { + "properties" : { + "credential_definition_ids" : { + "items" : { + "description" : "Credential definition identifiers", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "type" : "array" } }, - "types" : { - "type" : "array", - "items" : { - "type" : "string", - "example" : "https://myhost:8021", - "description" : "Credential type to match", - "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$" - } - } - } - }, - "WalletList" : { - "type" : "object", - "properties" : { - "results" : { - "type" : "array", - "description" : "List of wallet records", - "items" : { - "$ref" : "#/definitions/WalletRecord" - } - } - } - }, - "WalletModuleResponse" : { - "type" : "object" - }, - "WalletRecord" : { - "type" : "object", - "required" : [ "key_management_mode", "wallet_id" ], - "properties" : { - "created_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of record creation", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "key_management_mode" : { - "type" : "string", - "description" : "Mode regarding management of wallet key", - "enum" : [ "managed", "unmanaged" ] - }, - "settings" : { - "type" : "object", - "description" : "Settings for this wallet.", - "properties" : { } - }, - "state" : { - "type" : "string", - "example" : "active", - "description" : "Current record state" - }, - "updated_at" : { - "type" : "string", - "example" : "2021-12-31 23:59:59Z", - "description" : "Time of last record update", - "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$" - }, - "wallet_id" : { - "type" : "string", - "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "Wallet record ID" - } - } - }, - "ActionMenuFetchResult_result" : { - "type" : "object", - "description" : "Action menu" - }, - "AttachDecoratorData_jws" : { - "type" : "object", - "description" : "Detached Java Web Signature" - }, - "CredDefValue_primary" : { - "type" : "object", - "description" : "Primary value for credential definition" - }, - "CredDefValue_revocation" : { - "type" : "object", - "description" : "Revocation value for credential definition" - }, - "Credential_proof" : { - "type" : "object", - "description" : "The proof of the credential", - "example" : "{\"created\":\"2019-12-11T03:50:55\",\"jws\":\"eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ\",\"proofPurpose\":\"assertionMethod\",\"type\":\"Ed25519Signature2018\",\"verificationMethod\":\"did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL\"}" - }, - "CredentialDefinition_value" : { - "type" : "object", - "description" : "Credential definition primary and revocation values" - }, - "DIDCreate_options" : { - "type" : "object", - "description" : "To define a key type for a did:key" - }, - "DIDXRequest_did_docattach" : { - "type" : "object", - "description" : "As signed attachment, DID Doc associated with DID" - }, - "Doc_options" : { - "type" : "object", - "description" : "Signature options" - }, - "IndyCredAbstract_key_correctness_proof" : { - "type" : "object", - "description" : "Key correctness proof" - }, - "IndyCredPrecis_cred_info" : { - "type" : "object", - "description" : "Credential info" - }, - "IndyCredPrecis_interval" : { - "type" : "object", - "description" : "Non-revocation interval from presentation request" - }, - "IndyPrimaryProof_eq_proof" : { - "type" : "object", - "description" : "Indy equality proof", - "x-nullable" : true - }, - "IndyProof_proof" : { - "type" : "object", - "description" : "Indy proof.proof content" - }, - "IndyProof_requested_proof" : { - "type" : "object", - "description" : "Indy proof.requested_proof content" - }, - "IndyProofProof_aggregated_proof" : { - "type" : "object", - "description" : "Indy proof aggregated proof" - }, - "IndyProofProofProofsProof_non_revoc_proof" : { - "type" : "object", - "description" : "Indy non-revocation proof", - "x-nullable" : true - }, - "IndyProofProofProofsProof_primary_proof" : { - "type" : "object", - "description" : "Indy primary proof" - }, - "IndyProofReqAttrSpec_non_revoked" : { - "type" : "object", - "x-nullable" : true - }, - "IndyRevRegDef_value" : { - "type" : "object", - "description" : "Revocation registry definition value" - }, - "IndyRevRegDefValue_publicKeys" : { - "type" : "object", - "description" : "Public keys" - }, - "IndyRevRegEntry_value" : { - "type" : "object", - "description" : "Revocation registry entry value" - }, - "InvitationRecord_invitation" : { - "type" : "object", - "description" : "Out of band invitation message" - }, - "IssuerRevRegRecord_revoc_reg_def" : { - "type" : "object", - "description" : "Revocation registry definition" - }, - "IssuerRevRegRecord_revoc_reg_entry" : { - "type" : "object", - "description" : "Revocation registry entry" - }, - "KeylistQuery_paginate" : { - "type" : "object", - "description" : "Pagination info" - }, - "LDProofVCDetail_credential" : { - "type" : "object", - "description" : "Detail of the JSON-LD Credential to be issued", - "example" : "{\"@context\":[\"https://www.w3.org/2018/credentials/v1\",\"https://w3id.org/citizenship/v1\"],\"credentialSubject\":{\"familyName\":\"SMITH\",\"gender\":\"Male\",\"givenName\":\"JOHN\",\"type\":[\"PermanentResident\",\"Person\"]},\"description\":\"Government of Example Permanent Resident Card.\",\"identifier\":\"83627465\",\"issuanceDate\":\"2019-12-03T12:19:52Z\",\"issuer\":\"did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th\",\"name\":\"Permanent Resident Card\",\"type\":[\"VerifiableCredential\",\"PermanentResidentCard\"]}" - }, - "LDProofVCDetail_options" : { - "type" : "object", - "description" : "Options for specifying how the linked data proof is created.", - "example" : "{\"proofType\":\"Ed25519Signature2018\"}" - }, - "LDProofVCDetailOptions_credentialStatus" : { - "type" : "object", - "description" : "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status" - }, - "SchemaSendResult_schema" : { - "type" : "object", - "description" : "Schema definition" - }, - "SendMenu_menu" : { - "type" : "object", - "description" : "Menu to send to connection" - }, - "SignedDoc_proof" : { - "type" : "object", - "description" : "Linked data proof" - }, - "TxnOrCredentialDefinitionSendResult_txn" : { - "type" : "object", - "description" : "Credential definition transaction to endorse" - }, - "TxnOrPublishRevocationsResult_txn" : { - "type" : "object", - "description" : "Revocation registry revocations transaction to endorse" - }, - "TxnOrRevRegResult_txn" : { - "type" : "object", - "description" : "Revocation registry definition transaction to endorse" - }, - "TxnOrSchemaSendResult_sent" : { - "type" : "object", - "description" : "Content sent" - }, - "TxnOrSchemaSendResult_txn" : { - "type" : "object", - "description" : "Schema transaction to endorse" - }, - "V10CredentialBoundOfferRequest_counter_proposal" : { - "type" : "object", - "description" : "Optional counter-proposal" - }, - "V10CredentialExchange_credential" : { - "type" : "object", - "description" : "Credential as stored" - }, - "V10CredentialExchange_credential_offer" : { - "type" : "object", - "description" : "(Indy) credential offer" - }, - "V10CredentialExchange_credential_offer_dict" : { - "type" : "object", - "description" : "Credential offer message" - }, - "V10CredentialExchange_credential_proposal_dict" : { - "type" : "object", - "description" : "Credential proposal message" - }, - "V10CredentialExchange_credential_request" : { - "type" : "object", - "description" : "(Indy) credential request" - }, - "V10CredentialExchange_raw_credential" : { - "type" : "object", - "description" : "Credential as received, prior to storage in holder wallet" - }, - "V10PresentationExchange_presentation" : { - "type" : "object", - "description" : "(Indy) presentation (also known as proof)" - }, - "V10PresentationExchange_presentation_proposal_dict" : { - "type" : "object", - "description" : "Presentation proposal message" - }, - "V10PresentationExchange_presentation_request" : { - "type" : "object", - "description" : "(Indy) presentation request (also known as proof request)" - }, - "V10PresentationExchange_presentation_request_dict" : { - "type" : "object", - "description" : "Presentation request message" - }, - "V20CredBoundOfferRequest_counter_preview" : { - "type" : "object", - "description" : "Optional content for counter-proposal" - }, - "V20CredBoundOfferRequest_filter" : { - "type" : "object", - "description" : "Credential specification criteria by format" - }, - "V20CredExRecord_by_format" : { - "type" : "object", - "description" : "Attachment content by format for proposal, offer, request, and issue" - }, - "V20CredExRecord_cred_issue" : { - "type" : "object", - "description" : "Serialized credential issue message" - }, - "V20CredExRecord_cred_preview" : { - "type" : "object", - "description" : "Credential preview from credential proposal" - }, - "V20CredExRecord_cred_request" : { - "type" : "object", - "description" : "Serialized credential request message" - }, - "V20CredExRecordDetail_cred_ex_record" : { - "type" : "object", - "description" : "Credential exchange record" - }, - "V20CredFilter_indy" : { - "type" : "object", - "description" : "Credential filter for indy" - }, - "V20CredFilter_ld_proof" : { - "type" : "object", - "description" : "Credential filter for linked data proof" - }, - "V20CredProposal_credential_preview" : { - "type" : "object", - "description" : "Credential preview" - }, - "V20PresExRecord_by_format" : { - "type" : "object", - "description" : "Attachment content by format for proposal, request, and presentation" - }, - "V20PresExRecord_pres" : { - "type" : "object", - "description" : "Presentation message" - }, - "V20PresProposalByFormat_dif" : { - "type" : "object", - "description" : "Presentation proposal for DIF" - }, - "V20PresProposalByFormat_indy" : { - "type" : "object", - "description" : "Presentation proposal for indy" - }, - "V20PresRequestByFormat_dif" : { - "type" : "object", - "description" : "Presentation request for DIF" - }, - "V20PresRequestByFormat_indy" : { - "type" : "object", - "description" : "Presentation request for indy" - }, - "V20PresSpecByFormatRequest_dif" : { - "type" : "object", - "description" : "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest" - }, - "V20PresSpecByFormatRequest_indy" : { - "type" : "object", - "description" : "Presentation specification for indy" + "type" : "object" + }, + "CredentialOffer" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "offers~attach" : { + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + } + }, + "required" : [ "offers~attach" ], + "type" : "object" + }, + "CredentialPreview" : { + "properties" : { + "@type" : { + "description" : "Message type identifier", + "example" : "issue-credential/1.0/credential-preview", + "type" : "string" + }, + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/CredAttrSpec" + }, + "type" : "array" + } + }, + "required" : [ "attributes" ], + "type" : "object" + }, + "CredentialProposal" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "cred_def_id" : { + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_proposal" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "issuer_did" : { + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_id" : { + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "schema_issuer_did" : { + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_name" : { + "type" : "string" + }, + "schema_version" : { + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "CredentialStatusOptions" : { + "properties" : { + "type" : { + "description" : "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry", + "example" : "CredentialStatusList2017", + "type" : "string" + } + }, + "required" : [ "type" ], + "type" : "object" + }, + "DID" : { + "properties" : { + "did" : { + "description" : "DID of interest", + "example" : "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type" : "string" + }, + "key_type" : { + "description" : "Key type associated with the DID", + "enum" : [ "ed25519", "bls12381g2" ], + "example" : "ed25519", + "type" : "string" + }, + "method" : { + "description" : "Did method associated with the DID", + "example" : "sov", + "type" : "string" + }, + "posture" : { + "description" : "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet", + "enum" : [ "public", "posted", "wallet_only" ], + "example" : "wallet_only", + "type" : "string" + }, + "verkey" : { + "description" : "Public verification key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } + }, + "type" : "object" + }, + "DIDCreate" : { + "properties" : { + "method" : { + "description" : "Method for the requested DID.Supported methods are 'key', 'sov', and any other registered method.", + "example" : "sov", + "type" : "string" + }, + "options" : { + "$ref" : "#/components/schemas/DIDCreate_options" + }, + "seed" : { + "description" : "Optional seed to use for DID, Must beenabled in configuration before use.", + "example" : "000000000000000000000000Trustee1", + "type" : "string" + } + }, + "type" : "object" + }, + "DIDCreateOptions" : { + "properties" : { + "did" : { + "description" : "Specify final value of the did (including did:: prefix)if the method supports or requires so.", + "example" : "did:peer:WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\\/[^#?]*)?([?][^#]*)?(\\#.*)?$$", + "type" : "string" + }, + "key_type" : { + "description" : "Key type to use for the DID keypair. Validated with the chosen DID method's supported key types.", + "enum" : [ "ed25519", "bls12381g2" ], + "example" : "ed25519", + "type" : "string" + } + }, + "required" : [ "key_type" ], + "type" : "object" + }, + "DIDEndpoint" : { + "properties" : { + "did" : { + "description" : "DID of interest", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "endpoint" : { + "description" : "Endpoint to set (omit to delete)", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } + }, + "required" : [ "did" ], + "type" : "object" + }, + "DIDEndpointWithType" : { + "properties" : { + "did" : { + "description" : "DID of interest", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "endpoint" : { + "description" : "Endpoint to set (omit to delete)", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "endpoint_type" : { + "description" : "Endpoint type to set (default 'Endpoint'); affects only public or posted DIDs", + "enum" : [ "Endpoint", "Profile", "LinkedDomains" ], + "example" : "Endpoint", + "type" : "string" + } + }, + "required" : [ "did" ], + "type" : "object" + }, + "DIDList" : { + "properties" : { + "results" : { + "description" : "DID list", + "items" : { + "$ref" : "#/components/schemas/DID" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "DIDResult" : { + "properties" : { + "result" : { + "$ref" : "#/components/schemas/DID" + } + }, + "type" : "object" + }, + "DIDXRequest" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "did" : { + "description" : "DID of exchange", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "did_doc~attach" : { + "$ref" : "#/components/schemas/DIDXRequest_did_doc_attach" + }, + "label" : { + "description" : "Label for DID exchange request", + "example" : "Request to connect with Bob", + "type" : "string" + } + }, + "required" : [ "label" ], + "type" : "object" + }, + "DIFField" : { + "properties" : { + "filter" : { + "$ref" : "#/components/schemas/Filter" + }, + "id" : { + "description" : "ID", + "type" : "string" + }, + "path" : { + "items" : { + "description" : "Path", + "type" : "string" + }, + "type" : "array" + }, + "predicate" : { + "description" : "Preference", + "enum" : [ "required", "preferred" ], + "type" : "string" + }, + "purpose" : { + "description" : "Purpose", + "type" : "string" + } + }, + "type" : "object" + }, + "DIFHolder" : { + "properties" : { + "directive" : { + "description" : "Preference", + "enum" : [ "required", "preferred" ], + "type" : "string" + }, + "field_id" : { + "items" : { + "description" : "FieldID", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "DIFOptions" : { + "properties" : { + "challenge" : { + "description" : "Challenge protect against replay attack", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "domain" : { + "description" : "Domain protect against replay attack", + "example" : "4jt78h47fh47", + "type" : "string" + } + }, + "type" : "object" + }, + "DIFPresSpec" : { + "properties" : { + "issuer_id" : { + "description" : "Issuer identifier to sign the presentation, if different from current public DID", + "type" : "string" + }, + "presentation_definition" : { + "$ref" : "#/components/schemas/PresentationDefinition" + }, + "record_ids" : { + "description" : "Mapping of input_descriptor id to list of stored W3C credential record_id", + "example" : { + "" : [ "", "" ], + "" : [ "" ] + }, + "properties" : { }, + "type" : "object" + }, + "reveal_doc" : { + "description" : "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required", + "example" : { + "@context" : [ "https://www.w3.org/2018/credentials/v1", "https://w3id.org/security/bbs/v1" ], + "@explicit" : true, + "@requireAll" : true, + "credentialSubject" : { + "@explicit" : true, + "@requireAll" : true, + "Observation" : [ { + "effectiveDateTime" : { }, + "@explicit" : true, + "@requireAll" : true + } ] + }, + "issuanceDate" : { }, + "issuer" : { }, + "type" : [ "VerifiableCredential", "LabReport" ] + }, + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "DIFProofProposal" : { + "properties" : { + "input_descriptors" : { + "items" : { + "$ref" : "#/components/schemas/InputDescriptors" + }, + "type" : "array" + }, + "options" : { + "$ref" : "#/components/schemas/DIFOptions" + } + }, + "type" : "object" + }, + "DIFProofRequest" : { + "properties" : { + "options" : { + "$ref" : "#/components/schemas/DIFOptions" + }, + "presentation_definition" : { + "$ref" : "#/components/schemas/PresentationDefinition" + } + }, + "required" : [ "presentation_definition" ], + "type" : "object" + }, + "Date" : { + "properties" : { + "expires_time" : { + "description" : "Expiry Date", + "example" : "2021-03-29T05:22:19Z", + "format" : "date-time", + "type" : "string" + } + }, + "required" : [ "expires_time" ], + "type" : "object" + }, + "Disclose" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "protocols" : { + "description" : "List of protocol descriptors", + "items" : { + "$ref" : "#/components/schemas/ProtocolDescriptor" + }, + "type" : "array" + } + }, + "required" : [ "protocols" ], + "type" : "object" + }, + "Disclosures" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "disclosures" : { + "description" : "List of protocol or goal_code descriptors", + "items" : { + "type" : "object" + }, + "type" : "array" + } + }, + "required" : [ "disclosures" ], + "type" : "object" + }, + "Doc" : { + "properties" : { + "credential" : { + "description" : "Credential to sign", + "properties" : { }, + "type" : "object" + }, + "options" : { + "$ref" : "#/components/schemas/Doc_options" + } + }, + "required" : [ "credential", "options" ], + "type" : "object" + }, + "EndorserInfo" : { + "properties" : { + "endorser_did" : { + "description" : "Endorser DID", + "type" : "string" + }, + "endorser_name" : { + "description" : "Endorser Name", + "type" : "string" + } + }, + "required" : [ "endorser_did" ], + "type" : "object" + }, + "EndpointsResult" : { + "properties" : { + "my_endpoint" : { + "description" : "My endpoint", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "their_endpoint" : { + "description" : "Their endpoint", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } + }, + "type" : "object" + }, + "Filter" : { + "properties" : { + "const" : { + "description" : "Const", + "type" : "object" + }, + "enum" : { + "items" : { + "description" : "Enum", + "type" : "object" + }, + "type" : "array" + }, + "exclusiveMaximum" : { + "description" : "ExclusiveMaximum", + "type" : "object" + }, + "exclusiveMinimum" : { + "description" : "ExclusiveMinimum", + "type" : "object" + }, + "format" : { + "description" : "Format", + "type" : "string" + }, + "maxLength" : { + "description" : "Max Length", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "maximum" : { + "description" : "Maximum", + "type" : "object" + }, + "minLength" : { + "description" : "Min Length", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "minimum" : { + "description" : "Minimum", + "type" : "object" + }, + "not" : { + "description" : "Not", + "example" : false, + "type" : "boolean" + }, + "pattern" : { + "description" : "Pattern", + "type" : "string" + }, + "type" : { + "description" : "Type", + "type" : "string" + } + }, + "type" : "object" + }, + "Generated" : { + "properties" : { + "master_secret" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "number" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "remainder" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + } + }, + "type" : "object" + }, + "GetDIDEndpointResponse" : { + "properties" : { + "endpoint" : { + "description" : "Full verification key", + "example" : "https://myhost:8021", + "nullable" : true, + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + } + }, + "type" : "object" + }, + "GetDIDVerkeyResponse" : { + "properties" : { + "verkey" : { + "description" : "Full verification key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "nullable" : true, + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } + }, + "type" : "object" + }, + "GetNymRoleResponse" : { + "properties" : { + "role" : { + "description" : "Ledger role", + "enum" : [ "STEWARD", "TRUSTEE", "ENDORSER", "NETWORK_MONITOR", "USER", "ROLE_REMOVE" ], + "example" : "ENDORSER", + "type" : "string" + } + }, + "type" : "object" + }, + "HolderModuleResponse" : { + "type" : "object" + }, + "IndyAttrValue" : { + "properties" : { + "encoded" : { + "description" : "Attribute encoded value", + "example" : "-1", + "pattern" : "^-?[0-9]*$", + "type" : "string" + }, + "raw" : { + "description" : "Attribute raw value", + "type" : "string" + } + }, + "required" : [ "encoded", "raw" ], + "type" : "object" + }, + "IndyCredAbstract" : { + "properties" : { + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "key_correctness_proof" : { + "$ref" : "#/components/schemas/IndyCredAbstract_key_correctness_proof" + }, + "nonce" : { + "description" : "Nonce in credential abstract", + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } + }, + "required" : [ "cred_def_id", "key_correctness_proof", "nonce", "schema_id" ], + "type" : "object" + }, + "IndyCredInfo" : { + "properties" : { + "attrs" : { + "additionalProperties" : { + "example" : "alice", + "type" : "string" + }, + "description" : "Attribute names and value", + "type" : "object" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "cred_rev_id" : { + "description" : "Credential revocation identifier", + "example" : "12345", + "nullable" : true, + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "referent" : { + "description" : "Wallet referent", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "nullable" : true, + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyCredPrecis" : { + "properties" : { + "cred_info" : { + "$ref" : "#/components/schemas/IndyCredPrecis_cred_info" + }, + "interval" : { + "$ref" : "#/components/schemas/IndyCredPrecis_interval" + }, + "presentation_referents" : { + "items" : { + "description" : "presentation referent", + "example" : "1_age_uuid", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "IndyCredRequest" : { + "properties" : { + "blinded_ms" : { + "description" : "Blinded master secret", + "properties" : { }, + "type" : "object" + }, + "blinded_ms_correctness_proof" : { + "description" : "Blinded master secret correctness proof", + "properties" : { }, + "type" : "object" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "nonce" : { + "description" : "Nonce in credential request", + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "prover_did" : { + "description" : "Prover DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + } + }, + "required" : [ "blinded_ms", "blinded_ms_correctness_proof", "cred_def_id", "nonce", "prover_did" ], + "type" : "object" + }, + "IndyCredential" : { + "properties" : { + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "rev_reg" : { + "description" : "Revocation registry state", + "nullable" : true, + "properties" : { }, + "type" : "object" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "nullable" : true, + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "signature" : { + "description" : "Credential signature", + "properties" : { }, + "type" : "object" + }, + "signature_correctness_proof" : { + "description" : "Credential signature correctness proof", + "properties" : { }, + "type" : "object" + }, + "values" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyCredential_values_value" + }, + "description" : "Credential attributes", + "type" : "object" + }, + "witness" : { + "description" : "Witness for revocation proof", + "nullable" : true, + "properties" : { }, + "type" : "object" + } + }, + "required" : [ "cred_def_id", "schema_id", "signature", "signature_correctness_proof", "values" ], + "type" : "object" + }, + "IndyEQProof" : { + "properties" : { + "a_prime" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "e" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "m" : { + "additionalProperties" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "type" : "object" + }, + "m2" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "revealed_attrs" : { + "additionalProperties" : { + "example" : "-1", + "pattern" : "^-?[0-9]*$", + "type" : "string" + }, + "type" : "object" + }, + "v" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyGEProof" : { + "properties" : { + "alpha" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "mj" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "predicate" : { + "$ref" : "#/components/schemas/IndyGEProofPred" + }, + "r" : { + "additionalProperties" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "type" : "object" + }, + "t" : { + "additionalProperties" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "type" : "object" + }, + "u" : { + "additionalProperties" : { + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "type" : "object" + } + }, + "type" : "object" + }, + "IndyGEProofPred" : { + "properties" : { + "attr_name" : { + "description" : "Attribute name, indy-canonicalized", + "type" : "string" + }, + "p_type" : { + "description" : "Predicate type", + "enum" : [ "LT", "LE", "GE", "GT" ], + "type" : "string" + }, + "value" : { + "description" : "Predicate threshold value", + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyKeyCorrectnessProof" : { + "properties" : { + "c" : { + "description" : "c in key correctness proof", + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + }, + "xr_cap" : { + "description" : "xr_cap in key correctness proof", + "items" : { + "description" : "xr_cap components in key correctness proof", + "items" : { + "description" : "xr_cap component values in key correctness proof", + "type" : "string" + }, + "type" : "array" + }, + "type" : "array" + }, + "xz_cap" : { + "description" : "xz_cap in key correctness proof", + "example" : "0", + "pattern" : "^[0-9]*$", + "type" : "string" + } + }, + "required" : [ "c", "xr_cap", "xz_cap" ], + "type" : "object" + }, + "IndyNonRevocProof" : { + "properties" : { + "c_list" : { + "additionalProperties" : { + "type" : "string" + }, + "type" : "object" + }, + "x_list" : { + "additionalProperties" : { + "type" : "string" + }, + "type" : "object" + } + }, + "type" : "object" + }, + "IndyNonRevocationInterval" : { + "properties" : { + "from" : { + "description" : "Earliest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + }, + "to" : { + "description" : "Latest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyPresAttrSpec" : { + "properties" : { + "cred_def_id" : { + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "mime-type" : { + "description" : "MIME type (default null)", + "example" : "image/jpeg", + "type" : "string" + }, + "name" : { + "description" : "Attribute name", + "example" : "favourite_drink", + "type" : "string" + }, + "referent" : { + "description" : "Credential referent", + "example" : "0", + "type" : "string" + }, + "value" : { + "description" : "Attribute value", + "example" : "martini", + "type" : "string" + } + }, + "required" : [ "name" ], + "type" : "object" + }, + "IndyPresPredSpec" : { + "properties" : { + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "name" : { + "description" : "Attribute name", + "example" : "high_score", + "type" : "string" + }, + "predicate" : { + "description" : "Predicate type ('<', '<=', '>=', or '>')", + "enum" : [ "<", "<=", ">=", ">" ], + "example" : ">=", + "type" : "string" + }, + "threshold" : { + "description" : "Threshold value", + "format" : "int32", + "type" : "integer" + } + }, + "required" : [ "name", "predicate", "threshold" ], + "type" : "object" + }, + "IndyPresPreview" : { + "properties" : { + "@type" : { + "description" : "Message type identifier", + "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/present-proof/1.0/presentation-preview", + "type" : "string" + }, + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/IndyPresAttrSpec" + }, + "type" : "array" + }, + "predicates" : { + "items" : { + "$ref" : "#/components/schemas/IndyPresPredSpec" + }, + "type" : "array" + } + }, + "required" : [ "attributes", "predicates" ], + "type" : "object" + }, + "IndyPresSpec" : { + "properties" : { + "requested_attributes" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyRequestedCredsRequestedAttr" + }, + "description" : "Nested object mapping proof request attribute referents to requested-attribute specifiers", + "type" : "object" + }, + "requested_predicates" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyRequestedCredsRequestedPred" + }, + "description" : "Nested object mapping proof request predicate referents to requested-predicate specifiers", + "type" : "object" + }, + "self_attested_attributes" : { + "additionalProperties" : { + "description" : "Self-attested attribute values to use in requested-credentials structure for proof construction", + "example" : "self_attested_value", + "type" : "string" + }, + "description" : "Self-attested attributes to build into proof", + "type" : "object" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "requested_attributes", "requested_predicates", "self_attested_attributes" ], + "type" : "object" + }, + "IndyPrimaryProof" : { + "properties" : { + "eq_proof" : { + "$ref" : "#/components/schemas/IndyPrimaryProof_eq_proof" + }, + "ge_proofs" : { + "description" : "Indy GE proofs", + "items" : { + "$ref" : "#/components/schemas/IndyGEProof" + }, + "nullable" : true, + "type" : "array" + } + }, + "type" : "object" + }, + "IndyProof" : { + "properties" : { + "identifiers" : { + "description" : "Indy proof.identifiers content", + "items" : { + "$ref" : "#/components/schemas/IndyProofIdentifier" + }, + "type" : "array" + }, + "proof" : { + "$ref" : "#/components/schemas/IndyProof_proof" + }, + "requested_proof" : { + "$ref" : "#/components/schemas/IndyProof_requested_proof" + } + }, + "type" : "object" + }, + "IndyProofIdentifier" : { + "properties" : { + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "nullable" : true, + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "timestamp" : { + "description" : "Timestamp epoch", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "nullable" : true, + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofProof" : { + "properties" : { + "aggregated_proof" : { + "$ref" : "#/components/schemas/IndyProofProof_aggregated_proof" + }, + "proofs" : { + "description" : "Indy proof proofs", + "items" : { + "$ref" : "#/components/schemas/IndyProofProofProofsProof" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "IndyProofProofAggregatedProof" : { + "properties" : { + "c_hash" : { + "description" : "c_hash value", + "type" : "string" + }, + "c_list" : { + "description" : "c_list value", + "items" : { + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "IndyProofProofProofsProof" : { + "properties" : { + "non_revoc_proof" : { + "$ref" : "#/components/schemas/IndyProofProofProofsProof_non_revoc_proof" + }, + "primary_proof" : { + "$ref" : "#/components/schemas/IndyProofProofProofsProof_primary_proof" + } + }, + "type" : "object" + }, + "IndyProofReqAttrSpec" : { + "properties" : { + "name" : { + "description" : "Attribute name", + "example" : "favouriteDrink", + "type" : "string" + }, + "names" : { + "description" : "Attribute name group", + "items" : { + "example" : "age", + "type" : "string" + }, + "type" : "array" + }, + "non_revoked" : { + "$ref" : "#/components/schemas/IndyProofReqAttrSpec_non_revoked" + }, + "restrictions" : { + "description" : "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", + "items" : { + "additionalProperties" : { + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type" : "string" + }, + "type" : "object" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "IndyProofReqAttrSpecNonRevoked" : { + "properties" : { + "from" : { + "description" : "Earliest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + }, + "to" : { + "description" : "Latest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofReqPredSpec" : { + "properties" : { + "name" : { + "description" : "Attribute name", + "example" : "index", + "type" : "string" + }, + "non_revoked" : { + "$ref" : "#/components/schemas/IndyProofReqPredSpec_non_revoked" + }, + "p_type" : { + "description" : "Predicate type ('<', '<=', '>=', or '>')", + "enum" : [ "<", "<=", ">=", ">" ], + "example" : ">=", + "type" : "string" + }, + "p_value" : { + "description" : "Threshold value", + "format" : "int32", + "type" : "integer" + }, + "restrictions" : { + "description" : "If present, credential must satisfy one of given restrictions: specify schema_id, schema_issuer_did, schema_name, schema_version, issuer_did, cred_def_id, and/or attr::::value where represents a credential attribute name", + "items" : { + "additionalProperties" : { + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "type" : "string" + }, + "type" : "object" + }, + "type" : "array" + } + }, + "required" : [ "name", "p_type", "p_value" ], + "type" : "object" + }, + "IndyProofReqPredSpecNonRevoked" : { + "properties" : { + "from" : { + "description" : "Earliest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + }, + "to" : { + "description" : "Latest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofRequest" : { + "properties" : { + "name" : { + "description" : "Proof request name", + "example" : "Proof request", + "type" : "string" + }, + "non_revoked" : { + "$ref" : "#/components/schemas/IndyProofRequest_non_revoked" + }, + "nonce" : { + "description" : "Nonce", + "example" : "1", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "requested_attributes" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyProofReqAttrSpec" + }, + "description" : "Requested attribute specifications of proof request", + "type" : "object" + }, + "requested_predicates" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyProofReqPredSpec" + }, + "description" : "Requested predicate specifications of proof request", + "type" : "object" + }, + "version" : { + "description" : "Proof request version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "required" : [ "requested_attributes", "requested_predicates" ], + "type" : "object" + }, + "IndyProofRequestNonRevoked" : { + "properties" : { + "from" : { + "description" : "Earliest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + }, + "to" : { + "description" : "Latest time of interest in non-revocation interval", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofRequestedProof" : { + "properties" : { + "predicates" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyProofRequestedProofPredicate" + }, + "description" : "Proof requested proof predicates.", + "type" : "object" + }, + "revealed_attr_groups" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyProofRequestedProofRevealedAttrGroup" + }, + "description" : "Proof requested proof revealed attribute groups", + "nullable" : true, + "type" : "object" + }, + "revealed_attrs" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/IndyProofRequestedProofRevealedAttr" + }, + "description" : "Proof requested proof revealed attributes", + "nullable" : true, + "type" : "object" + }, + "self_attested_attrs" : { + "description" : "Proof requested proof self-attested attributes", + "properties" : { }, + "type" : "object" + }, + "unrevealed_attrs" : { + "description" : "Unrevealed attributes", + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "IndyProofRequestedProofPredicate" : { + "properties" : { + "sub_proof_index" : { + "description" : "Sub-proof index", + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofRequestedProofRevealedAttr" : { + "properties" : { + "encoded" : { + "description" : "Encoded value", + "example" : "-1", + "pattern" : "^-?[0-9]*$", + "type" : "string" + }, + "raw" : { + "description" : "Raw value", + "type" : "string" + }, + "sub_proof_index" : { + "description" : "Sub-proof index", + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "IndyProofRequestedProofRevealedAttrGroup" : { + "properties" : { + "sub_proof_index" : { + "description" : "Sub-proof index", + "format" : "int32", + "type" : "integer" + }, + "values" : { + "additionalProperties" : { + "$ref" : "#/components/schemas/RawEncoded" + }, + "description" : "Indy proof requested proof revealed attr groups group value", + "type" : "object" + } + }, + "type" : "object" + }, + "IndyRequestedCredsRequestedAttr" : { + "properties" : { + "cred_id" : { + "description" : "Wallet credential identifier (typically but not necessarily a UUID)", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "revealed" : { + "description" : "Whether to reveal attribute in proof (default true)", + "type" : "boolean" + } + }, + "required" : [ "cred_id" ], + "type" : "object" + }, + "IndyRequestedCredsRequestedPred" : { + "properties" : { + "cred_id" : { + "description" : "Wallet credential identifier (typically but not necessarily a UUID)", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "timestamp" : { + "description" : "Epoch timestamp of interest for non-revocation proof", + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "required" : [ "cred_id" ], + "type" : "object" + }, + "IndyRevRegDef" : { + "properties" : { + "credDefId" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "id" : { + "description" : "Indy revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "revocDefType" : { + "description" : "Revocation registry type (specify CL_ACCUM)", + "enum" : [ "CL_ACCUM" ], + "example" : "CL_ACCUM", + "type" : "string" + }, + "tag" : { + "description" : "Revocation registry tag", + "type" : "string" + }, + "value" : { + "$ref" : "#/components/schemas/IndyRevRegDef_value" + }, + "ver" : { + "description" : "Version of revocation registry definition", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyRevRegDefValue" : { + "properties" : { + "issuanceType" : { + "description" : "Issuance type", + "enum" : [ "ISSUANCE_ON_DEMAND", "ISSUANCE_BY_DEFAULT" ], + "type" : "string" + }, + "maxCredNum" : { + "description" : "Maximum number of credentials; registry size", + "example" : 10, + "format" : "int32", + "minimum" : 1, + "type" : "integer" + }, + "publicKeys" : { + "$ref" : "#/components/schemas/IndyRevRegDefValue_publicKeys" + }, + "tailsHash" : { + "description" : "Tails hash value", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "tailsLocation" : { + "description" : "Tails file location", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyRevRegDefValuePublicKeys" : { + "properties" : { + "accumKey" : { + "$ref" : "#/components/schemas/IndyRevRegDefValuePublicKeysAccumKey" + } + }, + "type" : "object" + }, + "IndyRevRegDefValuePublicKeysAccumKey" : { + "properties" : { + "z" : { + "description" : "Value for z", + "example" : "1 120F522F81E6B7 1 09F7A59005C4939854", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyRevRegEntry" : { + "properties" : { + "value" : { + "$ref" : "#/components/schemas/IndyRevRegEntry_value" + }, + "ver" : { + "description" : "Version of revocation registry entry", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "IndyRevRegEntryValue" : { + "properties" : { + "accum" : { + "description" : "Accumulator value", + "example" : "21 11792B036AED0AAA12A4 4 298B2571FFC63A737", + "type" : "string" + }, + "prevAccum" : { + "description" : "Previous accumulator value", + "example" : "21 137AC810975E4 6 76F0384B6F23", + "type" : "string" + }, + "revoked" : { + "description" : "Revoked credential revocation identifiers", + "items" : { + "format" : "int32", + "type" : "integer" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "InputDescriptors" : { + "properties" : { + "constraints" : { + "$ref" : "#/components/schemas/Constraints" + }, + "group" : { + "items" : { + "description" : "Group", + "type" : "string" + }, + "type" : "array" + }, + "id" : { + "description" : "ID", + "type" : "string" + }, + "metadata" : { + "description" : "Metadata dictionary", + "properties" : { }, + "type" : "object" + }, + "name" : { + "description" : "Name", + "type" : "string" + }, + "purpose" : { + "description" : "Purpose", + "type" : "string" + }, + "schema" : { + "$ref" : "#/components/schemas/InputDescriptors_schema" + } + }, + "type" : "object" + }, + "IntroModuleResponse" : { + "type" : "object" + }, + "InvitationCreateRequest" : { + "properties" : { + "accept" : { + "description" : "List of mime type in order of preference that should be use in responding to the message", + "example" : [ "didcomm/aip1", "didcomm/aip2;env=rfc19" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "alias" : { + "description" : "Alias for connection", + "example" : "Barry", + "type" : "string" + }, + "attachments" : { + "description" : "Optional invitation attachments", + "items" : { + "$ref" : "#/components/schemas/AttachmentDef" + }, + "type" : "array" + }, + "handshake_protocols" : { + "items" : { + "description" : "Handshake protocol to specify in invitation", + "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", + "type" : "string" + }, + "type" : "array" + }, + "mediation_id" : { + "description" : "Identifier for active mediation record to be used", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "metadata" : { + "description" : "Optional metadata to attach to the connection created with the invitation", + "properties" : { }, + "type" : "object" + }, + "my_label" : { + "description" : "Label for connection invitation", + "example" : "Invitation to Barry", + "type" : "string" + }, + "protocol_version" : { + "description" : "OOB protocol version", + "example" : "1.1", + "type" : "string" + }, + "use_public_did" : { + "description" : "Whether to use public DID in invitation", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "InvitationMessage" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "type" : "string" + }, + "accept" : { + "description" : "List of mime type in order of preference", + "example" : [ "didcomm/aip1", "didcomm/aip2;env=rfc19" ], + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "handshake_protocols" : { + "items" : { + "description" : "Handshake protocol", + "example" : "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/didexchange/1.0", + "type" : "string" + }, + "type" : "array" + }, + "imageUrl" : { + "description" : "Optional image URL for out-of-band invitation", + "example" : "http://192.168.56.101/img/logo.jpg", + "format" : "url", + "nullable" : true, + "type" : "string" + }, + "label" : { + "description" : "Optional label", + "example" : "Bob", + "type" : "string" + }, + "requests~attach" : { + "description" : "Optional request attachment", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + }, + "services" : { + "example" : [ { + "did" : "WgWxqztrNooG92RXvxSTWv", + "id" : "string", + "recipientKeys" : [ "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" ], + "routingKeys" : [ "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH" ], + "serviceEndpoint" : "http://192.168.56.101:8020", + "type" : "string" + }, "did:sov:WgWxqztrNooG92RXvxSTWv" ], + "items" : { + "description" : "Either a DIDComm service object (as per RFC0067) or a DID string.", + "type" : "object" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "InvitationRecord" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "invi_msg_id" : { + "description" : "Invitation message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "invitation" : { + "$ref" : "#/components/schemas/InvitationRecord_invitation" + }, + "invitation_id" : { + "description" : "Invitation record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "invitation_url" : { + "description" : "Invitation message URL", + "example" : "https://example.com/endpoint?c_i=eyJAdHlwZSI6ICIuLi4iLCAiLi4uIjogIi4uLiJ9XX0=", + "type" : "string" + }, + "oob_id" : { + "description" : "Out of band record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "state" : { + "description" : "Out of band message exchange state", + "example" : "await_response", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "InvitationResult" : { + "properties" : { + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "invitation" : { + "$ref" : "#/components/schemas/ConnectionInvitation" + }, + "invitation_url" : { + "description" : "Invitation URL", + "example" : "http://192.168.56.101:8020/invite?c_i=eyJAdHlwZSI6Li4ufQ==", + "type" : "string" + } + }, + "type" : "object" + }, + "IssueCredentialModuleResponse" : { + "type" : "object" + }, + "IssuerCredRevRecord" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "cred_ex_id" : { + "description" : "Credential exchange record identifier at credential issue", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_ex_version" : { + "description" : "Credential exchange version", + "type" : "string" + }, + "cred_rev_id" : { + "description" : "Credential revocation identifier", + "example" : "12345", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "record_id" : { + "description" : "Issuer credential revocation record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "state" : { + "description" : "Issue credential revocation record state", + "example" : "issued", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "IssuerRevRegRecord" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "error_msg" : { + "description" : "Error message", + "example" : "Revocation registry undefined", + "type" : "string" + }, + "issuer_did" : { + "description" : "Issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "max_cred_num" : { + "description" : "Maximum number of credentials for revocation registry", + "example" : 1000, + "format" : "int32", + "type" : "integer" + }, + "pending_pub" : { + "description" : "Credential revocation identifier for credential revoked and pending publication to ledger", + "items" : { + "example" : "23", + "type" : "string" + }, + "type" : "array" + }, + "record_id" : { + "description" : "Issuer revocation registry record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "revoc_def_type" : { + "description" : "Revocation registry type (specify CL_ACCUM)", + "enum" : [ "CL_ACCUM" ], + "example" : "CL_ACCUM", + "type" : "string" + }, + "revoc_reg_def" : { + "$ref" : "#/components/schemas/IssuerRevRegRecord_revoc_reg_def" + }, + "revoc_reg_entry" : { + "$ref" : "#/components/schemas/IssuerRevRegRecord_revoc_reg_entry" + }, + "revoc_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "state" : { + "description" : "Issue revocation registry record state", + "example" : "active", + "type" : "string" + }, + "tag" : { + "description" : "Tag within issuer revocation registry identifier", + "type" : "string" + }, + "tails_hash" : { + "description" : "Tails hash", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "tails_local_path" : { + "description" : "Local path to tails file", + "type" : "string" + }, + "tails_public_uri" : { + "description" : "Public URI for tails file", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "Keylist" : { + "properties" : { + "results" : { + "description" : "List of keylist records", + "items" : { + "$ref" : "#/components/schemas/RouteRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "KeylistQuery" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "filter" : { + "description" : "Query dictionary object", + "example" : { + "filter" : { } + }, + "properties" : { }, + "type" : "object" + }, + "paginate" : { + "$ref" : "#/components/schemas/KeylistQuery_paginate" + } + }, + "type" : "object" + }, + "KeylistQueryFilterRequest" : { + "properties" : { + "filter" : { + "description" : "Filter for keylist query", + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "KeylistQueryPaginate" : { + "properties" : { + "limit" : { + "description" : "Limit for keylist query", + "example" : 30, + "format" : "int32", + "type" : "integer" + }, + "offset" : { + "description" : "Offset value for query", + "example" : 0, + "format" : "int32", + "type" : "integer" + } + }, + "type" : "object" + }, + "KeylistUpdate" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "updates" : { + "description" : "List of update rules", + "items" : { + "$ref" : "#/components/schemas/KeylistUpdateRule" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "KeylistUpdateRequest" : { + "properties" : { + "updates" : { + "items" : { + "$ref" : "#/components/schemas/KeylistUpdateRule" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "KeylistUpdateRule" : { + "properties" : { + "action" : { + "description" : "Action for specific key", + "enum" : [ "add", "remove" ], + "example" : "add", + "type" : "string" + }, + "recipient_key" : { + "description" : "Key to remove or add", + "example" : "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "pattern" : "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$|^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + } + }, + "required" : [ "action", "recipient_key" ], + "type" : "object" + }, + "LDProofVCDetail" : { + "properties" : { + "credential" : { + "$ref" : "#/components/schemas/LDProofVCDetail_credential" + }, + "options" : { + "$ref" : "#/components/schemas/LDProofVCDetail_options" + } + }, + "required" : [ "credential", "options" ], + "type" : "object" + }, + "LDProofVCDetailOptions" : { + "properties" : { + "challenge" : { + "description" : "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created" : { + "description" : "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "credentialStatus" : { + "$ref" : "#/components/schemas/LDProofVCDetailOptions_credentialStatus" + }, + "domain" : { + "description" : "The intended domain of validity for the proof", + "example" : "example.com", + "type" : "string" + }, + "proofPurpose" : { + "description" : "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification", + "example" : "assertionMethod", + "type" : "string" + }, + "proofType" : { + "description" : "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry", + "example" : "Ed25519Signature2018", + "type" : "string" + } + }, + "required" : [ "proofType" ], + "type" : "object" + }, + "LedgerConfigInstance" : { + "properties" : { + "genesis_file" : { + "description" : "genesis_file", + "type" : "string" + }, + "genesis_transactions" : { + "description" : "genesis_transactions", + "type" : "string" + }, + "genesis_url" : { + "description" : "genesis_url", + "type" : "string" + }, + "id" : { + "description" : "ledger_id", + "type" : "string" + }, + "is_production" : { + "description" : "is_production", + "type" : "boolean" + } + }, + "type" : "object" + }, + "LedgerConfigList" : { + "properties" : { + "ledger_config_list" : { + "items" : { + "$ref" : "#/components/schemas/LedgerConfigInstance" + }, + "type" : "array" + } + }, + "required" : [ "ledger_config_list" ], + "type" : "object" + }, + "LedgerModulesResult" : { + "type" : "object" + }, + "LinkedDataProof" : { + "properties" : { + "challenge" : { + "description" : "Associates a challenge with a proof, for use with a proofPurpose such as authentication", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created" : { + "description" : "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "domain" : { + "description" : "A string value specifying the restricted domain of the signature.", + "example" : "example.com", + "pattern" : "\\w+:(\\/?\\/?)[^\\s]+", + "type" : "string" + }, + "jws" : { + "description" : "Associates a Detached Json Web Signature with a proof", + "example" : "eyJhbGciOiAiRWREUc2UsICJjcml0IjogWyJiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQ1Ch6YBKY7UBAjg6iBX5qBQ", + "type" : "string" + }, + "nonce" : { + "description" : "The nonce", + "example" : "CF69iO3nfvqRsRBNElE8b4wO39SyJHPM7Gg1nExltW5vSfQA1lvDCR/zXX1To0/4NLo==", + "type" : "string" + }, + "proofPurpose" : { + "description" : "Proof purpose", + "example" : "assertionMethod", + "type" : "string" + }, + "proofValue" : { + "description" : "The proof value of a proof", + "example" : "sy1AahqbzJQ63n9RtekmwzqZeVj494VppdAVJBnMYrTwft6cLJJGeTSSxCCJ6HKnRtwE7jjDh6sB2z2AAiZY9BBnCD8wUVgwqH3qchGRCuC2RugA4eQ9fUrR4Yuycac3caiaaay", + "type" : "string" + }, + "type" : { + "description" : "Identifies the digital signature suite that was used to create the signature", + "example" : "Ed25519Signature2018", + "type" : "string" + }, + "verificationMethod" : { + "description" : "Information used for proof verification", + "example" : "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL", + "pattern" : "\\w+:(\\/?\\/?)[^\\s]+", + "type" : "string" + } + }, + "required" : [ "created", "proofPurpose", "type", "verificationMethod" ], + "type" : "object" + }, + "MediationCreateRequest" : { + "properties" : { + "mediator_terms" : { + "description" : "List of mediator rules for recipient", + "items" : { + "description" : "Indicate terms to which the mediator requires the recipient to agree", + "type" : "string" + }, + "type" : "array" + }, + "recipient_terms" : { + "description" : "List of recipient rules for mediation", + "items" : { + "description" : "Indicate terms to which the recipient requires the mediator to agree", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "MediationDeny" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "mediator_terms" : { + "items" : { + "description" : "Terms for mediator to agree", + "type" : "string" + }, + "type" : "array" + }, + "recipient_terms" : { + "items" : { + "description" : "Terms for recipient to agree", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "MediationGrant" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "endpoint" : { + "description" : "endpoint on which messages destined for the recipient are received.", + "example" : "http://192.168.56.102:8020/", + "type" : "string" + }, + "routing_keys" : { + "items" : { + "description" : "Keys to use for forward message packaging", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "MediationIdMatchInfo" : { + "properties" : { + "mediation_id" : { + "description" : "Mediation record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + } + }, + "type" : "object" + }, + "MediationList" : { + "properties" : { + "results" : { + "description" : "List of mediation records", + "items" : { + "$ref" : "#/components/schemas/MediationRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "MediationRecord" : { + "properties" : { + "connection_id" : { + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "endpoint" : { + "type" : "string" + }, + "mediation_id" : { + "type" : "string" + }, + "mediator_terms" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "recipient_terms" : { + "items" : { + "type" : "string" + }, + "type" : "array" + }, + "role" : { + "type" : "string" + }, + "routing_keys" : { + "items" : { + "example" : "did:key:z6MkpTHR8VNsBxYAAWHut2Geadd9jSwuBV8xRoAnwWsdvktH", + "pattern" : "^did:key:z[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]+$", + "type" : "string" + }, + "type" : "array" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "required" : [ "connection_id", "role" ], + "type" : "object" + }, + "Menu" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "description" : { + "description" : "Introductory text for the menu", + "example" : "This menu presents options", + "type" : "string" + }, + "errormsg" : { + "description" : "An optional error message to display in menu header", + "example" : "Error: item not found", + "type" : "string" + }, + "options" : { + "description" : "List of menu options", + "items" : { + "$ref" : "#/components/schemas/MenuOption" + }, + "type" : "array" + }, + "title" : { + "description" : "Menu title", + "example" : "My Menu", + "type" : "string" + } + }, + "required" : [ "options" ], + "type" : "object" + }, + "MenuForm" : { + "properties" : { + "description" : { + "description" : "Additional descriptive text for menu form", + "example" : "Window preference settings", + "type" : "string" + }, + "params" : { + "description" : "List of form parameters", + "items" : { + "$ref" : "#/components/schemas/MenuFormParam" + }, + "type" : "array" + }, + "submit-label" : { + "description" : "Alternative label for form submit button", + "example" : "Send", + "type" : "string" + }, + "title" : { + "description" : "Menu form title", + "example" : "Preferences", + "type" : "string" + } + }, + "type" : "object" + }, + "MenuFormParam" : { + "properties" : { + "default" : { + "description" : "Default parameter value", + "example" : "0", + "type" : "string" + }, + "description" : { + "description" : "Additional descriptive text for menu form parameter", + "example" : "Delay in seconds before starting", + "type" : "string" + }, + "name" : { + "description" : "Menu parameter name", + "example" : "delay", + "type" : "string" + }, + "required" : { + "description" : "Whether parameter is required", + "example" : false, + "type" : "boolean" + }, + "title" : { + "description" : "Menu parameter title", + "example" : "Delay in seconds", + "type" : "string" + }, + "type" : { + "description" : "Menu form parameter input type", + "example" : "int", + "type" : "string" + } + }, + "required" : [ "name", "title" ], + "type" : "object" + }, + "MenuJson" : { + "properties" : { + "description" : { + "description" : "Introductory text for the menu", + "example" : "User preferences for window settings", + "type" : "string" + }, + "errormsg" : { + "description" : "Optional error message to display in menu header", + "example" : "Error: item not present", + "type" : "string" + }, + "options" : { + "description" : "List of menu options", + "items" : { + "$ref" : "#/components/schemas/MenuOption" + }, + "type" : "array" + }, + "title" : { + "description" : "Menu title", + "example" : "My Menu", + "type" : "string" + } + }, + "required" : [ "options" ], + "type" : "object" + }, + "MenuOption" : { + "properties" : { + "description" : { + "description" : "Additional descriptive text for menu option", + "example" : "Window display preferences", + "type" : "string" + }, + "disabled" : { + "description" : "Whether to show option as disabled", + "example" : false, + "type" : "boolean" + }, + "form" : { + "$ref" : "#/components/schemas/MenuForm" + }, + "name" : { + "description" : "Menu option name (unique identifier)", + "example" : "window_prefs", + "type" : "string" + }, + "title" : { + "description" : "Menu option title", + "example" : "Window Preferences", + "type" : "string" + } + }, + "required" : [ "name", "title" ], + "type" : "object" + }, + "MultitenantModuleResponse" : { + "type" : "object" + }, + "OobRecord" : { + "properties" : { + "attach_thread_id" : { + "description" : "Connection record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "connection_id" : { + "description" : "Connection record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "invi_msg_id" : { + "description" : "Invitation message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "invitation" : { + "$ref" : "#/components/schemas/InvitationRecord_invitation" + }, + "oob_id" : { + "description" : "Oob record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "our_recipient_key" : { + "description" : "Recipient key used for oob invitation", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "role" : { + "description" : "OOB Role", + "enum" : [ "sender", "receiver" ], + "example" : "receiver", + "type" : "string" + }, + "state" : { + "description" : "Out of band message exchange state", + "enum" : [ "initial", "prepare-response", "await-response", "reuse-not-accepted", "reuse-accepted", "done", "deleted" ], + "example" : "await-response", + "type" : "string" + }, + "their_service" : { + "$ref" : "#/components/schemas/ServiceDecorator" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "required" : [ "invi_msg_id", "invitation", "oob_id", "state" ], + "type" : "object" + }, + "PerformRequest" : { + "properties" : { + "name" : { + "description" : "Menu option name", + "example" : "Query", + "type" : "string" + }, + "params" : { + "additionalProperties" : { + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "description" : "Input parameter values", + "type" : "object" + } + }, + "type" : "object" + }, + "PingRequest" : { + "properties" : { + "comment" : { + "description" : "Comment for the ping message", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "PingRequestResponse" : { + "properties" : { + "thread_id" : { + "description" : "Thread ID of the ping message", + "type" : "string" + } + }, + "type" : "object" + }, + "PresentationDefinition" : { + "properties" : { + "format" : { + "$ref" : "#/components/schemas/ClaimFormat" + }, + "id" : { + "description" : "Unique Resource Identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "input_descriptors" : { + "items" : { + "$ref" : "#/components/schemas/InputDescriptors" + }, + "type" : "array" + }, + "name" : { + "description" : "Human-friendly name that describes what the presentation definition pertains to", + "type" : "string" + }, + "purpose" : { + "description" : "Describes the purpose for which the Presentation Definition's inputs are being requested", + "type" : "string" + }, + "submission_requirements" : { + "items" : { + "$ref" : "#/components/schemas/SubmissionRequirements" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "PresentationProposal" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "presentation_proposal" : { + "$ref" : "#/components/schemas/IndyPresPreview" + } + }, + "required" : [ "presentation_proposal" ], + "type" : "object" + }, + "PresentationRequest" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "request_presentations~attach" : { + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + } + }, + "required" : [ "request_presentations~attach" ], + "type" : "object" + }, + "ProtocolDescriptor" : { + "properties" : { + "pid" : { + "type" : "string" + }, + "roles" : { + "description" : "List of roles", + "items" : { + "description" : "Role: requester or responder", + "example" : "requester", + "type" : "string" + }, + "nullable" : true, + "type" : "array" + } + }, + "required" : [ "pid" ], + "type" : "object" + }, + "PublishRevocations" : { + "properties" : { + "rrid2crid" : { + "additionalProperties" : { + "items" : { + "description" : "Credential revocation identifier", + "example" : "12345", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "type" : "array" + }, + "description" : "Credential revocation ids by revocation registry id", + "type" : "object" + } + }, + "type" : "object" + }, + "Queries" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "queries" : { + "items" : { + "$ref" : "#/components/schemas/QueryItem" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "Query" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "nullable" : true, + "type" : "string" + }, + "query" : { + "type" : "string" + } + }, + "required" : [ "query" ], + "type" : "object" + }, + "QueryItem" : { + "properties" : { + "feature-type" : { + "description" : "feature type", + "enum" : [ "protocol", "goal-code" ], + "type" : "string" + }, + "match" : { + "description" : "match", + "type" : "string" + } + }, + "required" : [ "feature-type", "match" ], + "type" : "object" + }, + "RawEncoded" : { + "properties" : { + "encoded" : { + "description" : "Encoded value", + "example" : "-1", + "pattern" : "^-?[0-9]*$", + "type" : "string" + }, + "raw" : { + "description" : "Raw value", + "type" : "string" + } + }, + "type" : "object" + }, + "ReceiveInvitationRequest" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "did" : { + "description" : "DID for connection invitation", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "imageUrl" : { + "description" : "Optional image URL for connection invitation", + "example" : "http://192.168.56.101/img/logo.jpg", + "format" : "url", + "nullable" : true, + "type" : "string" + }, + "label" : { + "description" : "Optional label for connection invitation", + "example" : "Bob", + "type" : "string" + }, + "recipientKeys" : { + "description" : "List of recipient keys", + "items" : { + "description" : "Recipient public key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "routingKeys" : { + "description" : "List of routing keys", + "items" : { + "description" : "Routing key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "serviceEndpoint" : { + "description" : "Service endpoint at which to reach this agent", + "example" : "http://192.168.56.101:8020", + "type" : "string" + } + }, + "type" : "object" + }, + "RemoveWalletRequest" : { + "properties" : { + "wallet_key" : { + "description" : "Master key used for key derivation. Only required for unmanaged wallets.", + "example" : "MySecretKey123", + "type" : "string" + } + }, + "type" : "object" + }, + "ResolutionResult" : { + "properties" : { + "did_document" : { + "description" : "DID Document", + "properties" : { }, + "type" : "object" + }, + "metadata" : { + "description" : "Resolution metadata", + "properties" : { }, + "type" : "object" + } + }, + "required" : [ "did_document", "metadata" ], + "type" : "object" + }, + "RevRegCreateRequest" : { + "properties" : { + "credential_definition_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "max_cred_num" : { + "description" : "Revocation registry size", + "example" : 1000, + "format" : "int32", + "maximum" : 32768, + "minimum" : 4, + "type" : "integer" + } + }, + "type" : "object" + }, + "RevRegIssuedResult" : { + "properties" : { + "result" : { + "description" : "Number of credentials issued against revocation registry", + "example" : 0, + "format" : "int32", + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "RevRegResult" : { + "properties" : { + "result" : { + "$ref" : "#/components/schemas/IssuerRevRegRecord" + } + }, + "type" : "object" + }, + "RevRegUpdateTailsFileUri" : { + "properties" : { + "tails_public_uri" : { + "description" : "Public URI to the tails file", + "example" : "http://192.168.56.133:6543/revocation/registry/WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0/tails-file", + "format" : "url", + "type" : "string" + } + }, + "required" : [ "tails_public_uri" ], + "type" : "object" + }, + "RevRegWalletUpdatedResult" : { + "properties" : { + "accum_calculated" : { + "description" : "Calculated accumulator for phantom revocations", + "properties" : { }, + "type" : "object" + }, + "accum_fixed" : { + "description" : "Applied ledger transaction to fix revocations", + "properties" : { }, + "type" : "object" + }, + "rev_reg_delta" : { + "description" : "Indy revocation registry delta", + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "RevRegsCreated" : { + "properties" : { + "rev_reg_ids" : { + "items" : { + "description" : "Revocation registry identifiers", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "RevocationModuleResponse" : { + "type" : "object" + }, + "RevokeRequest" : { + "properties" : { + "comment" : { + "description" : "Optional comment to include in revocation notification", + "type" : "string" + }, + "connection_id" : { + "description" : "Connection ID to which the revocation notification will be sent; required if notify is true", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "cred_ex_id" : { + "description" : "Credential exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", + "type" : "string" + }, + "cred_rev_id" : { + "description" : "Credential revocation identifier", + "example" : "12345", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "notify" : { + "description" : "Send a notification to the credential recipient", + "type" : "boolean" + }, + "notify_version" : { + "description" : "Specify which version of the revocation notification should be sent", + "enum" : [ "v1_0", "v2_0" ], + "type" : "string" + }, + "publish" : { + "description" : "(True) publish revocation to ledger immediately, or (default, False) mark it pending", + "type" : "boolean" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread ID of the credential exchange message thread resulting in the credential now being revoked; required if notify is true", + "type" : "string" + } + }, + "type" : "object" + }, + "RouteRecord" : { + "properties" : { + "connection_id" : { + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "recipient_key" : { + "type" : "string" + }, + "record_id" : { + "type" : "string" + }, + "role" : { + "type" : "string" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "wallet_id" : { + "type" : "string" + } + }, + "required" : [ "recipient_key" ], + "type" : "object" + }, + "Schema" : { + "properties" : { + "attrNames" : { + "description" : "Schema attribute names", + "items" : { + "description" : "Attribute name", + "example" : "score", + "type" : "string" + }, + "type" : "array" + }, + "id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "name" : { + "description" : "Schema name", + "example" : "schema_name", + "type" : "string" + }, + "seqNo" : { + "description" : "Schema sequence number", + "example" : 10, + "format" : "int32", + "minimum" : 1, + "type" : "integer" + }, + "ver" : { + "description" : "Node protocol version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + }, + "version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "SchemaGetResult" : { + "properties" : { + "schema" : { + "$ref" : "#/components/schemas/Schema" + } + }, + "type" : "object" + }, + "SchemaInputDescriptor" : { + "properties" : { + "required" : { + "description" : "Required", + "type" : "boolean" + }, + "uri" : { + "description" : "URI", + "type" : "string" + } + }, + "type" : "object" + }, + "SchemaSendRequest" : { + "properties" : { + "attributes" : { + "description" : "List of schema attributes", + "items" : { + "description" : "attribute name", + "example" : "score", + "type" : "string" + }, + "type" : "array" + }, + "schema_name" : { + "description" : "Schema name", + "example" : "prefs", + "type" : "string" + }, + "schema_version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "required" : [ "attributes", "schema_name", "schema_version" ], + "type" : "object" + }, + "SchemaSendResult" : { + "properties" : { + "schema" : { + "$ref" : "#/components/schemas/SchemaSendResult_schema" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + } + }, + "required" : [ "schema_id" ], + "type" : "object" + }, + "SchemasCreatedResult" : { + "properties" : { + "schema_ids" : { + "items" : { + "description" : "Schema identifiers", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "SchemasInputDescriptorFilter" : { + "properties" : { + "oneof_filter" : { + "description" : "oneOf", + "type" : "boolean" + }, + "uri_groups" : { + "items" : { + "items" : { + "$ref" : "#/components/schemas/SchemaInputDescriptor" + }, + "type" : "array" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "SendMenu" : { + "properties" : { + "menu" : { + "$ref" : "#/components/schemas/SendMenu_menu" + } + }, + "required" : [ "menu" ], + "type" : "object" + }, + "SendMessage" : { + "properties" : { + "content" : { + "description" : "Message content", + "example" : "Hello", + "type" : "string" + } + }, + "type" : "object" + }, + "ServiceDecorator" : { + "properties" : { + "recipientKeys" : { + "description" : "List of recipient keys", + "items" : { + "description" : "Recipient public key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "routingKeys" : { + "description" : "List of routing keys", + "items" : { + "description" : "Routing key", + "example" : "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{43,44}$", + "type" : "string" + }, + "type" : "array" + }, + "serviceEndpoint" : { + "description" : "Service endpoint at which to reach this agent", + "example" : "http://192.168.56.101:8020", + "type" : "string" + } + }, + "required" : [ "recipientKeys", "serviceEndpoint" ], + "type" : "object" + }, + "SignRequest" : { + "properties" : { + "doc" : { + "$ref" : "#/components/schemas/Doc" + }, + "verkey" : { + "description" : "Verkey to use for signing", + "type" : "string" + } + }, + "required" : [ "doc", "verkey" ], + "type" : "object" + }, + "SignResponse" : { + "properties" : { + "error" : { + "description" : "Error text", + "type" : "string" + }, + "signed_doc" : { + "description" : "Signed document", + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "SignatureOptions" : { + "properties" : { + "challenge" : { + "type" : "string" + }, + "domain" : { + "type" : "string" + }, + "proofPurpose" : { + "type" : "string" + }, + "type" : { + "type" : "string" + }, + "verificationMethod" : { + "type" : "string" + } + }, + "required" : [ "proofPurpose", "verificationMethod" ], + "type" : "object" + }, + "SignedDoc" : { + "properties" : { + "proof" : { + "$ref" : "#/components/schemas/SignedDoc_proof" + } + }, + "required" : [ "proof" ], + "type" : "object" + }, + "SubmissionRequirements" : { + "properties" : { + "count" : { + "description" : "Count Value", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "from" : { + "description" : "From", + "type" : "string" + }, + "from_nested" : { + "items" : { + "$ref" : "#/components/schemas/SubmissionRequirements" + }, + "type" : "array" + }, + "max" : { + "description" : "Max Value", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "min" : { + "description" : "Min Value", + "example" : 1234, + "format" : "int32", + "type" : "integer" + }, + "name" : { + "description" : "Name", + "type" : "string" + }, + "purpose" : { + "description" : "Purpose", + "type" : "string" + }, + "rule" : { + "description" : "Selection", + "enum" : [ "all", "pick" ], + "type" : "string" + } + }, + "type" : "object" + }, + "TAAAccept" : { + "properties" : { + "mechanism" : { + "type" : "string" + }, + "text" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + }, + "type" : "object" + }, + "TAAAcceptance" : { + "properties" : { + "mechanism" : { + "type" : "string" + }, + "time" : { + "example" : 1640995199, + "format" : "int32", + "maximum" : 18446744073709551615, + "minimum" : 0, + "type" : "integer" + } + }, + "type" : "object" + }, + "TAAInfo" : { + "properties" : { + "aml_record" : { + "$ref" : "#/components/schemas/AMLRecord" + }, + "taa_accepted" : { + "$ref" : "#/components/schemas/TAAAcceptance" + }, + "taa_record" : { + "$ref" : "#/components/schemas/TAARecord" + }, + "taa_required" : { + "type" : "boolean" + } + }, + "type" : "object" + }, + "TAARecord" : { + "properties" : { + "digest" : { + "type" : "string" + }, + "text" : { + "type" : "string" + }, + "version" : { + "type" : "string" + } + }, + "type" : "object" + }, + "TAAResult" : { + "properties" : { + "result" : { + "$ref" : "#/components/schemas/TAAInfo" + } + }, + "type" : "object" + }, + "TailsDeleteResponse" : { + "properties" : { + "message" : { + "type" : "string" + } + }, + "type" : "object" + }, + "TransactionJobs" : { + "properties" : { + "transaction_my_job" : { + "description" : "My transaction related job", + "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ], + "type" : "string" + }, + "transaction_their_job" : { + "description" : "Their transaction related job", + "enum" : [ "TRANSACTION_AUTHOR", "TRANSACTION_ENDORSER", "reset" ], + "type" : "string" + } + }, + "type" : "object" + }, + "TransactionList" : { + "properties" : { + "results" : { + "description" : "List of transaction records", + "items" : { + "$ref" : "#/components/schemas/TransactionRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "TransactionRecord" : { + "properties" : { + "_type" : { + "description" : "Transaction type", + "example" : "101", + "type" : "string" + }, + "connection_id" : { + "description" : "The connection identifier for thie particular transaction record", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "endorser_write_txn" : { + "description" : "If True, Endorser will write the transaction after endorsing it", + "example" : true, + "type" : "boolean" + }, + "formats" : { + "items" : { + "additionalProperties" : { + "type" : "string" + }, + "example" : { + "attach_id" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "dif/endorse-transaction/request@v1.0" + }, + "type" : "object" + }, + "type" : "array" + }, + "messages_attach" : { + "items" : { + "example" : { + "@id" : "143c458d-1b1c-40c7-ab85-4d16808ddf0a", + "data" : { + "json" : "{\"endorser\": \"V4SGRU86Z58d6TV7PBUe6f\",\"identifier\": \"LjgpST2rjsoxYegQDRm7EL\",\"operation\": {\"data\": {\"attr_names\": [\"first_name\", \"last_name\"],\"name\": \"test_schema\",\"version\": \"2.1\",},\"type\": \"101\",},\"protocolVersion\": 2,\"reqId\": 1597766666168851000,\"signatures\": {\"LjgpST2rjsox\": \"4ATKMn6Y9sTgwqaGTm7py2c2M8x1EVDTWKZArwyuPgjU\"},\"taaAcceptance\": {\"mechanism\": \"manual\",\"taaDigest\": \"f50fe2c2ab977006761d36bd6f23e4c6a7e0fc2feb9f62\",\"time\": 1597708800,}}" + }, + "mime-type" : "application/json" + }, + "properties" : { }, + "type" : "object" + }, + "type" : "array" + }, + "meta_data" : { + "example" : { + "context" : { + "param1" : "param1_value", + "param2" : "param2_value" + }, + "post_process" : [ { + "topic" : "topic_value", + "other" : "other_value" + } ] + }, + "properties" : { }, + "type" : "object" + }, + "signature_request" : { + "items" : { + "example" : { + "author_goal_code" : "aries.transaction.ledger.write", + "context" : "did:sov", + "method" : "add-signature", + "signature_type" : "", + "signer_goal_code" : "aries.transaction.endorse" + }, + "properties" : { }, + "type" : "object" + }, + "type" : "array" + }, + "signature_response" : { + "items" : { + "example" : { + "context" : "did:sov", + "message_id" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "method" : "add-signature", + "signer_goal_code" : "aries.transaction.refuse" + }, + "properties" : { }, + "type" : "object" + }, + "type" : "array" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread Identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "timing" : { + "example" : { + "expires_time" : "2020-12-13T17:29:06+0000" + }, + "properties" : { }, + "type" : "object" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "transaction_id" : { + "description" : "Transaction identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "TxnOrCredentialDefinitionSendResult" : { + "properties" : { + "sent" : { + "$ref" : "#/components/schemas/CredentialDefinitionSendResult" + }, + "txn" : { + "$ref" : "#/components/schemas/TxnOrCredentialDefinitionSendResult_txn" + } + }, + "type" : "object" + }, + "TxnOrPublishRevocationsResult" : { + "properties" : { + "sent" : { + "$ref" : "#/components/schemas/PublishRevocations" + }, + "txn" : { + "$ref" : "#/components/schemas/TxnOrPublishRevocationsResult_txn" + } + }, + "type" : "object" + }, + "TxnOrRegisterLedgerNymResponse" : { + "properties" : { + "success" : { + "description" : "Success of nym registration operation", + "example" : true, + "type" : "boolean" + }, + "txn" : { + "$ref" : "#/components/schemas/TxnOrRegisterLedgerNymResponse_txn" + } + }, + "type" : "object" + }, + "TxnOrRevRegResult" : { + "properties" : { + "sent" : { + "$ref" : "#/components/schemas/RevRegResult" + }, + "txn" : { + "$ref" : "#/components/schemas/TxnOrRevRegResult_txn" + } + }, + "type" : "object" + }, + "TxnOrSchemaSendResult" : { + "properties" : { + "sent" : { + "$ref" : "#/components/schemas/TxnOrSchemaSendResult_sent" + }, + "txn" : { + "$ref" : "#/components/schemas/TxnOrSchemaSendResult_txn" + } + }, + "type" : "object" + }, + "UpdateWalletRequest" : { + "properties" : { + "image_url" : { + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "example" : "https://aries.ca/images/sample.png", + "type" : "string" + }, + "label" : { + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "example" : "Alice", + "type" : "string" + }, + "wallet_dispatch_type" : { + "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "enum" : [ "default", "both", "base" ], + "example" : "default", + "type" : "string" + }, + "wallet_webhook_urls" : { + "description" : "List of Webhook URLs associated with this subwallet", + "items" : { + "description" : "Optional webhook URL to receive webhook messages", + "example" : "http://localhost:8022/webhooks", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V10CredentialBoundOfferRequest" : { + "properties" : { + "counter_proposal" : { + "$ref" : "#/components/schemas/V10CredentialBoundOfferRequest_counter_proposal" + } + }, + "type" : "object" + }, + "V10CredentialConnFreeOfferRequest" : { + "properties" : { + "auto_issue" : { + "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "cred_def_id", "credential_preview" ], + "type" : "object" + }, + "V10CredentialCreate" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_proposal" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "issuer_did" : { + "description" : "Credential issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "schema_issuer_did" : { + "description" : "Schema issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_name" : { + "description" : "Schema name", + "example" : "preferences", + "type" : "string" + }, + "schema_version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "credential_proposal" ], + "type" : "object" + }, + "V10CredentialExchange" : { + "properties" : { + "auto_issue" : { + "description" : "Issuer choice to issue to request in this credential exchange", + "example" : false, + "type" : "boolean" + }, + "auto_offer" : { + "description" : "Holder choice to accept offer in this credential exchange", + "example" : false, + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Issuer choice to remove this credential exchange record when complete", + "example" : false, + "type" : "boolean" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "credential" : { + "$ref" : "#/components/schemas/V10CredentialExchange_credential" + }, + "credential_definition_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_exchange_id" : { + "description" : "Credential exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "credential_id" : { + "description" : "Credential identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "credential_offer" : { + "$ref" : "#/components/schemas/V10CredentialExchange_credential_offer" + }, + "credential_offer_dict" : { + "$ref" : "#/components/schemas/V10CredentialExchange_credential_offer_dict" + }, + "credential_proposal_dict" : { + "$ref" : "#/components/schemas/V10CredentialExchange_credential_proposal_dict" + }, + "credential_request" : { + "$ref" : "#/components/schemas/V10CredentialExchange_credential_request" + }, + "credential_request_metadata" : { + "description" : "(Indy) credential request metadata", + "properties" : { }, + "type" : "object" + }, + "error_msg" : { + "description" : "Error message", + "example" : "Credential definition identifier is not set in proposal", + "type" : "string" + }, + "initiator" : { + "description" : "Issue-credential exchange initiator: self or external", + "enum" : [ "self", "external" ], + "example" : "self", + "type" : "string" + }, + "parent_thread_id" : { + "description" : "Parent thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "raw_credential" : { + "$ref" : "#/components/schemas/V10CredentialExchange_raw_credential" + }, + "revoc_reg_id" : { + "description" : "Revocation registry identifier", + "type" : "string" + }, + "revocation_id" : { + "description" : "Credential identifier within revocation registry", + "type" : "string" + }, + "role" : { + "description" : "Issue-credential exchange role: holder or issuer", + "enum" : [ "holder", "issuer" ], + "example" : "issuer", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "state" : { + "description" : "Issue-credential exchange state", + "example" : "credential_acked", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V10CredentialExchangeListResult" : { + "properties" : { + "results" : { + "description" : "Aries#0036 v1.0 credential exchange records", + "items" : { + "$ref" : "#/components/schemas/V10CredentialExchange" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V10CredentialFreeOfferRequest" : { + "properties" : { + "auto_issue" : { + "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "connection_id", "cred_def_id", "credential_preview" ], + "type" : "object" + }, + "V10CredentialIssueRequest" : { + "properties" : { + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "V10CredentialProblemReportRequest" : { + "properties" : { + "description" : { + "type" : "string" + } + }, + "required" : [ "description" ], + "type" : "object" + }, + "V10CredentialProposalRequestMand" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_proposal" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "issuer_did" : { + "description" : "Credential issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "schema_issuer_did" : { + "description" : "Schema issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_name" : { + "description" : "Schema name", + "example" : "preferences", + "type" : "string" + }, + "schema_version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "connection_id", "credential_proposal" ], + "type" : "object" + }, + "V10CredentialProposalRequestOpt" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "credential_proposal" : { + "$ref" : "#/components/schemas/CredentialPreview" + }, + "issuer_did" : { + "description" : "Credential issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "schema_issuer_did" : { + "description" : "Schema issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_name" : { + "description" : "Schema name", + "example" : "preferences", + "type" : "string" + }, + "schema_version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "connection_id" ], + "type" : "object" + }, + "V10CredentialStoreRequest" : { + "properties" : { + "credential_id" : { + "type" : "string" + } + }, + "type" : "object" + }, + "V10DiscoveryExchangeListResult" : { + "properties" : { + "results" : { + "items" : { + "$ref" : "#/components/schemas/V10DiscoveryExchangeListResult_results_inner" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V10DiscoveryRecord" : { + "properties" : { + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "disclose" : { + "$ref" : "#/components/schemas/V10DiscoveryRecord_disclose" + }, + "discovery_exchange_id" : { + "description" : "Credential exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "query_msg" : { + "$ref" : "#/components/schemas/V10DiscoveryRecord_query_msg" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V10PresentProofModuleResponse" : { + "type" : "object" + }, + "V10PresentationCreateRequestRequest" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "comment" : { + "nullable" : true, + "type" : "string" + }, + "proof_request" : { + "$ref" : "#/components/schemas/IndyProofRequest" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "proof_request" ], + "type" : "object" + }, + "V10PresentationExchange" : { + "properties" : { + "auto_present" : { + "description" : "Prover choice to auto-present proof as verifier requests", + "example" : false, + "type" : "boolean" + }, + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "type" : "boolean" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "error_msg" : { + "description" : "Error message", + "example" : "Invalid structure", + "type" : "string" + }, + "initiator" : { + "description" : "Present-proof exchange initiator: self or external", + "enum" : [ "self", "external" ], + "example" : "self", + "type" : "string" + }, + "presentation" : { + "$ref" : "#/components/schemas/V10PresentationExchange_presentation" + }, + "presentation_exchange_id" : { + "description" : "Presentation exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "presentation_proposal_dict" : { + "$ref" : "#/components/schemas/V10PresentationExchange_presentation_proposal_dict" + }, + "presentation_request" : { + "$ref" : "#/components/schemas/V10PresentationExchange_presentation_request" + }, + "presentation_request_dict" : { + "$ref" : "#/components/schemas/V10PresentationExchange_presentation_request_dict" + }, + "role" : { + "description" : "Present-proof exchange role: prover or verifier", + "enum" : [ "prover", "verifier" ], + "example" : "prover", + "type" : "string" + }, + "state" : { + "description" : "Present-proof exchange state", + "example" : "verified", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "verified" : { + "description" : "Whether presentation is verified: true or false", + "enum" : [ "true", "false" ], + "example" : "true", + "type" : "string" + }, + "verified_msgs" : { + "items" : { + "description" : "Proof verification warning or error information", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V10PresentationExchangeList" : { + "properties" : { + "results" : { + "description" : "Aries RFC 37 v1.0 presentation exchange records", + "items" : { + "$ref" : "#/components/schemas/V10PresentationExchange" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V10PresentationProblemReportRequest" : { + "properties" : { + "description" : { + "type" : "string" + } + }, + "required" : [ "description" ], + "type" : "object" + }, + "V10PresentationProposalRequest" : { + "properties" : { + "auto_present" : { + "description" : "Whether to respond automatically to presentation requests, building and presenting requested proof", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "presentation_proposal" : { + "$ref" : "#/components/schemas/IndyPresPreview" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "connection_id", "presentation_proposal" ], + "type" : "object" + }, + "V10PresentationSendRequestRequest" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "comment" : { + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "proof_request" : { + "$ref" : "#/components/schemas/IndyProofRequest" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "connection_id", "proof_request" ], + "type" : "object" + }, + "V10PresentationSendRequestToProposal" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "V20CredAttrSpec" : { + "properties" : { + "mime-type" : { + "description" : "MIME type: omit for (null) default", + "example" : "image/jpeg", + "nullable" : true, + "type" : "string" + }, + "name" : { + "description" : "Attribute name", + "example" : "favourite_drink", + "type" : "string" + }, + "value" : { + "description" : "Attribute value: base64-encode if MIME type is present", + "example" : "martini", + "type" : "string" + } + }, + "required" : [ "name", "value" ], + "type" : "object" + }, + "V20CredBoundOfferRequest" : { + "properties" : { + "counter_preview" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_counter_preview" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_filter" + } + }, + "type" : "object" + }, + "V20CredExFree" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredPreview" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_filter" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "verification_method" : { + "description" : "For ld-proofs. Verification method for signing.", + "nullable" : true, + "type" : "string" + } + }, + "required" : [ "connection_id", "filter" ], + "type" : "object" + }, + "V20CredExRecord" : { + "properties" : { + "auto_issue" : { + "description" : "Issuer choice to issue to request in this credential exchange", + "example" : false, + "type" : "boolean" + }, + "auto_offer" : { + "description" : "Holder choice to accept offer in this credential exchange", + "example" : false, + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Issuer choice to remove this credential exchange record when complete", + "example" : false, + "type" : "boolean" + }, + "by_format" : { + "$ref" : "#/components/schemas/V20CredExRecord_by_format" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "cred_ex_id" : { + "description" : "Credential exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_issue" : { + "$ref" : "#/components/schemas/V20CredExRecord_cred_issue" + }, + "cred_offer" : { + "$ref" : "#/components/schemas/V20CredExRecord_cred_offer" + }, + "cred_preview" : { + "$ref" : "#/components/schemas/V20CredExRecord_cred_preview" + }, + "cred_proposal" : { + "$ref" : "#/components/schemas/V20CredExRecord_cred_proposal" + }, + "cred_request" : { + "$ref" : "#/components/schemas/V20CredExRecord_cred_request" + }, + "error_msg" : { + "description" : "Error message", + "example" : "The front fell off", + "type" : "string" + }, + "initiator" : { + "description" : "Issue-credential exchange initiator: self or external", + "enum" : [ "self", "external" ], + "example" : "self", + "type" : "string" + }, + "parent_thread_id" : { + "description" : "Parent thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "role" : { + "description" : "Issue-credential exchange role: holder or issuer", + "enum" : [ "issuer", "holder" ], + "example" : "issuer", + "type" : "string" + }, + "state" : { + "description" : "Issue-credential exchange state", + "enum" : [ "proposal-sent", "proposal-received", "offer-sent", "offer-received", "request-sent", "request-received", "credential-issued", "credential-received", "done", "credential-revoked", "abandoned", "deleted" ], + "example" : "done", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredExRecordByFormat" : { + "properties" : { + "cred_issue" : { + "properties" : { }, + "type" : "object" + }, + "cred_offer" : { + "properties" : { }, + "type" : "object" + }, + "cred_proposal" : { + "properties" : { }, + "type" : "object" + }, + "cred_request" : { + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "V20CredExRecordDetail" : { + "properties" : { + "cred_ex_record" : { + "$ref" : "#/components/schemas/V20CredExRecordDetail_cred_ex_record" + }, + "indy" : { + "$ref" : "#/components/schemas/V20CredExRecordIndy" + }, + "ld_proof" : { + "$ref" : "#/components/schemas/V20CredExRecordLDProof" + } + }, + "type" : "object" + }, + "V20CredExRecordIndy" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "cred_ex_id" : { + "description" : "Corresponding v2.0 credential exchange record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_ex_indy_id" : { + "description" : "Record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_id_stored" : { + "description" : "Credential identifier stored in wallet", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_request_metadata" : { + "description" : "Credential request metadata for indy holder", + "properties" : { }, + "type" : "object" + }, + "cred_rev_id" : { + "description" : "Credential revocation identifier within revocation registry", + "example" : "12345", + "pattern" : "^[1-9][0-9]*$", + "type" : "string" + }, + "rev_reg_id" : { + "description" : "Revocation registry identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:4:WgWxqztrNooG92RXvxSTWv:3:CL:20:tag:CL_ACCUM:0", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):4:([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+))(:.+)?:CL_ACCUM:(.+$)", + "type" : "string" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredExRecordLDProof" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "cred_ex_id" : { + "description" : "Corresponding v2.0 credential exchange record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_ex_ld_proof_id" : { + "description" : "Record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "cred_id_stored" : { + "description" : "Credential identifier stored in wallet", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredExRecordListResult" : { + "properties" : { + "results" : { + "description" : "Credential exchange records and corresponding detail records", + "items" : { + "$ref" : "#/components/schemas/V20CredExRecordDetail" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V20CredFilter" : { + "properties" : { + "indy" : { + "$ref" : "#/components/schemas/V20CredFilter_indy" + }, + "ld_proof" : { + "$ref" : "#/components/schemas/V20CredFilter_ld_proof" + } + }, + "type" : "object" + }, + "V20CredFilterIndy" : { + "properties" : { + "cred_def_id" : { + "description" : "Credential definition identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:3:CL:20:tag", + "pattern" : "^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$", + "type" : "string" + }, + "issuer_did" : { + "description" : "Credential issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_id" : { + "description" : "Schema identifier", + "example" : "WgWxqztrNooG92RXvxSTWv:2:schema_name:1.0", + "pattern" : "^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+$", + "type" : "string" + }, + "schema_issuer_did" : { + "description" : "Schema issuer DID", + "example" : "WgWxqztrNooG92RXvxSTWv", + "pattern" : "^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$", + "type" : "string" + }, + "schema_name" : { + "description" : "Schema name", + "example" : "preferences", + "type" : "string" + }, + "schema_version" : { + "description" : "Schema version", + "example" : "1.0", + "pattern" : "^[0-9.]+$", + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredFilterLDProof" : { + "properties" : { + "ld_proof" : { + "$ref" : "#/components/schemas/V20CredFilter_ld_proof" + } + }, + "required" : [ "ld_proof" ], + "type" : "object" + }, + "V20CredFormat" : { + "properties" : { + "attach_id" : { + "description" : "Attachment identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "format" : { + "description" : "Attachment format specifier", + "example" : "aries/ld-proof-vc-detail@v1.0", + "type" : "string" + } + }, + "required" : [ "attach_id", "format" ], + "type" : "object" + }, + "V20CredIssue" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credentials~attach" : { + "description" : "Credential attachments", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + }, + "formats" : { + "description" : "Acceptable attachment formats", + "items" : { + "$ref" : "#/components/schemas/V20CredFormat" + }, + "type" : "array" + }, + "replacement_id" : { + "description" : "Issuer-unique identifier to coordinate credential replacement", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + } + }, + "required" : [ "credentials~attach", "formats" ], + "type" : "object" + }, + "V20CredIssueProblemReportRequest" : { + "properties" : { + "description" : { + "type" : "string" + } + }, + "required" : [ "description" ], + "type" : "object" + }, + "V20CredIssueRequest" : { + "properties" : { + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredOffer" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredPreview" + }, + "formats" : { + "description" : "Acceptable credential formats", + "items" : { + "$ref" : "#/components/schemas/V20CredFormat" + }, + "type" : "array" + }, + "offers~attach" : { + "description" : "Offer attachments", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + }, + "replacement_id" : { + "description" : "Issuer-unique identifier to coordinate credential replacement", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + } + }, + "required" : [ "formats", "offers~attach" ], + "type" : "object" + }, + "V20CredOfferConnFreeRequest" : { + "properties" : { + "auto_issue" : { + "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredPreview" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_filter" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "filter" ], + "type" : "object" + }, + "V20CredOfferRequest" : { + "properties" : { + "auto_issue" : { + "description" : "Whether to respond automatically to credential requests, creating and issuing requested credentials", + "type" : "boolean" + }, + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredPreview" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_filter" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "connection_id", "filter" ], + "type" : "object" + }, + "V20CredPreview" : { + "properties" : { + "@type" : { + "description" : "Message type identifier", + "example" : "issue-credential/2.0/credential-preview", + "type" : "string" + }, + "attributes" : { + "items" : { + "$ref" : "#/components/schemas/V20CredAttrSpec" + }, + "type" : "array" + } + }, + "required" : [ "attributes" ], + "type" : "object" + }, + "V20CredProposal" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredProposal_credential_preview" + }, + "filters~attach" : { + "description" : "Credential filter per acceptable format on corresponding identifier", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + }, + "formats" : { + "description" : "Attachment formats", + "items" : { + "$ref" : "#/components/schemas/V20CredFormat" + }, + "type" : "array" + } + }, + "required" : [ "filters~attach", "formats" ], + "type" : "object" + }, + "V20CredRequest" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "formats" : { + "description" : "Acceptable attachment formats", + "items" : { + "$ref" : "#/components/schemas/V20CredFormat" + }, + "type" : "array" + }, + "requests~attach" : { + "description" : "Request attachments", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + } + }, + "required" : [ "formats", "requests~attach" ], + "type" : "object" + }, + "V20CredRequestFree" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredRequestFree_filter" + }, + "holder_did" : { + "description" : "Holder DID to substitute for the credentialSubject.id", + "example" : "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", + "nullable" : true, + "type" : "string" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "connection_id", "filter" ], + "type" : "object" + }, + "V20CredRequestRequest" : { + "properties" : { + "holder_did" : { + "description" : "Holder DID to substitute for the credentialSubject.id", + "example" : "did:key:ahsdkjahsdkjhaskjdhakjshdkajhsdkjahs", + "nullable" : true, + "type" : "string" + } + }, + "type" : "object" + }, + "V20CredStoreRequest" : { + "properties" : { + "credential_id" : { + "type" : "string" + } + }, + "type" : "object" + }, + "V20DiscoveryExchangeListResult" : { + "properties" : { + "results" : { + "items" : { + "$ref" : "#/components/schemas/V20DiscoveryExchangeListResult_results_inner" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V20DiscoveryExchangeResult" : { + "properties" : { + "results" : { + "$ref" : "#/components/schemas/V20DiscoveryExchangeListResult_results_inner" + } + }, + "type" : "object" + }, + "V20DiscoveryRecord" : { + "properties" : { + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "disclosures" : { + "$ref" : "#/components/schemas/V20DiscoveryRecord_disclosures" + }, + "discovery_exchange_id" : { + "description" : "Credential exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "queries_msg" : { + "$ref" : "#/components/schemas/V20DiscoveryRecord_queries_msg" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + } + }, + "type" : "object" + }, + "V20IssueCredSchemaCore" : { + "properties" : { + "auto_remove" : { + "description" : "Whether to remove the credential exchange record on completion (overrides --preserve-exchange-records configuration setting)", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "credential_preview" : { + "$ref" : "#/components/schemas/V20CredPreview" + }, + "filter" : { + "$ref" : "#/components/schemas/V20CredBoundOfferRequest_filter" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "required" : [ "filter" ], + "type" : "object" + }, + "V20IssueCredentialModuleResponse" : { + "type" : "object" + }, + "V20Pres" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "formats" : { + "description" : "Acceptable attachment formats", + "items" : { + "$ref" : "#/components/schemas/V20PresFormat" + }, + "type" : "array" + }, + "presentations~attach" : { + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + } + }, + "required" : [ "formats", "presentations~attach" ], + "type" : "object" + }, + "V20PresCreateRequestRequest" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "comment" : { + "nullable" : true, + "type" : "string" + }, + "presentation_request" : { + "$ref" : "#/components/schemas/V20PresRequestByFormat" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "presentation_request" ], + "type" : "object" + }, + "V20PresExRecord" : { + "properties" : { + "auto_present" : { + "description" : "Prover choice to auto-present proof as verifier requests", + "example" : false, + "type" : "boolean" + }, + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "type" : "boolean" + }, + "by_format" : { + "$ref" : "#/components/schemas/V20PresExRecord_by_format" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "error_msg" : { + "description" : "Error message", + "example" : "Invalid structure", + "type" : "string" + }, + "initiator" : { + "description" : "Present-proof exchange initiator: self or external", + "enum" : [ "self", "external" ], + "example" : "self", + "type" : "string" + }, + "pres" : { + "$ref" : "#/components/schemas/V20PresExRecord_pres" + }, + "pres_ex_id" : { + "description" : "Presentation exchange identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "pres_proposal" : { + "$ref" : "#/components/schemas/V20PresExRecord_pres_proposal" + }, + "pres_request" : { + "$ref" : "#/components/schemas/V20PresExRecord_pres_request" + }, + "role" : { + "description" : "Present-proof exchange role: prover or verifier", + "enum" : [ "prover", "verifier" ], + "example" : "prover", + "type" : "string" + }, + "state" : { + "description" : "Present-proof exchange state", + "enum" : [ "proposal-sent", "proposal-received", "request-sent", "request-received", "presentation-sent", "presentation-received", "done", "abandoned", "deleted" ], + "type" : "string" + }, + "thread_id" : { + "description" : "Thread identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "verified" : { + "description" : "Whether presentation is verified: 'true' or 'false'", + "enum" : [ "true", "false" ], + "example" : "true", + "type" : "string" + }, + "verified_msgs" : { + "items" : { + "description" : "Proof verification warning or error information", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V20PresExRecordByFormat" : { + "properties" : { + "pres" : { + "properties" : { }, + "type" : "object" + }, + "pres_proposal" : { + "properties" : { }, + "type" : "object" + }, + "pres_request" : { + "properties" : { }, + "type" : "object" + } + }, + "type" : "object" + }, + "V20PresExRecordList" : { + "properties" : { + "results" : { + "description" : "Presentation exchange records", + "items" : { + "$ref" : "#/components/schemas/V20PresExRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "V20PresFormat" : { + "properties" : { + "attach_id" : { + "description" : "Attachment identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "format" : { + "description" : "Attachment format specifier", + "example" : "dif/presentation-exchange/submission@v1.0", + "type" : "string" + } + }, + "required" : [ "attach_id", "format" ], + "type" : "object" + }, + "V20PresProblemReportRequest" : { + "properties" : { + "description" : { + "type" : "string" + } + }, + "required" : [ "description" ], + "type" : "object" + }, + "V20PresProposal" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "type" : "string" + }, + "formats" : { + "items" : { + "$ref" : "#/components/schemas/V20PresFormat" + }, + "type" : "array" + }, + "proposals~attach" : { + "description" : "Attachment per acceptable format on corresponding identifier", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + } + }, + "required" : [ "formats", "proposals~attach" ], + "type" : "object" + }, + "V20PresProposalByFormat" : { + "properties" : { + "dif" : { + "$ref" : "#/components/schemas/V20PresProposalByFormat_dif" + }, + "indy" : { + "$ref" : "#/components/schemas/V20PresProposalByFormat_indy" + } + }, + "type" : "object" + }, + "V20PresProposalRequest" : { + "properties" : { + "auto_present" : { + "description" : "Whether to respond automatically to presentation requests, building and presenting requested proof", + "type" : "boolean" + }, + "comment" : { + "description" : "Human-readable comment", + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "presentation_proposal" : { + "$ref" : "#/components/schemas/V20PresProposalByFormat" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "connection_id", "presentation_proposal" ], + "type" : "object" + }, + "V20PresRequest" : { + "properties" : { + "@id" : { + "description" : "Message identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "@type" : { + "description" : "Message type", + "example" : "https://didcomm.org/my-family/1.0/my-message-type", + "readOnly" : true, + "type" : "string" + }, + "comment" : { + "description" : "Human-readable comment", + "type" : "string" + }, + "formats" : { + "items" : { + "$ref" : "#/components/schemas/V20PresFormat" + }, + "type" : "array" + }, + "request_presentations~attach" : { + "description" : "Attachment per acceptable format on corresponding identifier", + "items" : { + "$ref" : "#/components/schemas/AttachDecorator" + }, + "type" : "array" + }, + "will_confirm" : { + "description" : "Whether verifier will send confirmation ack", + "type" : "boolean" + } + }, + "required" : [ "formats", "request_presentations~attach" ], + "type" : "object" + }, + "V20PresRequestByFormat" : { + "properties" : { + "dif" : { + "$ref" : "#/components/schemas/V20PresRequestByFormat_dif" + }, + "indy" : { + "$ref" : "#/components/schemas/V20PresRequestByFormat_indy" + } + }, + "type" : "object" + }, + "V20PresSendRequestRequest" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "comment" : { + "nullable" : true, + "type" : "string" + }, + "connection_id" : { + "description" : "Connection identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "format" : "uuid", + "type" : "string" + }, + "presentation_request" : { + "$ref" : "#/components/schemas/V20PresRequestByFormat" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "required" : [ "connection_id", "presentation_request" ], + "type" : "object" + }, + "V20PresSpecByFormatRequest" : { + "properties" : { + "dif" : { + "$ref" : "#/components/schemas/V20PresSpecByFormatRequest_dif" + }, + "indy" : { + "$ref" : "#/components/schemas/V20PresSpecByFormatRequest_indy" + }, + "trace" : { + "description" : "Record trace information, based on agent configuration", + "type" : "boolean" + } + }, + "type" : "object" + }, + "V20PresentProofModuleResponse" : { + "type" : "object" + }, + "V20PresentationSendRequestToProposal" : { + "properties" : { + "auto_verify" : { + "description" : "Verifier choice to auto-verify proof presentation", + "example" : false, + "type" : "boolean" + }, + "trace" : { + "description" : "Whether to trace event (default false)", + "example" : false, + "type" : "boolean" + } + }, + "type" : "object" + }, + "VCRecord" : { + "properties" : { + "contexts" : { + "items" : { + "description" : "Context", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "type" : "array" + }, + "cred_tags" : { + "additionalProperties" : { + "description" : "Retrieval tag value", + "type" : "string" + }, + "type" : "object" + }, + "cred_value" : { + "description" : "(JSON-serializable) credential value", + "properties" : { }, + "type" : "object" + }, + "expanded_types" : { + "items" : { + "description" : "JSON-LD expanded type extracted from type and context", + "example" : "https://w3id.org/citizenship#PermanentResidentCard", + "type" : "string" + }, + "type" : "array" + }, + "given_id" : { + "description" : "Credential identifier", + "example" : "http://example.edu/credentials/3732", + "type" : "string" + }, + "issuer_id" : { + "description" : "Issuer identifier", + "example" : "https://example.edu/issuers/14", + "type" : "string" + }, + "proof_types" : { + "items" : { + "description" : "Signature suite used for proof", + "example" : "Ed25519Signature2018", + "type" : "string" + }, + "type" : "array" + }, + "record_id" : { + "description" : "Record identifier", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + }, + "schema_ids" : { + "items" : { + "description" : "Schema identifier", + "example" : "https://example.org/examples/degree.json", + "type" : "string" + }, + "type" : "array" + }, + "subject_ids" : { + "items" : { + "description" : "Subject identifier", + "example" : "did:example:ebfeb1f712ebc6f1c276e12ec21", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "VCRecordList" : { + "properties" : { + "results" : { + "items" : { + "$ref" : "#/components/schemas/VCRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "VerifyRequest" : { + "properties" : { + "doc" : { + "$ref" : "#/components/schemas/VerifyRequest_doc" + }, + "verkey" : { + "description" : "Verkey to use for doc verification", + "type" : "string" + } + }, + "required" : [ "doc" ], + "type" : "object" + }, + "VerifyResponse" : { + "properties" : { + "error" : { + "description" : "Error text", + "type" : "string" + }, + "valid" : { + "type" : "boolean" + } + }, + "required" : [ "valid" ], + "type" : "object" + }, + "W3CCredentialsListRequest" : { + "properties" : { + "contexts" : { + "items" : { + "description" : "Credential context to match", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "type" : "array" + }, + "given_id" : { + "description" : "Given credential id to match", + "type" : "string" + }, + "issuer_id" : { + "description" : "Credential issuer identifier to match", + "type" : "string" + }, + "max_results" : { + "description" : "Maximum number of results to return", + "format" : "int32", + "type" : "integer" + }, + "proof_types" : { + "items" : { + "description" : "Signature suite used for proof", + "example" : "Ed25519Signature2018", + "type" : "string" + }, + "type" : "array" + }, + "schema_ids" : { + "description" : "Schema identifiers, all of which to match", + "items" : { + "description" : "Credential schema identifier", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "type" : "array" + }, + "subject_ids" : { + "description" : "Subject identifiers, all of which to match", + "items" : { + "description" : "Subject identifier", + "type" : "string" + }, + "type" : "array" + }, + "tag_query" : { + "additionalProperties" : { + "description" : "Tag value", + "type" : "string" + }, + "description" : "Tag filter", + "type" : "object" + }, + "types" : { + "items" : { + "description" : "Credential type to match", + "example" : "https://myhost:8021", + "pattern" : "^[A-Za-z0-9\\.\\-\\+]+://([A-Za-z0-9][.A-Za-z0-9-_]+[A-Za-z0-9])+(:[1-9][0-9]*)?(/[^?&#]+)?$", + "type" : "string" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "WalletList" : { + "properties" : { + "results" : { + "description" : "List of wallet records", + "items" : { + "$ref" : "#/components/schemas/WalletRecord" + }, + "type" : "array" + } + }, + "type" : "object" + }, + "WalletModuleResponse" : { + "type" : "object" + }, + "WalletRecord" : { + "properties" : { + "created_at" : { + "description" : "Time of record creation", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "key_management_mode" : { + "description" : "Mode regarding management of wallet key", + "enum" : [ "managed", "unmanaged" ], + "type" : "string" + }, + "settings" : { + "description" : "Settings for this wallet.", + "properties" : { }, + "type" : "object" + }, + "state" : { + "description" : "Current record state", + "example" : "active", + "type" : "string" + }, + "updated_at" : { + "description" : "Time of last record update", + "example" : "2021-12-31T23:59:59Z", + "pattern" : "^\\d{4}-\\d\\d-\\d\\d[T ]\\d\\d:\\d\\d(?:\\:(?:\\d\\d(?:\\.\\d{1,6})?))?(?:[+-]\\d\\d:?\\d\\d|Z|)$", + "type" : "string" + }, + "wallet_id" : { + "description" : "Wallet record ID", + "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", + "type" : "string" + } + }, + "required" : [ "key_management_mode", "wallet_id" ], + "type" : "object" + }, + "WriteLedgerRequest" : { + "properties" : { + "ledger_id" : { + "type" : "string" + } + }, + "type" : "object" + }, + "ActionMenuFetchResult_result" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Menu" + } ], + "description" : "Action menu", + "type" : "object" + }, + "AttachDecoratorData_jws" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AttachDecoratorDataJWS" + } ], + "description" : "Detached Java Web Signature", + "type" : "object" + }, + "CredDefValue_primary" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredDefValuePrimary" + } ], + "description" : "Primary value for credential definition", + "type" : "object" + }, + "CredDefValue_revocation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredDefValueRevocation" + } ], + "description" : "Revocation value for credential definition", + "type" : "object" + }, + "Credential_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/LinkedDataProof" + } ], + "description" : "The proof of the credential", + "example" : { + "created" : "2019-12-11T03:50:55", + "jws" : "eyJhbGciOiAiRWREU0EiLCAiYjY0IjogZmFsc2UsICJjcml0JiNjQiXX0..lKJU0Df_keblRKhZAS9Qq6zybm-HqUXNVZ8vgEPNTAjQKBhQDxvXNo7nvtUBb_Eq1Ch6YBKY5qBQ", + "proofPurpose" : "assertionMethod", + "type" : "Ed25519Signature2018", + "verificationMethod" : "did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL" + }, + "type" : "object" + }, + "CredentialDefinition_value" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredDefValue" + } ], + "description" : "Credential definition primary and revocation values", + "type" : "object" + }, + "DIDCreate_options" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DIDCreateOptions" + } ], + "description" : "To define a key type and/or a did depending on chosen DID method.", + "type" : "object" + }, + "DIDXRequest_did_doc_attach" : { + "allOf" : [ { + "$ref" : "#/components/schemas/AttachDecorator" + } ], + "description" : "As signed attachment, DID Doc associated with DID", + "type" : "object" + }, + "Doc_options" : { + "allOf" : [ { + "$ref" : "#/components/schemas/SignatureOptions" + } ], + "description" : "Signature options", + "type" : "object" + }, + "IndyCredAbstract_key_correctness_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyKeyCorrectnessProof" + } ], + "description" : "Key correctness proof", + "type" : "object" + }, + "IndyCredPrecis_cred_info" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyCredInfo" + } ], + "description" : "Credential info", + "type" : "object" + }, + "IndyCredPrecis_interval" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyNonRevocationInterval" + } ], + "description" : "Non-revocation interval from presentation request", + "type" : "object" + }, + "IndyCredential_values_value" : { + "allOf" : [ { + "$ref" : "#/definitions/IndyAttrValue" + } ], + "description" : "Attribute value", + "type" : "object" + }, + "IndyPrimaryProof_eq_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyEQProof" + } ], + "description" : "Indy equality proof", + "nullable" : true, + "type" : "object" + }, + "IndyProof_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofProof" + } ], + "description" : "Indy proof.proof content", + "type" : "object" + }, + "IndyProof_requested_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofRequestedProof" + } ], + "description" : "Indy proof.requested_proof content", + "type" : "object" + }, + "IndyProofProof_aggregated_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofProofAggregatedProof" + } ], + "description" : "Indy proof aggregated proof", + "type" : "object" + }, + "IndyProofProofProofsProof_non_revoc_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyNonRevocProof" + } ], + "description" : "Indy non-revocation proof", + "nullable" : true, + "type" : "object" + }, + "IndyProofProofProofsProof_primary_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyPrimaryProof" + } ], + "description" : "Indy primary proof", + "type" : "object" + }, + "IndyProofReqAttrSpec_non_revoked" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofReqAttrSpecNonRevoked" + } ], + "nullable" : true, + "type" : "object" + }, + "IndyProofReqPredSpec_non_revoked" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofReqPredSpecNonRevoked" + } ], + "nullable" : true, + "type" : "object" + }, + "IndyProofRequest_non_revoked" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofRequestNonRevoked" + } ], + "nullable" : true, + "type" : "object" + }, + "IndyRevRegDef_value" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyRevRegDefValue" + } ], + "description" : "Revocation registry definition value", + "type" : "object" + }, + "IndyRevRegDefValue_publicKeys" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyRevRegDefValuePublicKeys" + } ], + "description" : "Public keys", + "type" : "object" + }, + "IndyRevRegEntry_value" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyRevRegEntryValue" + } ], + "description" : "Revocation registry entry value", + "type" : "object" + }, + "InputDescriptors_schema" : { + "allOf" : [ { + "$ref" : "#/components/schemas/SchemasInputDescriptorFilter" + } ], + "description" : "Accepts a list of schema or a dict containing filters like oneof_filter.", + "example" : { + "oneof_filter" : [ [ { + "uri" : "https://www.w3.org/Test1#Test1" + }, { + "uri" : "https://www.w3.org/Test2#Test2" + } ], { + "oneof_filter" : [ [ { + "uri" : "https://www.w3.org/Test1#Test1" + } ], [ { + "uri" : "https://www.w3.org/Test2#Test2" + } ] ] + } ] + }, + "type" : "object" + }, + "InvitationRecord_invitation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/InvitationMessage" + } ], + "description" : "Out of band invitation message", + "type" : "object" + }, + "IssuerRevRegRecord_revoc_reg_def" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyRevRegDef" + } ], + "description" : "Revocation registry definition", + "type" : "object" + }, + "IssuerRevRegRecord_revoc_reg_entry" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyRevRegEntry" + } ], + "description" : "Revocation registry entry", + "type" : "object" + }, + "KeylistQuery_paginate" : { + "allOf" : [ { + "$ref" : "#/components/schemas/KeylistQueryPaginate" + } ], + "description" : "Pagination info", + "type" : "object" + }, + "LDProofVCDetail_credential" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Credential" + } ], + "description" : "Detail of the JSON-LD Credential to be issued", + "example" : { + "@context" : [ "https://www.w3.org/2018/credentials/v1", "https://w3id.org/citizenship/v1" ], + "credentialSubject" : { + "familyName" : "SMITH", + "gender" : "Male", + "givenName" : "JOHN", + "type" : [ "PermanentResident", "Person" ] + }, + "description" : "Government of Example Permanent Resident Card.", + "identifier" : "83627465", + "issuanceDate" : "2019-12-03T12:19:52Z", + "issuer" : "did:key:z6MkmjY8GnV5i9YTDtPETC2uUAW6ejw3nk5mXF5yci5ab7th", + "name" : "Permanent Resident Card", + "type" : [ "VerifiableCredential", "PermanentResidentCard" ] + }, + "type" : "object" + }, + "LDProofVCDetail_options" : { + "allOf" : [ { + "$ref" : "#/components/schemas/LDProofVCDetailOptions" + } ], + "description" : "Options for specifying how the linked data proof is created.", + "example" : { + "proofType" : "Ed25519Signature2018" + }, + "type" : "object" + }, + "LDProofVCDetailOptions_credentialStatus" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredentialStatusOptions" + } ], + "description" : "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status", + "type" : "object" + }, + "SchemaSendResult_schema" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Schema" + } ], + "description" : "Schema definition", + "type" : "object" + }, + "SendMenu_menu" : { + "allOf" : [ { + "$ref" : "#/components/schemas/MenuJson" + } ], + "description" : "Menu to send to connection", + "type" : "object" + }, + "SignedDoc_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/SignatureOptions" + } ], + "description" : "Linked data proof", + "type" : "object" + }, + "TxnOrCredentialDefinitionSendResult_txn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TransactionRecord" + } ], + "description" : "Credential definition transaction to endorse", + "type" : "object" + }, + "TxnOrPublishRevocationsResult_txn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TransactionRecord" + } ], + "description" : "Revocation registry revocations transaction to endorse", + "type" : "object" + }, + "TxnOrRegisterLedgerNymResponse_txn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TransactionRecord" + } ], + "description" : "DID transaction to endorse", + "type" : "object" + }, + "TxnOrRevRegResult_txn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TransactionRecord" + } ], + "description" : "Revocation registry definition transaction to endorse", + "type" : "object" + }, + "TxnOrSchemaSendResult_sent" : { + "allOf" : [ { + "$ref" : "#/components/schemas/SchemaSendResult" + } ], + "description" : "Content sent", + "type" : "object" + }, + "TxnOrSchemaSendResult_txn" : { + "allOf" : [ { + "$ref" : "#/components/schemas/TransactionRecord" + } ], + "description" : "Schema transaction to endorse", + "type" : "object" + }, + "V10CredentialBoundOfferRequest_counter_proposal" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredentialProposal" + } ], + "description" : "Optional counter-proposal", + "type" : "object" + }, + "V10CredentialExchange_credential" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyCredInfo" + } ], + "description" : "Credential as stored", + "type" : "object" + }, + "V10CredentialExchange_credential_offer" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyCredAbstract" + } ], + "description" : "(Indy) credential offer", + "type" : "object" + }, + "V10CredentialExchange_credential_offer_dict" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredentialOffer" + } ], + "description" : "Credential offer message", + "type" : "object" + }, + "V10CredentialExchange_credential_proposal_dict" : { + "allOf" : [ { + "$ref" : "#/components/schemas/CredentialProposal" + } ], + "description" : "Credential proposal message", + "type" : "object" + }, + "V10CredentialExchange_credential_request" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyCredRequest" + } ], + "description" : "(Indy) credential request", + "type" : "object" + }, + "V10CredentialExchange_raw_credential" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyCredential" + } ], + "description" : "Credential as received, prior to storage in holder wallet", + "type" : "object" + }, + "V10DiscoveryExchangeListResult_results_inner" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V10DiscoveryRecord" + } ], + "description" : "Discover Features v1.0 exchange record", + "type" : "object" + }, + "V10DiscoveryRecord_disclose" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Disclose" + } ], + "description" : "Disclose message", + "type" : "object" + }, + "V10DiscoveryRecord_query_msg" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Query" + } ], + "description" : "Query message", + "type" : "object" + }, + "V10PresentationExchange_presentation" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProof" + } ], + "description" : "(Indy) presentation (also known as proof)", + "type" : "object" + }, + "V10PresentationExchange_presentation_proposal_dict" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PresentationProposal" + } ], + "description" : "Presentation proposal message", + "type" : "object" + }, + "V10PresentationExchange_presentation_request" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofRequest" + } ], + "description" : "(Indy) presentation request (also known as proof request)", + "type" : "object" + }, + "V10PresentationExchange_presentation_request_dict" : { + "allOf" : [ { + "$ref" : "#/components/schemas/PresentationRequest" + } ], + "description" : "Presentation request message", + "type" : "object" + }, + "V20CredBoundOfferRequest_counter_preview" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredPreview" + } ], + "description" : "Optional content for counter-proposal", + "type" : "object" + }, + "V20CredBoundOfferRequest_filter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredFilter" + } ], + "description" : "Credential specification criteria by format", + "type" : "object" + }, + "V20CredExRecord_by_format" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredExRecordByFormat" + } ], + "description" : "Attachment content by format for proposal, offer, request, and issue", + "type" : "object" + }, + "V20CredExRecord_cred_issue" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredIssue" + } ], + "description" : "Serialized credential issue message", + "type" : "object" + }, + "V20CredExRecord_cred_offer" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredOffer" + } ], + "description" : "Credential offer message", + "type" : "object" + }, + "V20CredExRecord_cred_preview" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredPreview" + } ], + "description" : "Credential preview from credential proposal", + "type" : "object" + }, + "V20CredExRecord_cred_proposal" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredProposal" + } ], + "description" : "Credential proposal message", + "type" : "object" + }, + "V20CredExRecord_cred_request" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredRequest" + } ], + "description" : "Serialized credential request message", + "type" : "object" + }, + "V20CredExRecordDetail_cred_ex_record" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredExRecord" + } ], + "description" : "Credential exchange record", + "type" : "object" + }, + "V20CredFilter_indy" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredFilterIndy" + } ], + "description" : "Credential filter for indy", + "type" : "object" + }, + "V20CredFilter_ld_proof" : { + "allOf" : [ { + "$ref" : "#/components/schemas/LDProofVCDetail" + } ], + "description" : "Credential filter for linked data proof", + "type" : "object" + }, + "V20CredProposal_credential_preview" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredPreview" + } ], + "description" : "Credential preview", + "type" : "object" + }, + "V20CredRequestFree_filter" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20CredFilterLDProof" + } ], + "description" : "Credential specification criteria by format", + "type" : "object" + }, + "V20DiscoveryExchangeListResult_results_inner" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20DiscoveryRecord" + } ], + "description" : "Discover Features v2.0 exchange record", + "type" : "object" + }, + "V20DiscoveryRecord_disclosures" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Disclosures" + } ], + "description" : "Disclosures message", + "type" : "object" + }, + "V20DiscoveryRecord_queries_msg" : { + "allOf" : [ { + "$ref" : "#/components/schemas/Queries" + } ], + "description" : "Queries message", + "type" : "object" + }, + "V20PresExRecord_by_format" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20PresExRecordByFormat" + } ], + "description" : "Attachment content by format for proposal, request, and presentation", + "type" : "object" + }, + "V20PresExRecord_pres" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20Pres" + } ], + "description" : "Presentation message", + "type" : "object" + }, + "V20PresExRecord_pres_proposal" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20PresProposal" + } ], + "description" : "Presentation proposal message", + "type" : "object" + }, + "V20PresExRecord_pres_request" : { + "allOf" : [ { + "$ref" : "#/components/schemas/V20PresRequest" + } ], + "description" : "Presentation request message", + "type" : "object" + }, + "V20PresProposalByFormat_dif" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DIFProofProposal" + } ], + "description" : "Presentation proposal for DIF", + "type" : "object" + }, + "V20PresProposalByFormat_indy" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofRequest" + } ], + "description" : "Presentation proposal for indy", + "type" : "object" + }, + "V20PresRequestByFormat_dif" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DIFProofRequest" + } ], + "description" : "Presentation request for DIF", + "type" : "object" + }, + "V20PresRequestByFormat_indy" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyProofRequest" + } ], + "description" : "Presentation request for indy", + "type" : "object" + }, + "V20PresSpecByFormatRequest_dif" : { + "allOf" : [ { + "$ref" : "#/components/schemas/DIFPresSpec" + } ], + "description" : "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest", + "type" : "object" + }, + "V20PresSpecByFormatRequest_indy" : { + "allOf" : [ { + "$ref" : "#/components/schemas/IndyPresSpec" + } ], + "description" : "Presentation specification for indy", + "type" : "object" + }, + "VerifyRequest_doc" : { + "allOf" : [ { + "$ref" : "#/components/schemas/SignedDoc" + } ], + "description" : "Signed document", + "type" : "object" + } }, - "VerifyRequest_doc" : { - "type" : "object", - "description" : "Signed document" + "securitySchemes" : { + "AuthorizationHeader" : { + "description" : "Bearer token. Be sure to preprend token with 'Bearer '", + "in" : "header", + "name" : "Authorization", + "type" : "apiKey" + } } - } + }, + "x-original-swagger-version" : "2.0" } \ No newline at end of file