diff --git a/openapi/tenant-admin-openapi.json b/docs/openapi/tenant-admin-openapi.json similarity index 54% rename from openapi/tenant-admin-openapi.json rename to docs/openapi/tenant-admin-openapi.json index 6a533ddf66..dc152697ee 100644 --- a/openapi/tenant-admin-openapi.json +++ b/docs/openapi/tenant-admin-openapi.json @@ -1,54 +1,106 @@ { - "openapi": "3.1.0", "info": { "title": "CloudAPI Multitenant Admin", - "description": "\nWelcome to the Aries CloudAPI Python project!\n\nFor detailed guidance on using the API, please visit our official documentation:\nhttps://www.didx.co.za/ssi-dev-portal/docs/Welcome.\n", - "version": "1.0.0" + "description": "\nWelcome to CloudAPI Multitenant Admin!\n\nFor detailed guidance on using the API, please visit our official documentation:\nhttps://www.didx.co.za/acapy-cloud/index.html\n", + "version": "4.2.0" }, - "servers": [{ "url": "/tenant-admin" }], + "servers": [ + { + "url": "/tenant-admin" + } + ], "paths": { "/v1/tenants": { "post": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Create New Tenant", "description": "Create a New Tenant\n---\n\nUse this endpoint to create a new Tenant, which is the same as creating a new Wallet.\n\nThe `wallet_label` is a required field that allows you to assign an alias to the Tenant.\nThis label is used as the default alias in connections (i.e. the other party will see this name in their records).\n\nIf roles (issuer and/or verifier) are specified, the Tenant will be onboarded with these roles and added to the\ntrust registry. An issuer or a verifier is referred to as an 'actor' in the trust registry, and the `wallet_label`\nwill be used as the name for this actor.\n\nIf no roles are provided, then the created wallet represents a regular tenant\n(also referred to as a 'user', 'wallet', 'holder', or 'prover', depending on the context).\n\nThe `wallet_label` does not have to be unique for regular tenants, but it may not match the name of an existing\nactor in the trust registry, and will be blocked. Conversely, an issuer or verifier may not use a label that is\nalready in use by another tenant, and will also be blocked.\n\nThe `wallet_name` is an optional field that allows you to assign an additional identifier to the wallet, and is\nuseful with `get_tenants` to fetch Wallets by name. Wallet names must be unique.\n\nThe `image_url` is an optional field for assigning an image to the Wallet. For actors, this will also be added to\nthe trust registry.\n\n`extra_settings` is an optional field intended for advanced users, which allows configuring wallet behaviour.\n\nRequest body:\n---\n body: CreateTenantRequest\n wallet_label: str\n A required alias for the Tenant.\n wallet_name: Optional[str]\n An optional wallet name.\n roles: Optional[List[str]]\n A list of roles to assign to the Tenant.\n image_url: Optional[str]\n An optional image URL for the Tenant.\n extra_settings: Optional[dict]]\n Optional per-tenant settings to configure wallet behaviour for advanced users.\n\nResponse body:\n---\n CreateTenantResponse\n wallet_id: str\n wallet_label: str\n wallet_name: str\n created_at: str\n image_url: Optional[str]\n group_id: Optional[str]\n updated_at: str\n access_token: str", "operationId": "create_tenant_v1_tenants_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTenantRequest" + } + } + } }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateTenantResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "get": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Fetch Tenants", "description": "Fetch all Tenants (paginated), or Fetch by Wallet Name\n---\n\nUse this endpoint to fetch all tenants (using pagination), or filter by wallet name.\n\nThe default for `limit` is 1000, with a maximum of 10000.\n\nResults are ordered by creation time (newest first), and can be controlled to be in ascending order (oldest first).\n\nOptional Request Parameters:\n---\n wallet_name: str\n Filter by wallet name.\n limit: int\n Number of results to return.\n offset: int\n Number of results to skip.\n descending: bool\n Whether to return results in descending order or not. Defaults to true (newest first).\n\nResponse body:\n---\n List[Tenant]\n wallet_id: str\n wallet_label: str\n wallet_name: str\n created_at: str\n updated_at: Optional[str]\n image_url: Optional[str]\n group_id: Optional[str]", "operationId": "get_tenants_v1_tenants_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "wallet_name", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Wallet Name" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Wallet Name" + } }, { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -60,7 +112,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -87,7 +147,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/Tenant" }, + "items": { + "$ref": "#/components/schemas/Tenant" + }, "title": "Response Get Tenants V1 Tenants Get" } } @@ -95,141 +157,327 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/tenants/{wallet_id}": { "delete": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Delete a Tenant by Wallet ID", "description": "Delete Tenant by ID\n---\n\nUse this endpoint to delete a Tenant by its Wallet ID. This action will remove the Tenant's Wallet,\nalong with any associated credentials, connections, and other data. If the tenant is an issuer or verifier,\nthey will also be removed from the trust registry.\n\nRequest Parameters:\n---\n wallet_id: str\n The Wallet ID of the Tenant to delete.\n\nResponse body:\n---\n status_code: 204 No Content", "operationId": "delete_tenant_by_id_v1_tenants__wallet_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } } + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "put": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Update Tenant by Wallet ID", "description": "Update Tenant by Wallet ID\n---\n\nUpdate a Tenant's details based on their Wallet ID.\n\nIssuers or verifiers can be promoted to hold both roles, but this endpoint does not support revoking roles.\n\nHolders cannot have their roles updated. Attempting to assign issuer or verifier\nroles to a holder will result in a 409 conflict error.\n\nUpdates to `wallet_label` or `image_url` for issuers and verifiers will be reflected on the trust registry.\n\nRequest body:\n---\n body: UpdateTenantRequest\n wallet_label: Optional[str]\n An optional alias for the Tenant.\n roles: Optional[List[str]]\n A list of roles to assign to the Tenant.\n image_url: Optional[str]\n An optional image URL for the Tenant.\n extra_settings: Optional[Dict[str, Union[bool, str]]]\n Optional per-tenant settings to configure wallet behaviour for advanced users.\n\nResponse body:\n---\n Tenant\n wallet_id: str\n wallet_label: str\n wallet_name: str\n created_at: str\n updated_at: Optional[str]\n image_url: Optional[str]\n group_id: Optional[str]", "operationId": "update_tenant_v1_tenants__wallet_id__put", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } } + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + } ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateTenantRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/UpdateTenantRequest" + } + } + } }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tenant" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "get": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Get Tenant by Wallet ID", "description": "Fetch Tenant info by ID\n---\n\nUse this endpoint to fetch Tenant info by Wallet ID.\n\nRequest parameters:\n---\n wallet_id: str\n The Wallet ID of the Tenant to fetch.\n\nResponse body:\n---\n Tenant\n wallet_id: str\n wallet_label: str\n wallet_name: str\n created_at: str\n updated_at: Optional[str]\n image_url: Optional[str]\n group_id: Optional[str]", "operationId": "get_tenant_v1_tenants__wallet_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } } + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Tenant" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/tenants/{wallet_id}/access-token": { "get": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "(Deprecated) Rotate and Get New Access Token for Wallet", "description": "(Deprecated) Rotate and get access token for Wallet\n---\n\nCalling this endpoint will invalidate the previous access token for the Wallet, and return a new one.\n\nRequest Parameters:\n---\n wallet_id: str\n The Wallet ID of the tenant for which the access token will be rotated.\n\nResponse Body:\n---\n TenantAuth\n access_token: str\n The new access token for the Wallet.", "operationId": "get_wallet_auth_token_v1_tenants__wallet_id__access_token_get", "deprecated": true, - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } } + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantAuth" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantAuth" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "post": { - "tags": ["admin: tenants"], + "tags": [ + "admin: tenants" + ], "summary": "Rotate and Get New Access Token for Wallet", "description": "Rotate and get new access token for Wallet\n---\n\nCalling this endpoint will invalidate the previous access token for the Wallet, and return a new one.\n\nRequest Parameters:\n---\n wallet_id: str\n The Wallet ID of the tenant for which the access token will be rotated.\n\nResponse Body:\n---\n TenantAuth\n access_token: str\n The new access token for the Wallet.", "operationId": "post_wallet_auth_token_v1_tenants__wallet_id__access_token_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } } + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantAuth" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TenantAuth" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/sse/{wallet_id}/{topic}/{field}/{field_id}/{desired_state}": { "get": { - "tags": ["sse"], + "tags": [ + "sse" + ], "summary": "Subscribe To A Wallet Event By Topic, Field, And Desired State", "description": "Subscribe to SSE events wait for a desired state with a field filter.\n---\n***This endpoint can't be called on the swagger UI, as it requires a stream response.***\n\nWait for a desired state to be reached for some event for this wallet and topic,\nfiltering for payloads that contain `field:field_id`.\n\nexample: `/{wallet_id}/credentials/connection_id/some-uuid/done` will stream a credential exchange event on a\nspecific connection with state done.\nThe field and field ID pair must be present in the payload (other than state) for the event to be streamed.\nThe stream will be closed after the event is returned.\n\nParameters:\n-----------\n wallet_id:\n The ID of the wallet subscribing to the events.\n topic:\n The topic to which the wallet is subscribing.\n field:\n The field to which the wallet is subscribing.\n field_id:\n The ID of the field subscribing to the events.\n desired_state:\n The desired state to be reached.\n look_back:\n Number of seconds to look back for events before subscribing.", "operationId": "Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } }, - { "name": "topic", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic" } }, - { "name": "field", "in": "path", "required": true, "schema": { "type": "string", "title": "Field" } }, - { "name": "field_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Field Id" } }, + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + }, + { + "name": "topic", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Topic" + } + }, + { + "name": "field", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Field" + } + }, + { + "name": "field_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Field Id" + } + }, { "name": "desired_state", "in": "path", "required": true, - "schema": { "type": "string", "title": "Desired State" } + "schema": { + "type": "string", + "title": "Desired State" + } }, { "name": "look_back", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "description": "Number of seconds to look back for events", "default": 60, "title": "Look Back" @@ -238,10 +486,18 @@ } ], "responses": { - "200": { "description": "Successful Response" }, + "200": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } @@ -255,36 +511,78 @@ "type": "string", "title": "Wallet Label", "description": "A required alias for the tenant, publicized to other agents when forming a connection. If the tenant is an issuer or verifier, this label will be displayed on the trust registry and must be unique. Allowable special characters: .!@$*()~_-", - "examples": ["Tenant Label"] + "examples": [ + "Tenant Label" + ] }, "wallet_name": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Wallet Name", "description": "An optional wallet name. Useful with `get_tenants` to fetch wallets by wallet name. If selected, must be unique. Otherwise, randomly generated.", - "examples": ["Unique name"] + "examples": [ + "Unique name" + ] }, "roles": { "anyOf": [ - { "items": { "type": "string", "enum": ["issuer", "verifier"] }, "type": "array" }, - { "type": "null" } + { + "items": { + "type": "string", + "enum": [ + "issuer", + "verifier" + ] + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Roles" }, "group_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Group Id", "description": "An optional group identifier. Useful with `get_tenants` to fetch wallets by group id.", - "examples": ["Some Group Id"] + "examples": [ + "Some Group Id" + ] }, "image_url": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Image Url", - "examples": ["https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png"] + "examples": [ + "https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png" + ] }, "extra_settings": { "anyOf": [ { - "additionalProperties": { "type": "boolean" }, + "additionalProperties": { + "type": "boolean" + }, "propertyNames": { "enum": [ "ACAPY_INVITE_PUBLIC", @@ -300,101 +598,271 @@ }, "type": "object" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Extra Settings", "description": "Optional per-tenant settings to configure wallet behaviour for advanced users.", - "examples": [{ "ACAPY_AUTO_ACCEPT_INVITES": false }] + "examples": [ + { + "ACAPY_AUTO_ACCEPT_INVITES": false + } + ] } }, "type": "object", - "required": ["wallet_label"], + "required": [ + "wallet_label" + ], "title": "CreateTenantRequest" }, "CreateTenantResponse": { "properties": { - "access_token": { "type": "string", "title": "Access Token", "examples": ["ey..."] }, - "wallet_id": { "type": "string", "title": "Wallet Id", "examples": ["545135a4-ecbc-4400-8594-bdb74c51c88d"] }, - "wallet_label": { "type": "string", "title": "Wallet Label", "examples": ["Alice"] }, - "wallet_name": { "type": "string", "title": "Wallet Name", "examples": ["SomeWalletName"] }, - "created_at": { "type": "string", "title": "Created At" }, - "updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Updated At" }, + "access_token": { + "type": "string", + "title": "Access Token", + "examples": [ + "ey..." + ] + }, + "wallet_id": { + "type": "string", + "title": "Wallet Id", + "examples": [ + "545135a4-ecbc-4400-8594-bdb74c51c88d" + ] + }, + "wallet_label": { + "type": "string", + "title": "Wallet Label", + "examples": [ + "Alice" + ] + }, + "wallet_name": { + "type": "string", + "title": "Wallet Name", + "examples": [ + "SomeWalletName" + ] + }, + "created_at": { + "type": "string", + "title": "Created At" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Updated At" + }, "image_url": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Image Url", - "examples": ["https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png"] + "examples": [ + "https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png" + ] }, "group_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Group Id", "description": "An optional group identifier. Useful with `get_tenants` to fetch wallets by group id.", - "examples": ["Some Group Id"] + "examples": [ + "Some Group Id" + ] } }, "type": "object", - "required": ["access_token", "wallet_id", "wallet_label", "wallet_name", "created_at"], + "required": [ + "access_token", + "wallet_id", + "wallet_label", + "wallet_name", + "created_at" + ], "title": "CreateTenantResponse" }, "HTTPValidationError": { "properties": { - "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" + } }, "type": "object", "title": "HTTPValidationError" }, "Tenant": { "properties": { - "wallet_id": { "type": "string", "title": "Wallet Id", "examples": ["545135a4-ecbc-4400-8594-bdb74c51c88d"] }, - "wallet_label": { "type": "string", "title": "Wallet Label", "examples": ["Alice"] }, - "wallet_name": { "type": "string", "title": "Wallet Name", "examples": ["SomeWalletName"] }, - "created_at": { "type": "string", "title": "Created At" }, - "updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Updated At" }, + "wallet_id": { + "type": "string", + "title": "Wallet Id", + "examples": [ + "545135a4-ecbc-4400-8594-bdb74c51c88d" + ] + }, + "wallet_label": { + "type": "string", + "title": "Wallet Label", + "examples": [ + "Alice" + ] + }, + "wallet_name": { + "type": "string", + "title": "Wallet Name", + "examples": [ + "SomeWalletName" + ] + }, + "created_at": { + "type": "string", + "title": "Created At" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Updated At" + }, "image_url": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Image Url", - "examples": ["https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png"] + "examples": [ + "https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png" + ] }, "group_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Group Id", "description": "An optional group identifier. Useful with `get_tenants` to fetch wallets by group id.", - "examples": ["Some Group Id"] + "examples": [ + "Some Group Id" + ] } }, "type": "object", - "required": ["wallet_id", "wallet_label", "wallet_name", "created_at"], + "required": [ + "wallet_id", + "wallet_label", + "wallet_name", + "created_at" + ], "title": "Tenant" }, "TenantAuth": { - "properties": { "access_token": { "type": "string", "title": "Access Token", "examples": ["ey..."] } }, + "properties": { + "access_token": { + "type": "string", + "title": "Access Token", + "examples": [ + "ey..." + ] + } + }, "type": "object", - "required": ["access_token"], + "required": [ + "access_token" + ], "title": "TenantAuth" }, "UpdateTenantRequest": { "properties": { "wallet_label": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Wallet Label", "description": "A required alias for the tenant, publicized to other agents when forming a connection. If the tenant is an issuer or verifier, this label will be displayed on the trust registry and must be unique. Allowable special characters: .!@$*()~_-", - "examples": ["Tenant Label"] + "examples": [ + "Tenant Label" + ] }, "roles": { "anyOf": [ - { "items": { "type": "string", "enum": ["issuer", "verifier"] }, "type": "array" }, - { "type": "null" } + { + "items": { + "type": "string", + "enum": [ + "issuer", + "verifier" + ] + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Roles" }, "image_url": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Image Url", - "examples": ["https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png"] + "examples": [ + "https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png" + ] }, "extra_settings": { "anyOf": [ { - "additionalProperties": { "type": "boolean" }, + "additionalProperties": { + "type": "boolean" + }, "propertyNames": { "enum": [ "ACAPY_INVITE_PUBLIC", @@ -410,11 +878,17 @@ }, "type": "object" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Extra Settings", "description": "Optional per-tenant settings to configure wallet behaviour for advanced users.", - "examples": [{ "ACAPY_AUTO_ACCEPT_INVITES": false }] + "examples": [ + { + "ACAPY_AUTO_ACCEPT_INVITES": false + } + ] } }, "type": "object", @@ -423,18 +897,43 @@ "ValidationError": { "properties": { "loc": { - "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, "type": "array", "title": "Location" }, - "msg": { "type": "string", "title": "Message" }, - "type": { "type": "string", "title": "Error Type" } + "msg": { + "type": "string", + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + } }, "type": "object", - "required": ["loc", "msg", "type"], + "required": [ + "loc", + "msg", + "type" + ], "title": "ValidationError" } }, - "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "x-api-key" } } + "securitySchemes": { + "APIKeyHeader": { + "type": "apiKey", + "in": "header", + "name": "x-api-key" + } + } } } diff --git a/openapi/tenant-admin-openapi.yaml b/docs/openapi/tenant-admin-openapi.yaml similarity index 67% rename from openapi/tenant-admin-openapi.yaml rename to docs/openapi/tenant-admin-openapi.yaml index 1a1fdc3df1..298592a479 100644 --- a/openapi/tenant-admin-openapi.yaml +++ b/docs/openapi/tenant-admin-openapi.yaml @@ -1,24 +1,24 @@ openapi: 3.1.0 info: title: CloudAPI Multitenant Admin - description: " + description: ' - Welcome to the Aries CloudAPI Python project! + Welcome to CloudAPI Multitenant Admin! For detailed guidance on using the API, please visit our official documentation: - https://www.didx.co.za/ssi-dev-portal/docs/Welcome. + https://www.didx.co.za/acapy-cloud/index.html - " - version: 1.0.0 + ' + version: 4.2.0 servers: - - url: /tenant-admin +- url: /tenant-admin paths: /v1/tenants: post: tags: - - "admin: tenants" + - 'admin: tenants' summary: Create New Tenant description: "Create a New Tenant\n---\n\nUse this endpoint to create a new\ \ Tenant, which is the same as creating a new Wallet.\n\nThe `wallet_label`\ @@ -53,29 +53,29 @@ paths: \ updated_at: str\n access_token: str" operationId: create_tenant_v1_tenants_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/CreateTenantRequest" + $ref: '#/components/schemas/CreateTenantRequest' responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CreateTenantResponse" - "422": + $ref: '#/components/schemas/CreateTenantResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' get: tags: - - "admin: tenants" + - 'admin: tenants' summary: Fetch Tenants description: "Fetch all Tenants (paginated), or Fetch by Wallet Name\n---\n\n\ Use this endpoint to fetch all tenants (using pagination), or filter by wallet\ @@ -91,72 +91,72 @@ paths: \ image_url: Optional[str]\n group_id: Optional[str]" operationId: get_tenants_v1_tenants_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_name - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Wallet Name - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: wallet_name + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Wallet Name + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination - - name: descending - in: query - required: false - schema: - type: boolean - description: Whether to return results in descending order. Results are - ordered by record created time. - default: true - title: Descending - description: Whether to return results in descending order. Results are ordered - by record created time. + default: 0 + title: Offset + description: Offset for pagination + - name: descending + in: query + required: false + schema: + type: boolean + description: Whether to return results in descending order. Results are + ordered by record created time. + default: true + title: Descending + description: Whether to return results in descending order. Results are ordered + by record created time. responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/Tenant" + $ref: '#/components/schemas/Tenant' title: Response Get Tenants V1 Tenants Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/tenants/{wallet_id}: delete: tags: - - "admin: tenants" + - 'admin: tenants' summary: Delete a Tenant by Wallet ID description: "Delete Tenant by ID\n---\n\nUse this endpoint to delete a Tenant\ \ by its Wallet ID. This action will remove the Tenant's Wallet,\nalong with\ @@ -166,26 +166,26 @@ paths: \ Tenant to delete.\n\nResponse body:\n---\n status_code: 204 No Content" operationId: delete_tenant_by_id_v1_tenants__wallet_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' put: tags: - - "admin: tenants" + - 'admin: tenants' summary: Update Tenant by Wallet ID description: "Update Tenant by Wallet ID\n---\n\nUpdate a Tenant's details based\ \ on their Wallet ID.\n\nIssuers or verifiers can be promoted to hold both\ @@ -205,36 +205,36 @@ paths: \ group_id: Optional[str]" operationId: update_tenant_v1_tenants__wallet_id__put security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/UpdateTenantRequest" + $ref: '#/components/schemas/UpdateTenantRequest' responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Tenant" - "422": + $ref: '#/components/schemas/Tenant' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' get: tags: - - "admin: tenants" + - 'admin: tenants' summary: Get Tenant by Wallet ID description: "Fetch Tenant info by ID\n---\n\nUse this endpoint to fetch Tenant\ \ info by Wallet ID.\n\nRequest parameters:\n---\n wallet_id: str\n \ @@ -244,31 +244,31 @@ paths: \ Optional[str]\n group_id: Optional[str]" operationId: get_tenant_v1_tenants__wallet_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Tenant" - "422": + $ref: '#/components/schemas/Tenant' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/tenants/{wallet_id}/access-token: get: tags: - - "admin: tenants" + - 'admin: tenants' summary: (Deprecated) Rotate and Get New Access Token for Wallet description: "(Deprecated) Rotate and get access token for Wallet\n---\n\nCalling\ \ this endpoint will invalidate the previous access token for the Wallet,\ @@ -279,30 +279,30 @@ paths: operationId: get_wallet_auth_token_v1_tenants__wallet_id__access_token_get deprecated: true security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/TenantAuth" - "422": + $ref: '#/components/schemas/TenantAuth' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' post: tags: - - "admin: tenants" + - 'admin: tenants' summary: Rotate and Get New Access Token for Wallet description: "Rotate and get new access token for Wallet\n---\n\nCalling this\ \ endpoint will invalidate the previous access token for the Wallet, and return\ @@ -312,31 +312,31 @@ paths: \ The new access token for the Wallet." operationId: post_wallet_auth_token_v1_tenants__wallet_id__access_token_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/TenantAuth" - "422": + $ref: '#/components/schemas/TenantAuth' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/sse/{wallet_id}/{topic}/{field}/{field_id}/{desired_state}: get: tags: - - sse + - sse summary: Subscribe To A Wallet Event By Topic, Field, And Desired State description: "Subscribe to SSE events wait for a desired state with a field\ \ filter.\n---\n***This endpoint can't be called on the swagger UI, as it\ @@ -355,58 +355,58 @@ paths: \ to look back for events before subscribing." operationId: Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id - - name: topic - in: path - required: true - schema: - type: string - title: Topic - - name: field - in: path - required: true - schema: - type: string - title: Field - - name: field_id - in: path - required: true - schema: - type: string - title: Field Id - - name: desired_state - in: path - required: true - schema: - type: string - title: Desired State - - name: look_back - in: query - required: false - schema: - anyOf: - - type: integer - - type: "null" - description: Number of seconds to look back for events - default: 60 - title: Look Back + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id + - name: topic + in: path + required: true + schema: + type: string + title: Topic + - name: field + in: path + required: true + schema: + type: string + title: Field + - name: field_id + in: path + required: true + schema: + type: string + title: Field Id + - name: desired_state + in: path + required: true + schema: + type: string + title: Desired State + - name: look_back + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' description: Number of seconds to look back for events + default: 60 + title: Look Back + description: Number of seconds to look back for events responses: - "200": + '200': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' components: schemas: CreateTenantRequest: @@ -414,73 +414,73 @@ components: wallet_label: type: string title: Wallet Label - description: "A required alias for the tenant, publicized to other agents + description: 'A required alias for the tenant, publicized to other agents when forming a connection. If the tenant is an issuer or verifier, this label will be displayed on the trust registry and must be unique. Allowable - special characters: .!@$*()~_-" + special characters: .!@$*()~_-' examples: - - Tenant Label + - Tenant Label wallet_name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Wallet Name description: An optional wallet name. Useful with `get_tenants` to fetch wallets by wallet name. If selected, must be unique. Otherwise, randomly generated. examples: - - Unique name + - Unique name roles: anyOf: - - items: - type: string - enum: - - issuer - - verifier - type: array - - type: "null" + - items: + type: string + enum: + - issuer + - verifier + type: array + - type: 'null' title: Roles group_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Group Id description: An optional group identifier. Useful with `get_tenants` to fetch wallets by group id. examples: - - Some Group Id + - Some Group Id image_url: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Image Url examples: - - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png + - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png extra_settings: anyOf: - - additionalProperties: - type: boolean - propertyNames: - enum: - - ACAPY_INVITE_PUBLIC - - ACAPY_PUBLIC_INVITES - - ACAPY_AUTO_ACCEPT_INVITES - - ACAPY_AUTO_ACCEPT_REQUESTS - - ACAPY_AUTO_PING_CONNECTION - - ACAPY_AUTO_RESPOND_MESSAGES - - ACAPY_AUTO_RESPOND_CREDENTIAL_OFFER - - ACAPY_AUTO_RESPOND_CREDENTIAL_REQUEST - - ACAPY_AUTO_VERIFY_PRESENTATION - type: object - - type: "null" + - additionalProperties: + type: boolean + propertyNames: + enum: + - ACAPY_INVITE_PUBLIC + - ACAPY_PUBLIC_INVITES + - ACAPY_AUTO_ACCEPT_INVITES + - ACAPY_AUTO_ACCEPT_REQUESTS + - ACAPY_AUTO_PING_CONNECTION + - ACAPY_AUTO_RESPOND_MESSAGES + - ACAPY_AUTO_RESPOND_CREDENTIAL_OFFER + - ACAPY_AUTO_RESPOND_CREDENTIAL_REQUEST + - ACAPY_AUTO_VERIFY_PRESENTATION + type: object + - type: 'null' title: Extra Settings description: Optional per-tenant settings to configure wallet behaviour for advanced users. examples: - - ACAPY_AUTO_ACCEPT_INVITES: false + - ACAPY_AUTO_ACCEPT_INVITES: false type: object required: - - wallet_label + - wallet_label title: CreateTenantRequest CreateTenantResponse: properties: @@ -488,59 +488,59 @@ components: type: string title: Access Token examples: - - ey... + - ey... wallet_id: type: string title: Wallet Id examples: - - 545135a4-ecbc-4400-8594-bdb74c51c88d + - 545135a4-ecbc-4400-8594-bdb74c51c88d wallet_label: type: string title: Wallet Label examples: - - Alice + - Alice wallet_name: type: string title: Wallet Name examples: - - SomeWalletName + - SomeWalletName created_at: type: string title: Created At updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At image_url: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Image Url examples: - - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png + - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png group_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Group Id description: An optional group identifier. Useful with `get_tenants` to fetch wallets by group id. examples: - - Some Group Id + - Some Group Id type: object required: - - access_token - - wallet_id - - wallet_label - - wallet_name - - created_at + - access_token + - wallet_id + - wallet_label + - wallet_name + - created_at title: CreateTenantResponse HTTPValidationError: properties: detail: items: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object @@ -551,47 +551,47 @@ components: type: string title: Wallet Id examples: - - 545135a4-ecbc-4400-8594-bdb74c51c88d + - 545135a4-ecbc-4400-8594-bdb74c51c88d wallet_label: type: string title: Wallet Label examples: - - Alice + - Alice wallet_name: type: string title: Wallet Name examples: - - SomeWalletName + - SomeWalletName created_at: type: string title: Created At updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At image_url: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Image Url examples: - - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png + - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png group_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Group Id description: An optional group identifier. Useful with `get_tenants` to fetch wallets by group id. examples: - - Some Group Id + - Some Group Id type: object required: - - wallet_id - - wallet_label - - wallet_name - - created_at + - wallet_id + - wallet_label + - wallet_name + - created_at title: Tenant TenantAuth: properties: @@ -599,63 +599,63 @@ components: type: string title: Access Token examples: - - ey... + - ey... type: object required: - - access_token + - access_token title: TenantAuth UpdateTenantRequest: properties: wallet_label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Wallet Label - description: "A required alias for the tenant, publicized to other agents + description: 'A required alias for the tenant, publicized to other agents when forming a connection. If the tenant is an issuer or verifier, this label will be displayed on the trust registry and must be unique. Allowable - special characters: .!@$*()~_-" + special characters: .!@$*()~_-' examples: - - Tenant Label + - Tenant Label roles: anyOf: - - items: - type: string - enum: - - issuer - - verifier - type: array - - type: "null" + - items: + type: string + enum: + - issuer + - verifier + type: array + - type: 'null' title: Roles image_url: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Image Url examples: - - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png + - https://upload.wikimedia.org/wikipedia/commons/7/70/Example.png extra_settings: anyOf: - - additionalProperties: - type: boolean - propertyNames: - enum: - - ACAPY_INVITE_PUBLIC - - ACAPY_PUBLIC_INVITES - - ACAPY_AUTO_ACCEPT_INVITES - - ACAPY_AUTO_ACCEPT_REQUESTS - - ACAPY_AUTO_PING_CONNECTION - - ACAPY_AUTO_RESPOND_MESSAGES - - ACAPY_AUTO_RESPOND_CREDENTIAL_OFFER - - ACAPY_AUTO_RESPOND_CREDENTIAL_REQUEST - - ACAPY_AUTO_VERIFY_PRESENTATION - type: object - - type: "null" + - additionalProperties: + type: boolean + propertyNames: + enum: + - ACAPY_INVITE_PUBLIC + - ACAPY_PUBLIC_INVITES + - ACAPY_AUTO_ACCEPT_INVITES + - ACAPY_AUTO_ACCEPT_REQUESTS + - ACAPY_AUTO_PING_CONNECTION + - ACAPY_AUTO_RESPOND_MESSAGES + - ACAPY_AUTO_RESPOND_CREDENTIAL_OFFER + - ACAPY_AUTO_RESPOND_CREDENTIAL_REQUEST + - ACAPY_AUTO_VERIFY_PRESENTATION + type: object + - type: 'null' title: Extra Settings description: Optional per-tenant settings to configure wallet behaviour for advanced users. examples: - - ACAPY_AUTO_ACCEPT_INVITES: false + - ACAPY_AUTO_ACCEPT_INVITES: false type: object title: UpdateTenantRequest ValidationError: @@ -663,8 +663,8 @@ components: loc: items: anyOf: - - type: string - - type: integer + - type: string + - type: integer type: array title: Location msg: @@ -675,9 +675,9 @@ components: title: Error Type type: object required: - - loc - - msg - - type + - loc + - msg + - type title: ValidationError securitySchemes: APIKeyHeader: diff --git a/openapi/tenant-openapi.json b/docs/openapi/tenant-openapi.json similarity index 51% rename from openapi/tenant-openapi.json rename to docs/openapi/tenant-openapi.json index bb9006a9e9..6084253703 100644 --- a/openapi/tenant-openapi.json +++ b/docs/openapi/tenant-openapi.json @@ -2,14 +2,20 @@ "openapi": "3.1.0", "info": { "title": "CloudAPI Tenant", - "description": "\nWelcome to the Aries CloudAPI Python project!\n\nFor detailed guidance on using the API, please visit our official documentation:\nhttps://www.didx.co.za/ssi-dev-portal/docs/Welcome.\n", - "version": "1.0.0" + "description": "\nWelcome to CloudAPI Tenant!\n\nFor detailed guidance on using the API, please visit our official documentation:\nhttps://www.didx.co.za/acapy-cloud/index.html\n", + "version": "4.2.0" }, - "servers": [{ "url": "/tenant" }], + "servers": [ + { + "url": "/tenant" + } + ], "paths": { "/v1/connections/create-invitation": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Create a Connection Invitation", "description": "Create connection invitation\n---\nThis endpoint creates an invitation object for establishing a connection with another tenant.\n\nFor every invitation that is created, there will be a corresponding connection record with a state\n`invitation-sent`. Once this invitation is accepted, the connection record will transition to a state `completed`.\n\nIf `multi_use` is set to true, the invitation can be re-used and accepted by multiple tenants.\n\nCreating a multi-use invitation will create a connection record with `invitation_mode: \"multi\"`\n(instead of `\"once\"`), and this connection record will remain in a state `invitation-sent`, until it is deleted.\nEvery time a multi-use invitation is accepted, a new connection record will be created with state `completed`.\n\nThe `use_public_did` parameter determines whether to create an invitation using your public DID.\nThis of course requires that you have a public DID in your wallet, which by default is only true for issuers.\nIf `use_public_did` is set to False (default behaviour), then a random DID will be generated for this invite.\n\nRequest Body:\n---\n body: CreateInvitation\n alias: str (Optional)\n An alias for the connection invitation, which will appear as the alias in the connection record.\n multi_use: bool (default: False)\n Whether the invitation can be used multiple times.\n use_public_did: bool (default: False)\n Whether to use a public did for the invitation.\n\nReturns:\n---\n InvitationResult\n Contains an invitation object, an invitation url, and a connection id for this invite.", "operationId": "create_invitation_v1_connections_create_invitation_post", @@ -17,7 +23,14 @@ "content": { "application/json": { "schema": { - "anyOf": [{ "$ref": "#/components/schemas/CreateInvitation" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/CreateInvitation" + }, + { + "type": "null" + } + ], "title": "Body" } } @@ -26,55 +39,110 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationResult" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationResult" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, "deprecated": true, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/connections/accept-invitation": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Accept a Connection Invitation", "description": "Accept connection invitation\n---\nTenants can use this endpoint to accept a connection invitation.\n\nThe invitation object is obtained from an InvitationResult (the response from creating a connection invitation).\n\nThe `invitation_url` in the InvitationResult can also be used to obtain an invitation; there is a base64 encoded\nstring after the \"?oob=\" parameter in the url, and this can be decoded to obtain the invitation object.\n\nA webhook event will be emitted for the other party, on topic `connections`.\nTheir record for the connection will now be in state `completed`.\n\nRequest Body:\n---\n body: AcceptInvitation\n alias: str (Optional)\n Alias for the connection invitation.\n invitation: ConnectionInvitation\n The invitation object obtained from an InvitationResult, or decoded from an invitation_url.\n\nReturns:\n---\n Connection\n The record of your new connection", "operationId": "accept_invitation_v1_connections_accept_invitation_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptInvitation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AcceptInvitation" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, "deprecated": true, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/connections": { "get": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Fetch Connection Records", "description": "Fetch a list of connection records\n---\nThe records contain information about connections with other tenants, such as the state of the connection,\nthe alias of the connection, the label and the did of the other party, and other metadata.\n\nThe following query parameters can be used to filter the connection records to fetch.\n\nParameters (Optional):\n---\n limit: int - The maximum number of records to retrieve\n offset: int - The offset to start retrieving records from\n descending: bool - Whether to return results in descending order. Results are ordered by record created time.\n alias: str\n connection_protocol: Protocol: \"connections/1.0\", \"didexchange/1.0\"\n invitation_key: str\n invitation_msg_id: str\n my_did: str\n state: State: \"active\", \"response\", \"request\", \"start\", \"completed\", \"init\", \"error\", \"invitation\", \"abandoned\"\n their_did: str\n their_public_did: str\n their_role: Role: \"invitee\", \"requester\", \"inviter\", \"responder\"\n\nReturns:\n---\n List[Connection]\n A list of connection records", "operationId": "get_connections_v1_connections_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -86,7 +154,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -109,14 +185,35 @@ "name": "alias", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + } }, { "name": "connection_protocol", "in": "query", "required": false, "schema": { - "anyOf": [{ "enum": ["connections/1.0", "didexchange/1.0"], "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "enum": [ + "connections/1.0", + "didexchange/1.0" + ], + "type": "string" + }, + { + "type": "null" + } + ], "title": "Connection Protocol" } }, @@ -124,19 +221,49 @@ "name": "invitation_key", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Invitation Key" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Invitation Key" + } }, { "name": "invitation_msg_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Invitation Msg Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Invitation Msg Id" + } }, { "name": "my_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "My Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "My Did" + } }, { "name": "state", @@ -158,7 +285,9 @@ ], "type": "string" }, - { "type": "null" } + { + "type": "null" + } ], "title": "State" } @@ -167,13 +296,33 @@ "name": "their_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Their Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Their Did" + } }, { "name": "their_public_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Their Public Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Their Public Did" + } }, { "name": "their_role", @@ -181,8 +330,18 @@ "required": false, "schema": { "anyOf": [ - { "enum": ["invitee", "requester", "inviter", "responder"], "type": "string" }, - { "type": "null" } + { + "enum": [ + "invitee", + "requester", + "inviter", + "responder" + ], + "type": "string" + }, + { + "type": "null" + } ], "title": "Their Role" } @@ -195,7 +354,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/Connection" }, + "items": { + "$ref": "#/components/schemas/Connection" + }, "title": "Response Get Connections V1 Connections Get" } } @@ -203,176 +364,342 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/{connection_id}": { "get": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Fetch a Connection Record", "description": "Fetch a connection record by id\n---\nA connection record contains information about a connection with other tenants, such as the state of the connection,\nthe alias of the connection, the label and the did of the other party, and other metadata.\n\nParameters:\n---\n connection_id: str\n The identifier of the connection record that you want to fetch\n\nReturns:\n---\n Connection\n The connection record", "operationId": "get_connection_by_id_v1_connections__connection_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "delete": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Delete a Connection Record", "description": "Delete connection record by id\n---\nThis endpoint deletes a connection record by id.\n\nIf the connection uses the didexchange protocol, then we hangup the connection, such that the other party also has\ntheir record deleted.\n\nIf the connection uses the deprecated connections protocol, then we just delete the record. The other party will\nstill have their record of the connection, but it will become unusable.\n\nParameters:\n---\n connection_id: str\n The identifier of the connection record that you want to delete\n\nReturns:\n---\n status_code: 204", "operationId": "delete_connection_by_id_v1_connections__connection_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/did-exchange/create-request": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Create a DID Exchange Request", "description": "Create a DID Exchange request\n---\nThis endpoint allows you to initiate a DID Exchange request with another party using their public DID.\n\nThe goal and goal_code parameters provide additional context for the request.\n\nOnly one of `use_did`, `use_did_method` or `use_public_did` should be specified. If none of these are specified,\na new local DID will be created for this connection.\n\nParameters:\n---\n their_public_did: str\n The DID of the party you want to connect to.\n alias: str, optional\n An alias for the connection. Defaults to None.\n goal: str, optional\n Optional self-attested string for sharing the intent of the connection.\n goal_code: str, optional\n Optional self-attested code for sharing the intent of the connection.\n my_label: str, optional\n Your label for the request.\n use_did: str, optional\n Your local DID to use for the connection.\n use_did_method: str, optional\n The method to use for the connection: \"did:peer:2\" or \"did:peer:4\".\n use_public_did: bool\n Use your public DID for this connection. Defaults to False.\n\nReturns:\n---\n Connection\n The connection record created by the DID exchange request.", "operationId": "create_did_exchange_request_v1_connections_did_exchange_create_request_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "their_public_did", "in": "query", "required": true, - "schema": { "type": "string", "title": "Their Public Did" } + "schema": { + "type": "string", + "title": "Their Public Did" + } }, { "name": "alias", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + } }, { "name": "goal", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Goal" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Goal" + } }, { "name": "goal_code", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Goal Code" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Goal Code" + } }, { "name": "my_label", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "My Label" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "My Label" + } }, { "name": "use_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Use Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Use Did" + } }, { "name": "use_did_method", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Use Did Method" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Use Did Method" + } }, { "name": "use_public_did", "in": "query", "required": false, - "schema": { "type": "boolean", "default": false, "title": "Use Public Did" } + "schema": { + "type": "boolean", + "default": false, + "title": "Use Public Did" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/did-exchange/accept-request": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Accept a DID Exchange Request", "description": "Accept a stored DID Exchange request\n---\nThis endpoint allows you to accept a request by providing the connection ID.\n\nParameters:\n---\n connection_id: str\n The ID of the connection request you want to accept.\n\nReturns:\n---\n Connection\n The connection record created by accepting the DID exchange request.", "operationId": "accept_did_exchange_request_v1_connections_did_exchange_accept_request_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "query", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/did-exchange/reject": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Reject or Abandon a DID Exchange", "description": "Reject or abandon a DID Exchange\n---\nThis endpoint allows you to reject or abandon a DID Exchange request. You can optionally provide a reason\nfor the rejection.\n\nReturns:\n---\n Connection\n The connection record after rejecting the DID exchange request.", "operationId": "reject_did_exchange_v1_connections_did_exchange_reject_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "query", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "anyOf": [{ "$ref": "#/components/schemas/DIDXRejectRequest" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/DIDXRejectRequest" + }, + { + "type": "null" + } + ], "title": "Body" } } @@ -381,122 +708,254 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/did-rotate": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Begin DID Rotation", "description": "Begin the rotation of a DID as a rotator.\n---\nThis endpoint allows you to begin the DID rotation for an existing connection. The `to_did` parameter specifies\nthe new DID that the rotating party is rotating to.\n\nParameters:\n---\n connection_id: str\n The ID of the connection for which the DID is to be rotated.\n to_did: str\n The new DID that the rotating party is rotating to.\n\nReturns:\n---\n Rotate\n The record after the DID rotation is initiated.", "operationId": "rotate_did_v1_connections_did_rotate_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "query", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } }, - { "name": "to_did", "in": "query", "required": true, "schema": { "type": "string", "title": "To Did" } } + { + "name": "to_did", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "To Did" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rotate" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Rotate" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/connections/did-rotate/hangup": { "post": { - "tags": ["connections"], + "tags": [ + "connections" + ], "summary": "Hangup DID Rotation", "description": "Send a hangup for a DID rotation as the rotator.\n---\nThis endpoint allows you to hangup a DID rotation process for an existing connection.\n\nParameters:\n---\n connection_id: str\n The ID of the connection for which the DID rotation is being hung up.\n\nReturns:\n---\n Hangup\n The record after the DID rotation is hung up.", "operationId": "hangup_did_rotation_v1_connections_did_rotate_hangup_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "connection_id", "in": "query", "required": true, - "schema": { "type": "string", "title": "Connection Id" } + "schema": { + "type": "string", + "title": "Connection Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hangup" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Hangup" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/definitions/schemas": { "post": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Create a new Schema", "description": "Create and publish a new schema to the ledger\n---\n**NB**: Only governance can create schemas.\n\nA schema is used to create credential definitions, which is used for issuing credentials.\nThe schema defines the attributes that can exist in that credential.\n\nWhen a schema is created, it is published to the ledger and written to our public trust registry,\nso that everyone in the ecosystem can view schemas that are valid and available.\n\nRequest Body:\n---\n body: CreateSchema\n name: str\n The name of the schema.\n version: str\n The version of the schema.\n attribute_names: List[str]\n The attribute names of the schema.\n\nReturns:\n---\n CredentialSchema\n The created schema object", "operationId": "create_schema_v1_definitions_schemas_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSchema" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateSchema" + } + } + } }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSchema" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialSchema" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "get": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Get Created Schemas", "description": "Get created schemas\n---\nAll tenants can call this endpoint to view available schemas.\n\nIf governance calls this endpoint, it will return all the schemas created by governance\n(whether the schemas are on the trust registry or not).\n\nIf tenants call this endpoint, it will return all schemas on the trust registry.\nThe difference between this endpoint and the public trust registry endpoint, is that this response includes\nthe attribute information of the schemas.\n\nResults can be filtered by the parameters listed below.\n\nParameters (Optional):\n---\n schema_id: str\n schema_issuer_did: str\n schema_name: str\n schema_version: str\n\nReturns:\n---\n List[CredentialSchema]\n A list of created schemas", "operationId": "get_schemas_v1_definitions_schemas_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "schema_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Id" + } }, { "name": "schema_issuer_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Issuer Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Issuer Did" + } }, { "name": "schema_name", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Name" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Name" + } }, { "name": "schema_version", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Version" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Version" + } } ], "responses": { @@ -506,7 +965,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/CredentialSchema" }, + "items": { + "$ref": "#/components/schemas/CredentialSchema" + }, "title": "Response Get Schemas V1 Definitions Schemas Get" } } @@ -514,97 +975,219 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/definitions/schemas/{schema_id}": { "get": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Get a Schema", "description": "Retrieve schema by id\n---\nThis endpoint fetches a schema from the ledger, using the schema_id.\n\nAny tenant can call this endpoint to retrieve a schema.\nThis endpoint will list all the attributes of the schema.\n\nParameters:\n---\n schema_id: str\n schema id\n\nReturns:\n---\n CredentialSchema\n The schema object", "operationId": "get_schema_v1_definitions_schemas__schema_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "schema_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Schema Id" } } + { + "name": "schema_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Schema Id" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialSchema" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialSchema" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/definitions/credentials": { "post": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Create a new Credential Definition", "description": "Create a credential definition\n---\nOnly issuers can create credential definitions.\n\nA credential definition essentially builds off a schema, which defines the attributes that can belong to a\ncredential, and it specifies whether credentials using this definition are revocable or not.\n\n**NB**: If revocation is requested (`\"support_revocation\": true`), then revocation registries will be created.\nThe creation of these revocation registries can take up to one minute.\n\nRequest Body:\n---\n body: CreateCredentialDefinition\n schema_id: str\n The id of the schema to use for this credential definition.\n tag: str\n The label to use for the credential definition.\n support_revocation: bool\n Whether you want credentials using this definition to be revocable or not\n\nReturns:\n---\n CredentialDefinition\n The created credential definition", "operationId": "create_credential_definition_v1_definitions_credentials_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCredentialDefinition" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateCredentialDefinition" + } + } + } }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialDefinition" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinition" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "get": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Get Created Credential Definitions", "description": "Get credential definitions created by the tenant\n---\nThis endpoint returns all credential definitions created by the tenant. Only issuers can create\ncredential definitions, and so only issuers will get results from this endpoint.\n\nThe results can be filtered by the parameters listed below.\n\nParameters (Optional):\n---\n issuer_did: str\n credential_definition_id: str\n schema_id: str\n schema_issuer_id: str\n schema_version: str\n\nReturns:\n---\n List[CredentialDefinition]\n A list of created credential definitions", "operationId": "get_credential_definitions_v1_definitions_credentials_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "issuer_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Issuer Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Issuer Did" + } }, { "name": "credential_definition_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Credential Definition Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Credential Definition Id" + } }, { "name": "schema_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Id" + } }, { "name": "schema_issuer_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Issuer Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Issuer Did" + } }, { "name": "schema_name", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Name" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Name" + } }, { "name": "schema_version", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Version" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Version" + } } ], "responses": { @@ -614,7 +1197,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/CredentialDefinition" }, + "items": { + "$ref": "#/components/schemas/CredentialDefinition" + }, "title": "Response Get Credential Definitions V1 Definitions Credentials Get" } } @@ -622,73 +1207,139 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/definitions/credentials/{credential_definition_id}": { "get": { - "tags": ["definitions"], + "tags": [ + "definitions" + ], "summary": "Get a Credential Definition", "description": "Get credential definition by id\n---\nThis endpoint returns information for a credential definition.\n\nAnyone can call this, whether they created the requested credential definition or not.\nPractically it will just reveal the schema that was used for the credential definition.\n\nParameters:\n---\n credential_definition_id: str\n credential definition id\n\nReturns:\n---\n CredentialDefinition\n The credential definition", "operationId": "get_credential_definition_by_id_v1_definitions_credentials__credential_definition_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_definition_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Definition Id" } + "schema": { + "type": "string", + "title": "Credential Definition Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialDefinition" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialDefinition" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials": { "post": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Send Holder a Credential", "description": "Create and send a credential, automating the issuer-side flow\n---\nNB: Only a tenant with the issuer role can send credentials.\n\nWhen creating a credential, the credential type must be one of `indy` or `ld_proof`.\n```json\n{\n \"type\": \"indy\" or \"ld_proof\",\n \"indy_credential_detail\": {...}, <-- Required if type is indy\n \"ld_credential_detail\": {...}, <-- Required if type is ld_proof\n \"save_exchange_record\": true, <-- Whether the credential exchange record should be saved on completion.\n \"connection_id\": \"string\", <-- The issuer's reference to the connection they want to submit the credential to.\n}\n```\nSetting the `save_exchange_record` field to True will save the exchange record after the credential is accepted.\nThe default behaviour is to only save exchange records while they are in pending state.\n\nFor a detailed technical specification of the credential issuing process, refer to the [Aries Issue Credential v2\nRFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0453-issue-credential-v2/README.md).\n\nRequest Body:\n---\n credential: SendCredential\n The payload for sending a credential\n\nReturns:\n---\n CredentialExchange\n A record of this credential exchange", "operationId": "send_credential_v1_issuer_credentials_post", - "security": [{ "APIKeyHeader": [] }], - "requestBody": { + "security": [ + { + "APIKeyHeader": [] + } + ], + "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendCredential" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendCredential" + } + } + } }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "get": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Fetch Credential Exchange Records", "description": "Get a list of credential exchange records\n---\nBoth holders and issuers can call this endpoint, because they each have their own records of a credential exchange.\n\nThese records contain information about the credentials issued to a holder, such as the current state of the\nexchange, and other metadata such as the `connection_id` that a credential was submit to (if an issuer) or received\nfrom (if a holder). Each record in the list is related to a single credential exchange flow.\n\nNB: An issuer and a holder will have distinct credential exchange ids, despite referring to the same exchange.\nThe `thread_id` is the only record attribute that will be the same for the holder and the issuer.\n\nAn exchange record will automatically be deleted after a flow completes (i.e. when state is 'done'),\nunless the `save_exchange_record` was set to true.\n\nThe following parameters can be set to filter the fetched exchange records: connection_id, role, state, thread_id.\n\nParameters (Optional):\n---\n limit: int - The maximum number of records to retrieve\n offset: int - The offset to start retrieving records from\n descending: bool - Whether to return results in descending order. Results are ordered by record created time.\n connection_id: str\n role: Role: \"issuer\", \"holder\"\n state: State: \"proposal-sent\", \"proposal-received\", \"offer-sent\", \"offer-received\",\n \"request-sent\", \"request-received\", \"credential-issued\", \"credential-received\",\n \"credential-revoked\", \"abandoned\", \"done\"\n thread_id: UUID\n\nReturns:\n---\n List[CredentialExchange]\n A list of credential exchange records", "operationId": "get_credentials_v1_issuer_credentials_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -700,7 +1351,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -723,14 +1382,35 @@ "name": "connection_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Connection Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Connection Id" + } }, { "name": "role", "in": "query", "required": false, "schema": { - "anyOf": [{ "enum": ["issuer", "holder"], "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "enum": [ + "issuer", + "holder" + ], + "type": "string" + }, + { + "type": "null" + } + ], "title": "Role" } }, @@ -757,7 +1437,9 @@ ], "type": "string" }, - { "type": "null" } + { + "type": "null" + } ], "title": "State" } @@ -766,7 +1448,18 @@ "name": "thread_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string", "format": "uuid" }, { "type": "null" }], "title": "Thread Id" } + "schema": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Thread Id" + } } ], "responses": { @@ -776,7 +1469,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/CredentialExchange" }, + "items": { + "$ref": "#/components/schemas/CredentialExchange" + }, "title": "Response Get Credentials V1 Issuer Credentials Get" } } @@ -784,54 +1479,100 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/create-offer": { "post": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Create a Credential Offer (not bound to a connection)", "description": "Create a credential offer, not bound to any connection\n---\nNB: Only a tenant with the issuer role can create credential offers.\n\nThis endpoint takes the same body as the send credential endpoint, but without a connection id. This\nmeans the credential will not be sent, but it will do the initial step of creating a credential exchange record,\nwhich the issuer can then use in the out of band (OOB) protocol.\n\nThe OOB protocol allows credentials to be sent over alternative channels, such as email or QR code, where a\nconnection does not yet exist between holder and issuer.\n\nThe credential type must be one of indy or ld_proof.\n```json\n{\n \"type\": \"indy\" or \"ld_proof\",\n \"indy_credential_detail\": {...}, <-- Required if type is indy\n \"ld_credential_detail\": {...}, <-- Required if type is ld_proof\n \"save_exchange_record\": true, <-- Whether the credential exchange record should be saved on completion.\n}\n```\nFor a detailed technical specification of the credential issuing process, refer to the [Aries Issue Credential v2\nRFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0453-issue-credential-v2/README.md).\n\nRequest Body:\n---\n credential: CreateOffer\n The payload for creating a credential offer\n\nReturns:\n---\n CredentialExchange\n A record of this credential exchange", "operationId": "create_offer_v1_issuer_credentials_create_offer_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOffer" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateOffer" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/issuer/credentials/{credential_exchange_id}/request": { "post": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Accept a Credential Offer", "description": "Sends a request to accept a credential offer\n---\nThe holder uses this endpoint to accept an offer from an issuer.\n\nIn technical terms, when a holder has a credential exchange record with a state 'offer-received', then they can use\nthis endpoint to accept that credential offer, and store the credential in their wallet.\n\nParameters:\n---\n credential_exchange_id: str\n The holder's reference to the credential exchange that they want to accept\n save_exchange_record: Optional[bool]\n Whether to override environment setting for saving credential exchange records. Default is None (use\n environment setting). True means save record, False means delete record.\n\nReturns:\n---\n CredentialExchange\n An updated record of this credential exchange", "operationId": "request_credential_v1_issuer_credentials__credential_exchange_id__request_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_exchange_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Exchange Id" } + "schema": { + "type": "string", + "title": "Credential Exchange Id" + } }, { "name": "save_exchange_record", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete.", "title": "Save Exchange Record" }, @@ -841,186 +1582,359 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/{credential_exchange_id}/store": { "post": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Store a Received Credential in Wallet", "description": "NB: Deprecated because credentials are automatically stored in wallet after they are accepted\n---\n\nStore a credential\n---\nStore a credential by providing the credential exchange id.\nThe credential exchange id is the id of the credential exchange record, not the credential itself.\n\nThe holder only needs to call this endpoint if the holder receives a credential out of band\n\nThe holder can store the credential in their wallet after receiving it from the issuer.\n\nParameters:\n---\n credential_exchange_id: str\n credential exchange record identifier\n\nReturns:\n---\n CredentialExchange\n An updated record of this credential exchange", "operationId": "store_credential_v1_issuer_credentials__credential_exchange_id__store_post", "deprecated": true, - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_exchange_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Exchange Id" } + "schema": { + "type": "string", + "title": "Credential Exchange Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/{credential_exchange_id}": { "get": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Fetch a single Credential Exchange Record", "description": "Get a credential exchange record by credential id\n---\nBoth holders and issuers can call this endpoint, because they each have their own records of a credential exchange.\n\nThese records contain information about the credentials issued to a holder, such as the current state of the\nexchange, and other metadata such as the `connection_id` that a credential was submit to (if an issuer) or received\nfrom (if a holder).\n\nNB: An issuer and a holder will have distinct credential exchange ids, despite referring to the same exchange.\nThe `thread_id` is the only record attribute that will be the same for the holder and the issuer.\n\nAn exchange record will, by default, automatically be deleted after a flow completes (i.e. when state is 'done'),\nunless the `save_exchange_record` was set to true, or the wallet is configured to preserve records by default.\n\nThe following parameters can be set to filter the fetched exchange records: connection_id, role, state, thread_id.\n\nParameters:\n---\n credential_exchange_id: str\n The identifier of the credential exchange record that you want to fetch\n\nReturns:\n---\n CredentialExchange\n The credential exchange record", "operationId": "get_credential_v1_issuer_credentials__credential_exchange_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_exchange_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Exchange Id" } + "schema": { + "type": "string", + "title": "Credential Exchange Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredentialExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "delete": { - "tags": ["issuer"], + "tags": [ + "issuer" + ], "summary": "Delete an Exchange Record", "description": "Delete a credential exchange record\n---\nThis will remove a specific credential exchange from your storage records.\n\nParameters:\n---\n credential_exchange_id: str\n The identifier of the credential exchange record that you want to delete\n\nReturns:\n---\n status_code: 204", "operationId": "remove_credential_exchange_record_v1_issuer_credentials__credential_exchange_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_exchange_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Exchange Id" } + "schema": { + "type": "string", + "title": "Credential Exchange Id" + } } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/revoke": { "post": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Revoke a Credential (if revocable)", "description": "Revoke a credential\n---\nRevoke a credential by providing the identifier of the exchange.\n\nIf an issuer is going to revoke more than one credential, it is recommended to set the\n'auto_publish_on_ledger' field to False (default), and then batch publish the revocations using\nthe 'publish-revocations' endpoint.\n\nBy batching the revocations, the issuer can save on transaction fees related to\npublishing revocations to the ledger.\n\nRequest Body:\n---\n body: RevokeCredential\n - credential_exchange_id (str): The ID associated with the credential exchange that should be revoked.\n - auto_publish_on_ledger (bool): (True) publish revocation to ledger immediately, or\n (default, False) mark it pending\n\nReturns:\n---\n RevokedResponse:\n revoked_cred_rev_ids:\n The revocation registry indexes that were revoked.\n Will be empty if the revocation was marked as pending.", "operationId": "revoke_credential_v1_issuer_credentials_revoke_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeCredential" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevokeCredential" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokedResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevokedResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/issuer/credentials/revocation/record": { "get": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Fetch a Revocation Record", "description": "Get a credential revocation record\n---\nFetch a credential revocation record by providing the credential exchange id.\nRecords can also be fetched by providing the credential revocation id and revocation registry id.\n\nThe record is the payload of the webhook event on topic 'issuer_cred_rev', and contains the credential's revocation\nstatus and other metadata.\n\nThe revocation registry id (rev_reg_id) and credential revocation id (cred_rev_id) can be found\nin this record if you have the credential exchange id.\n\nParameters:\n---\n credential_exchange_id: str\n credential_revocation_id: str\n revocation_registry_id: str\n\nReturns:\n---\n IssuerCredRevRecord\n The credential revocation record\n\nRaises:\n---\n CloudApiException: 400\n If credential_exchange_id is not provided, both credential_revocation_id and revocation_registry_id must be.", "operationId": "get_credential_revocation_record_v1_issuer_credentials_revocation_record_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_exchange_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Credential Exchange Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Credential Exchange Id" + } }, { "name": "credential_revocation_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Credential Revocation Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Credential Revocation Id" + } }, { "name": "revocation_registry_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Revocation Registry Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Revocation Registry Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuerCredRevRecord" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/IssuerCredRevRecord" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/publish-revocations": { "post": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Publish Pending Revocations", "description": "Write pending revocations to the ledger\n---\nRevocations that are in a pending state can be published to the ledger.\n\nThe endpoint accepts a `revocation_registry_credential_map`, which provides a dictionary of\nrevocation registry IDs to credential revocation IDs, to allow publishing individual credentials.\n\nIf no revocation registry id is provided (i.e. an empty map `revocation_registry_credential_map: {}`),\nthen all pending revocations will be published.\n\nIf no credential revocation id is provided under a given revocation registry id, then all pending revocations for\nthe given revocation registry id will be published.\n\nWhere to find the revocation registry id and credential revocation id:\nWhen issuing a credential, against a credential definition that supports revocation,\nthe issuer will receive a webhook event on the topic 'issuer_cred_rev'. This event will contain\nthe credential exchange id (cred_ex_id), the credential revocation id (cred_rev_id) and\nthe revocation registry id (rev_reg_id).\n\nRequest Body:\n---\n publish_request: PublishRevocationsRequest\n An instance of `PublishRevocationsRequest` containing a `revocation_registry_credential_map`. This map\n is a dictionary where each key is a revocation registry ID and its value is a list of credential\n revocation IDs to be published. Providing an empty list for a registry ID instructs the system to\n publish all pending revocations for that ID. An empty dictionary signifies that all pending\n revocations across all registry IDs should be published.\n\nReturns:\n---\n RevokedResponse:\n revoked_cred_rev_ids:\n The revocation registry indexes that were revoked.\n Will be empty if there were no revocations to publish.", "operationId": "publish_revocations_v1_issuer_credentials_publish_revocations_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishRevocationsRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PublishRevocationsRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokedResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevokedResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/issuer/credentials/clear-pending-revocations": { "post": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Clear Pending Revocations", "description": "Clear pending revocations\n---\nRevocations that are in a pending state can be cleared, such that they are no longer set to be revoked.\n\nThe endpoint accepts a `revocation_registry_credential_map`, which provides a dictionary of\nrevocation registry IDs to credential revocation IDs, to allow clearing individual credentials.\n\nIf no revocation registry id is provided (i.e. an empty map `revocation_registry_credential_map: {}`),\nthen all pending revocations will be cleared.\n\nIf no credential revocation id is provided under a given revocation registry id, then all pending revocations for\nthe given revocation registry id will be cleared.\n\nWhere to find the revocation registry id and credential revocation id:\nWhen issuing a credential, against a credential definition that supports revocation,\nthe issuer will receive a webhook event on the topic 'issuer_cred_rev'. This event will contain\nthe credential exchange id (cred_ex_id), the credential revocation id (cred_rev_id) and\nthe revocation registry id (rev_reg_id).\n\nRequest Body:\n---\n clear_pending_request: ClearPendingRevocationsRequest\n An instance of `ClearPendingRevocationsRequest` containing a `revocation_registry_credential_map`. This map\n is a dictionary where each key is a revocation registry ID and its value is a list of credential\n revocation IDs to be cleared. Providing an empty list for a registry ID instructs the system to\n clear all pending revocations for that ID. An empty dictionary signifies that all pending\n revocations across all registry IDs should be cleared.\n\nReturns:\n---\n ClearPendingRevocationsResult\n The revocations that are still pending after the clear request is performed", "operationId": "clear_pending_revocations_v1_issuer_credentials_clear_pending_revocations_post", "requestBody": { "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ClearPendingRevocationsRequest" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClearPendingRevocationsRequest" + } + } }, "required": true }, @@ -1028,168 +1942,321 @@ "200": { "description": "Successful Response", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/ClearPendingRevocationsResult" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/ClearPendingRevocationsResult" + } + } } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/issuer/credentials/get-pending-revocations/{revocation_registry_id}": { "get": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Get Pending Revocations", "description": "Get pending revocations\n---\nGet the pending revocations for a given revocation registry ID.\n\nParameters:\n---\n revocation_registry_id: str\n The ID of the revocation registry for which to fetch pending revocations\n\nReturns:\n---\n PendingRevocations:\n A list of cred_rev_ids pending revocation for a given revocation registry ID", "operationId": "get_pending_revocations_v1_issuer_credentials_get_pending_revocations__revocation_registry_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "revocation_registry_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Revocation Registry Id" } + "schema": { + "type": "string", + "title": "Revocation Registry Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PendingRevocations" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PendingRevocations" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/issuer/credentials/fix-revocation-registry/{revocation_registry_id}": { "put": { - "tags": ["revocation"], + "tags": [ + "revocation" + ], "summary": "Fix Revocation Registry Entry State", "description": "Fix Revocation Registry Entry State\n---\nFix the revocation registry entry state for a given revocation registry ID.\n\nIf issuer's revocation registry wallet state is out of sync with the ledger,\nthis endpoint can be used to fix/update the ledger state.\n\nPath Parameters:\n---\n revocation_registry_id: str\n The ID of the revocation registry for which to fix the state\n\nQuery Parameters:\n---\n apply_ledger_update: bool\n Apply changes to ledger (default: False). If False, only computes the difference\n between the wallet and ledger state.\n\nReturns:\n---\n RevRegWalletUpdatedResult:\n accum_calculated: The calculated accumulator value for any revocations not yet published to ledger\n accum_fixed: The result of applying the ledger transaction to synchronize revocation state\n rev_reg_delta: The delta between wallet and ledger state for this revocation registry", "operationId": "fix_revocation_registry_entry_state_v1_issuer_credentials_fix_revocation_registry__revocation_registry_id__put", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "revocation_registry_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Revocation Registry Id" } + "schema": { + "type": "string", + "title": "Revocation Registry Id" + } }, { "name": "apply_ledger_update", "in": "query", "required": false, - "schema": { "type": "boolean", "default": false, "title": "Apply Ledger Update" } + "schema": { + "type": "boolean", + "default": false, + "title": "Apply Ledger Update" + } } ], "responses": { "200": { "description": "Successful Response", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/RevRegWalletUpdatedResult" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/RevRegWalletUpdatedResult" + } + } } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/jsonld/sign": { "post": { - "tags": ["jsonld"], + "tags": [ + "jsonld" + ], "summary": "Sign Jsonld", "description": "Sign a JSON-LD structure", "operationId": "sign_jsonld_v1_jsonld_sign_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonLdSignRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonLdSignRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SignResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/jsonld/verify": { "post": { - "tags": ["jsonld"], + "tags": [ + "jsonld" + ], "summary": "Verify Jsonld", "description": "Verify a JSON-LD structure", "operationId": "verify_jsonld_v1_jsonld_verify_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonLdVerifyRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JsonLdVerifyRequest" + } + } + }, "required": true }, "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/messaging/send-message": { "post": { - "tags": ["messaging"], + "tags": [ + "messaging" + ], "summary": "Send a Message", "description": "Send basic message\n---\n\nSend a message to a tenant via a connection. The other tenant will receive\nthe message on topic `basic-message` for their webhook events.\n\nSee the Aries\n[Basic Message Protocol](https://github.com/hyperledger/aries-rfcs/blob/main/features/0095-basic-message/README.md)\nfor more information.\n\nRequest body:\n---\n message: Message\n connection_id: str\n Connection ID of the connection to send the message to.\n content: str\n The message to send.\n\nReturns:\n---\n Status code 204", "operationId": "send_messages_v1_messaging_send_message_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Message" + } + } + }, "required": true }, "responses": { - "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, + "200": { + "description": "Successful Response", + "content": { + "application/json": { + "schema": {} + } + } + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/messaging/trust-ping": { "post": { - "tags": ["messaging"], + "tags": [ + "messaging" + ], "summary": "Send Trust Ping", "description": "Send trust ping\n---\nSend a trust ping to a connection to ensure that the connection is active and ready.\n\nSee the Aries\n[Trust Ping Protocol](https://github.com/hyperledger/aries-rfcs/blob/main/features/0048-trust-ping/README.md)\nfor more information.\n\nRequest body:\n---\n TrustPingMsg :\n connection_id: str\n Connection ID of the connection to send the trust ping to.\n comment: str\n Comment to include in the trust ping.\n\nReturns:\n---\n PingRequestResponse\n thread_id: str\n Thread ID of the ping message", "operationId": "send_trust_ping_v1_messaging_trust_ping_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrustPingMsg" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/TrustPingMsg" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingRequestResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PingRequestResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/oob/create-invitation": { "post": { - "tags": ["out-of-band"], + "tags": [ + "out-of-band" + ], "summary": "Create OOB Invitation", "description": "Create an out-of-band invitation\n---\n\nThe attachment field is used to include a credential offer or a proof request in the invitation.\nThe attachment ID is the credential exchange ID or proof request ID.\nThe attachment type is either `\"credential-offer\"` or `\"present-proof\"`.\n\nThe multi_use field is used to determine if the invitation can be used multiple times by different tenants.\nThe `use_public_did` field should only be set true, if a tenant with a public DID is creating\na connection invitation, then the invitation will use the tenants public did to create the connection invitation\ni.e. the tenant accepting the invitation will connect via public did of tenant that created invitation\n\n`multi_use` can't be set to `true` if an `attachment` is provided,\nas a proof request or credential offer should be sent to one tenant.\n\nRequest body:\n---\n body:CreateOobInvitation\n alias: Optional[str]\n multi_use: bool (default false)\n use_public_did: bool (default false)\n attachments: Optional[List[Attachment]]\n create_connection: Optional[bool]\n\nReturns:\n---\n InvitationRecord\n The invitation record", "operationId": "create_oob_invitation_v1_oob_create_invitation_post", @@ -1197,7 +2264,14 @@ "content": { "application/json": { "schema": { - "anyOf": [{ "$ref": "#/components/schemas/CreateOobInvitation" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/CreateOobInvitation" + }, + { + "type": "null" + } + ], "title": "Body" } } @@ -1206,165 +2280,336 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvitationRecord" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/InvitationRecord" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/oob/accept-invitation": { "post": { - "tags": ["out-of-band"], + "tags": [ + "out-of-band" + ], "summary": "Accept OOB Invitation", "description": "Accept out-of-band invitation\n---\n\nAs with the accept connection invitation endpoint, the invitation object from the create-invitation endpoint\nis passed to this endpoint.\n\nThe `invitation_url` in the InvitationRecord can also be used to obtain an invitation; there is a base64 encoded\nstring after the \"?oob=\" parameter in the url, and this can be decoded to obtain the invitation object.\n\nRequest body:\n---\n body: AcceptOobInvitation\n alias: Optional[str]\n use_existing_connection: Optional[bool]\n invitation: InvitationMessage\n\nReturns:\n---\n OobRecord\n The out-of-band record", "operationId": "accept_oob_invitation_v1_oob_accept_invitation_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptOobInvitation" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AcceptOobInvitation" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OobRecord" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/OobRecord" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/oob/connect-public-did": { "post": { - "tags": ["out-of-band"], + "tags": [ + "out-of-band" + ], "summary": "Connect with Public DID", "description": "Connect using public DID as implicit invitation\n---\n\nA connection will automatically be established with the public DID.\n\nRequest body:\n---\n body: ConnectToPublicDid\n public_did: str\n\nReturns:\n---\n Connection\n The connection record", "operationId": "connect_to_public_did_v1_oob_connect_public_did_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectToPublicDid" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ConnectToPublicDid" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Connection" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/Connection" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/verifier/send-request": { "post": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Send a Proof Request to a connection", "description": "Send proof request\n---\nNB: Only a tenant with the verifier role can send a proof request.\n\nThe verifier uses this endpoint to send a proof request to a specific connection, by providing the connection ID.\n\nThe proof request type must be one of indy or ld_proof.\n```json\n {\n \"type\": \"indy\" or \"ld_proof\",\n \"indy_proof_request\": {...}, <-- Required if type is \"indy\"\n \"dif_proof_request\": {...}, <-- Required if type is \"ld_proof\"\n \"save_exchange_record\": true <-- Whether the proof exchange record should be preserved after completion.\n \"comment\": \"string\", <-- This comment will appear in the proof record for the recipient as well\n \"connection_id\": \"string\", <-- The verifier's reference to the connection to send this proof request to\n }\n```\nFor a detailed technical specification and informative diagrams\nrelated to the present proof process, refer to the [Aries Present Proof v2\nRFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0454-present-proof-v2/README.md) and the [LD Proof\nAttachment RFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0510-dif-pres-exch-attach/README.md).\n\nRequest Body:\n---\n body: SendProofRequest\n The proof request object\n\nReturns:\n---\n PresentationExchange\n The presentation exchange record for this request", "operationId": "send_proof_request_v1_verifier_send_request_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendProofRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SendProofRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresentationExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PresentationExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/verifier/create-request": { "post": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Create a Proof Request (not bound to a connection)", "description": "Creates a presentation request that is not bound to any specific proposal or connection\n---\nThis endpoint is used to create a proof request that is not bound to a connection. This means the proof request is\nnot sent directly, but it will do the initial step of creating a proof exchange record,\nwhich the verifier can then use in the out of band (OOB) protocol.\n\nThe OOB protocol allows proof requests to be sent over alternative channels, such as email or QR code, where a\nconnection does not yet exist between holder and verifier.\n\nThe proof request type must be one of indy or ld_proof.\n```json\n {\n \"type\": \"indy\" or \"ld_proof\",\n \"indy_proof_request\": {...}, <-- Required if type is \"indy\"\n \"dif_proof_request\": {...}, <-- Required if type is \"ld_proof\"\n \"save_exchange_record\": true <-- Whether the proof exchange record should be preserved after completion.\n \"comment\": \"string\", <-- This comment will appear in the proof record for the recipient as well\n }\n```\nFor a detailed technical specification and informative diagrams\nrelated to the present proof process, refer to the [Aries Present Proof v2\nRFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0454-present-proof-v2/README.md) and the [LD Proof\nAttachment RFC](https://github.com/hyperledger/aries-rfcs/blob/main/features/0510-dif-pres-exch-attach/README.md).\n\nRequest Body:\n---\n body: CreateProofRequest\n The proof request object\n\nReturns:\n---\n PresentationExchange\n The presentation exchange record for this request", "operationId": "create_proof_request_v1_verifier_create_request_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProofRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CreateProofRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresentationExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PresentationExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/verifier/accept-request": { "post": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Accept a Proof Request", "description": "Accept proof request\n---\nA prover uses this endpoint to respond to a proof request, by sending a presentation to the verifier.\n\nAn Indy presentation contains a mapping of the requested attributes to the wallet credential id of the prover.\n\nExample:\n```json\n{\n \"indy_presentation_spec\": {\n \"requested_attributes\": {\n \"surname\": {\n \"cred_id\": \"10e6b03f-2b60-431a-9634-731594423120\",\n \"revealed\": true\n },\n \"name\": {\n \"cred_id\": \"10e6b03f-2b60-431a-9634-731594423120\",\n \"revealed\": true\n },\n \"age\": {\n \"cred_id\": \"10e6b03f-2b60-431a-9634-731594423120\",\n \"revealed\": true\n }\n }\n }\n}\n```\n\nIn the context of the holder's wallet, the `cred_id` is called the `referent`.\n\nThe `revealed` parameter indicates whether the holder wants to reveal the attribute value to the verifier or not.\n\nRequest Body:\n---\n body: AcceptProofRequest\n The proof request object\n\nReturns:\n---\n PresentationExchange\n The prover's updated presentation exchange record after responding to the proof request.", "operationId": "accept_proof_request_v1_verifier_accept_request_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptProofRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AcceptProofRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresentationExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PresentationExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/verifier/reject-request": { "post": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Reject a Proof Request", "description": "Reject proof request\n---\nA prover uses this endpoint to notify the verifier that they cannot or refuse to respond to a proof request.\n\nThe prover provides the proof ID of the request that they want to reject, and a message (`problem_report`) that\nwill display in the verifier's presentation exchange record as the rejection message.\n\nRequest Body:\n---\n body: RejectProofRequest\n proof_id: str\n The proof id of the presentation request that is being rejected\n problem_report: str\n A message to inform the verifier why their proof request is rejected\n delete_proof_record: bool (default: False)\n Can be set to true if the prover wishes to delete their record of the rejected presentation exchange.\n\nReturns:\n---\n status_code: 204", "operationId": "reject_proof_request_v1_verifier_reject_request_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RejectProofRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/RejectProofRequest" + } + } + }, "required": true }, "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/verifier/proofs": { "get": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Get Presentation Exchange Records", "description": "Get all presentation exchange records for this tenant\n---\nThese records contains information about proof requests and presentations.\n\nThe results can be filtered by connection_id, role, state, and thread_id.\n\nParameters (Optional):\n---\n limit: int: The maximum number of records to retrieve\n offset: int: The offset to start retrieving records from\n descending: bool - Whether to return results in descending order. Results are ordered by record created time.\n connection_id: str\n role: Role: \"prover\", \"verifier\"\n state: State: \"presentation-received\", \"presentation-sent\", \"proposal-received\", \"proposal-sent\",\n \"request-received\", \"request-sent\", \"abandoned\", \"done\"\n thread_id: UUID\n\nReturns:\n---\n List[PresentationExchange]\n The list of presentation exchange records", "operationId": "get_proof_records_v1_verifier_proofs_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -1376,7 +2621,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -1399,14 +2652,35 @@ "name": "connection_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Connection Id" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Connection Id" + } }, { "name": "role", "in": "query", "required": false, "schema": { - "anyOf": [{ "enum": ["prover", "verifier"], "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "enum": [ + "prover", + "verifier" + ], + "type": "string" + }, + { + "type": "null" + } + ], "title": "Role" } }, @@ -1430,7 +2704,9 @@ ], "type": "string" }, - { "type": "null" } + { + "type": "null" + } ], "title": "State" } @@ -1439,7 +2715,18 @@ "name": "thread_id", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string", "format": "uuid" }, { "type": "null" }], "title": "Thread Id" } + "schema": { + "anyOf": [ + { + "type": "string", + "format": "uuid" + }, + { + "type": "null" + } + ], + "title": "Thread Id" + } } ], "responses": { @@ -1449,7 +2736,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/PresentationExchange" }, + "items": { + "$ref": "#/components/schemas/PresentationExchange" + }, "title": "Response Get Proof Records V1 Verifier Proofs Get" } } @@ -1457,71 +2746,158 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/verifier/proofs/{proof_id}": { "get": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Get a Presentation Exchange Record", "description": "Get a specific presentation exchange record\n---\nThis fetches a specific presentation exchange record by providing the proof ID.\n\nParameters:\n---\n proof_id: str\n The proof ID for the presentation request of interest\n\nReturns:\n---\n PresentationExchange\n The presentation exchange record for the proof ID", "operationId": "get_proof_record_v1_verifier_proofs__proof_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "proof_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proof Id" } } + { + "name": "proof_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Proof Id" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresentationExchange" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PresentationExchange" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "delete": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Delete a Presentation Exchange Record", "description": "Delete a presentation exchange record\n---\nThis will remove a specific presentation exchange from your storage records.\n\nParameters:\n---\n proof_id: str\n The identifier of the presentation exchange record that you want to delete\n\nReturns:\n---\n status_code: 204", "operationId": "delete_proof_v1_verifier_proofs__proof_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "proof_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proof Id" } } + { + "name": "proof_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Proof Id" + } + } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/verifier/proofs/{proof_id}/credentials": { "get": { - "tags": ["verifier"], + "tags": [ + "verifier" + ], "summary": "Get Matching Credentials for a Proof", "description": "Get matching credentials for a presentation exchange\n---\nThis endpoint returns a list of possible credentials that the prover can use to respond to a given proof request.\n\nThe `presentation_referents` field (in the response) indicates which of the fields\nin the proof request that credential satisfies.\n\nParameters:\n---\n proof_id: str\n The relevant proof exchange ID for the prover\n referent: Optional str\n The presentation_referent of the proof to match, comma separated str of presentation_referents\n limit: Optional int\n The number of credentials to fetch\n offset: Optional int\n The index to start fetching credentials from\n\nReturns:\n---\n List[IndyCredPrecis]\n A list of applicable Indy credentials", "operationId": "get_credentials_by_proof_id_v1_verifier_proofs__proof_id__credentials_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "proof_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Proof Id" } }, + { + "name": "proof_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Proof Id" + } + }, { "name": "referent", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Referent" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Referent" + } }, { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -1533,7 +2909,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -1548,7 +2932,9 @@ "application/json": { "schema": { "type": "array", - "items": { "$ref": "#/components/schemas/IndyCredPrecis" }, + "items": { + "$ref": "#/components/schemas/IndyCredPrecis" + }, "title": "Response Get Credentials By Proof Id V1 Verifier Proofs Proof Id Credentials Get" } } @@ -1556,25 +2942,46 @@ }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Fetch a list of credentials from the wallet", "description": "Fetch a list of credentials from the wallet\n---\n\nThe `wql` (Wallet Query Language) parameter can be used to filter credentials returned from the wallet.\n\nThe following string will look for the credential with the attribute `age` with value `21`:\n\n {\"attr::age::value\": \"21\"}\n\nOptional Parameters:\n---\n limit: int\n The number of records to return.\n offset: int\n The number of records to skip before starting to return records.\n wql: str\n A WQL query to filter records.\n\nReturns:\n---\n CredInfoList\n A list of credential records.", "operationId": "list_credentials_v1_wallet_credentials_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "maximum": 10000, "minimum": 1 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 10000, + "minimum": 1 + }, + { + "type": "null" + } + ], "description": "Number of results to return", "default": 1000, "title": "Limit" @@ -1586,7 +2993,15 @@ "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer", "minimum": 0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "minimum": 0 + }, + { + "type": "null" + } + ], "description": "Offset for pagination", "default": 0, "title": "Offset" @@ -1597,164 +3012,320 @@ "name": "wql", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Wql" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Wql" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredInfoList" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredInfoList" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials/{credential_id}": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Fetch a credential by ID", "description": "Fetch a specific credential by ID\n---\n\nParameters:\n---\n credential_id: str\n The ID of the credential to fetch.\n\nReturns:\n---\n IndyCredInfo\n The credential record.", "operationId": "get_credential_record_v1_wallet_credentials__credential_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } } ], "responses": { "200": { "description": "Successful Response", "content": { - "application/json": { "schema": { "$ref": "#/components/schemas/app__models__wallet__IndyCredInfo" } } + "application/json": { + "schema": { + "$ref": "#/components/schemas/app__models__wallet__IndyCredInfo" + } + } } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "delete": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Delete a credential by ID", "description": "Remove a specific credential from the wallet by ID\n---\n\nParameters:\n---\n credential_id: str\n The ID of the credential to delete.\n\nReturns:\n---\n status_code: 204", "operationId": "delete_credential_v1_wallet_credentials__credential_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials/{credential_id}/mime-types": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Retrieve attribute MIME types of a credential", "description": "Retrieve attribute MIME types of a specific credential by ID\n---\n\nParameters:\n---\n credential_id: str\n The ID of the credential to fetch attribute MIME types for.\n\nReturns:\n---\n AttributeMimeTypesResult\n The attribute MIME types of the credential.", "operationId": "get_credential_mime_types_v1_wallet_credentials__credential_id__mime_types_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeMimeTypesResult" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AttributeMimeTypesResult" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials/{credential_id}/revocation-status": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Get revocation status of a credential", "description": "Query the revocation status of a specific credential by ID\n---\n\nThe revocation status of a credential can be queried over a specific time range\nby passing unix timestamps to the `from_` and `to` parameters.\nLeaving these parameters blank will return the current revocation status.\n\nParameters:\n---\n credential_id: str\n The ID of the credential to query revocation status for.\n from_: Optional[str]\n The timestamp to start the query from.\n to: Optional[str]\n The timestamp to end the query at.\n\nReturns:\n---\n CredRevokedResult\n The revocation status of the credential.", "operationId": "get_credential_revocation_status_v1_wallet_credentials__credential_id__revocation_status_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } }, { "name": "from_", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "From " } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From " + } }, { "name": "to", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "To" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "To" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredRevokedResult" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/CredRevokedResult" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials/w3c": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Fetch a list of W3C credentials from the wallet", "description": "Fetch a list of W3C credentials from the wallet\n---\n\nThe W3C credentials can be filtered by the parameters provided.\n\nOptional Parameters:\n---\n limit: int\n Maximum number of results to return\n issuer_did: str\n Credential issuer did to match\n schema_ids: List[str]\n Schema identifiers to match\n\nReturns:\n---\n VCRecordList\n A list of W3C credential records.", "operationId": "list_w3c_credentials_v1_wallet_credentials_w3c_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "limit", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Limit" } + "schema": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Limit" + } }, { "name": "issuer_did", "in": "query", "required": false, - "schema": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Issuer Did" } + "schema": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Issuer Did" + } } ], "requestBody": { "content": { "application/json": { "schema": { - "anyOf": [{ "type": "array", "items": { "type": "string" } }, { "type": "null" }], + "anyOf": [ + { + "type": "array", + "items": { + "type": "string" + } + }, + { + "type": "null" + } + ], "title": "Schema Ids" } } @@ -1763,67 +3334,119 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VCRecordList" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VCRecordList" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/credentials/w3c/{credential_id}": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Fetch a W3C credential by ID", "description": "Fetch a specific W3C credential by ID\n---\n\nParameters:\n---\n credential_id: str\n The ID of the W3C credential to fetch.\n\nReturns:\n---\n VCRecord\n The W3C credential.", "operationId": "get_w3c_credential_v1_wallet_credentials_w3c__credential_id__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VCRecord" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/VCRecord" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "delete": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Delete W3C credential", "description": "Remove a specific W3C credential from the wallet by ID\n---\n\nParameters:\n---\n credential_id: str\n The ID of the W3C credential to delete.\n\nReturns:\n---\n status_code: 204", "operationId": "delete_w3c_credential_v1_wallet_credentials_w3c__credential_id__delete", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ { "name": "credential_id", "in": "path", "required": true, - "schema": { "type": "string", "title": "Credential Id" } + "schema": { + "type": "string", + "title": "Credential Id" + } } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/dids": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "List DIDs", "description": "Retrieve List of DIDs\n---\n\nThis endpoint allows you to retrieve a list of DIDs in the wallet.\n\nResponse:\n---\n Returns a list of DID objects.", "operationId": "list_dids_v1_wallet_dids_get", @@ -1833,7 +3456,9 @@ "content": { "application/json": { "schema": { - "items": { "$ref": "#/components/schemas/DID" }, + "items": { + "$ref": "#/components/schemas/DID" + }, "type": "array", "title": "Response List Dids V1 Wallet Dids Get" } @@ -1841,10 +3466,16 @@ } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] }, "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Create Local DID", "description": "Create Local DID\n---\n\nThis endpoint allows you to create a new DID in the wallet.\nThe `method` parameter is optional and can be set to\n'sov', 'key', 'web', 'did:peer:2', or 'did:peer:4'.\n\nThe `options` field is deprecated and has been flattened, such that `did` and\n`key_type` are now top-level fields. The `options` field will still\ntake precedence over the top-level fields if it is present.\n\nRequest Body:\n---\n DIDCreate (Optional):\n method (str, optional): Method for the requested DID.\n options (DIDCreateOptions, optional): Deprecated.\n seed (str, optional): Optional seed for DID.\n key_type (str, optional): Key type for the DID.\n did (str, optional): Specific DID value.\n\nResponse:\n---\n Returns the created DID object.", "operationId": "create_did_v1_wallet_dids_post", @@ -1852,7 +3483,14 @@ "content": { "application/json": { "schema": { - "anyOf": [{ "$ref": "#/components/schemas/DIDCreate" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/DIDCreate" + }, + { + "type": "null" + } + ], "title": "Did Create" } } @@ -1861,229 +3499,503 @@ "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DID" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DID" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/wallet/dids/public": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Fetch Public DID", "description": "Fetch the Current Public DID\n---\n\nThis endpoint allows you to fetch the current public DID.\nBy default, only issuers will have public DIDs.\n\nResponse:\n---\n Returns the public DID.", "operationId": "get_public_did_v1_wallet_dids_public_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DID" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DID" + } + } + } } } }, "put": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Set Public DID", "description": "Set the Current Public DID\n---\n\nThis endpoint allows you to set the current public DID.\n\n**Notes:**\n - Requires an active endorser connection to make a DID public.\n - By default, only issuers can have and update public DIDs.\n\nParameters:\n---\n did: str\n\nResponse:\n---\n Returns the public DID.", "operationId": "set_public_did_v1_wallet_dids_public_put", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "did", "in": "query", "required": true, "schema": { "type": "string", "title": "Did" } } + { + "name": "did", + "in": "query", + "required": true, + "schema": { + "type": "string", + "title": "Did" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DID" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DID" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/dids/{did}/rotate-keypair": { "patch": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Rotate Key Pair", "description": "Rotate Key Pair for DID\n---\n\nThis endpoint allows you to rotate the key pair for a DID.\n\nParameters:\n---\n did: str\n\nResponse:\n---\n 204 No Content", "operationId": "rotate_keypair_v1_wallet_dids__did__rotate_keypair_patch", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "did", "in": "path", "required": true, "schema": { "type": "string", "title": "Did" } } + { + "name": "did", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Did" + } + } ], "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/dids/{did}/endpoint": { "get": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Get DID Endpoint", "description": "Get DID Endpoint\n---\n\nThis endpoint allows you to fetch the endpoint for a DID.\n\nParameters:\n---\n did: str\n\nResponse:\n---\n Returns the endpoint for the DID.", "operationId": "get_did_endpoint_v1_wallet_dids__did__endpoint_get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "did", "in": "path", "required": true, "schema": { "type": "string", "title": "Did" } } + { + "name": "did", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Did" + } + } ], "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DIDEndpoint" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/DIDEndpoint" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } }, "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Set DID Endpoint", "description": "Update Endpoint of DID in Wallet (and on Ledger, if it is a Public DID)\n---\n\nThis endpoint allows you to update the endpoint for a DID.\n\nParameters:\n---\n did: str\n\nRequest Body:\n---\n SetDidEndpointRequest:\n endpoint: str", "operationId": "set_did_endpoint_v1_wallet_dids__did__endpoint_post", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "did", "in": "path", "required": true, "schema": { "type": "string", "title": "Did" } } + { + "name": "did", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Did" + } + } ], "requestBody": { "required": true, - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDidEndpointRequest" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SetDidEndpointRequest" + } + } + } }, "responses": { - "204": { "description": "Successful Response" }, + "204": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } }, "/v1/wallet/jws/sign": { "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Sign JWS", "description": "Sign a JSON Web Signature (JWS).\n---\n\nThis endpoint allows users to sign a JSON payload, creating a JWS,\nusing either a DID or a specific verification method.\n\n**Usage:**\n\n- **DID-Based Signing:** Provide the `did` field with a valid DID.\nThe Aries agent will automatically select the appropriate verification key associated with the DID.\n\n- **Verification Method-Based Signing:** Provide the `verification_method` field with a specific verification method\n(DID with a verkey) to explicitly specify which key to use for signing.\n\n**Notes:**\n\n- If the issuer uses a `did:sov` DID, ensure that the DID is public.\n- The `header` field is optional. While you can specify custom headers, the `typ`, `alg`,\n and `kid` fields are automatically populated by the Aries agent based on the signing method.\n\nExample request body:\n```json\n{\n \"did\": \"did:sov:WWMjrBJkUzz9suEtwKxmiY\",\n \"payload\": {\n \"credential_subject\": \"reference_to_holder\",\n \"name\": \"Alice\",\n \"surname\": \"Demo\"\n }\n}\n```\n**OR**\n```json\n{\n \"payload\": {\n \"subject\": \"reference_to_holder\",\n \"name\": \"Alice\",\n \"surname\": \"Demo\"\n },\n \"verification_method\": \"did:key:z6Mkprf81ujG1n48n5LMD...M6S3#z6Mkprf81ujG1n48n5LMDaxyCLLFrnqCRBPhkTWsPfA8M6S3\"\n}\n```\n\nRequest Body:\n---\n JWSCreateRequest:\n `did` (str, optional): The DID to sign the JWS with.\n `verification_method` (str, optional): The verification method (DID with verkey) to use for signing.\n `payload` (dict): The JSON payload to be signed.\n `headers` (dict, optional): Custom headers for the JWS.\n\nResponse:\n---\n JWSCreateResponse:\n `jws` (str): The resulting JWS string representing the signed JSON Web Signature.\n\n**References:**\n\n- [JSON Web Signature (JWS) Specification](https://www.rfc-editor.org/rfc/rfc7515.html)", "operationId": "sign_jws_v1_wallet_jws_sign_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWSCreateRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JWSCreateRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWSCreateResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JWSCreateResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/wallet/jws/verify": { "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Verify JWS", "description": "Verify a JSON Web Signature (JWS)\n---\n\nThis endpoint allows users to verify the authenticity and integrity of a JWS string previously generated\nby the /sign endpoint. It decodes the JWS to retrieve the payload and headers and assesses its validity.\n\nRequest Body:\n---\n JWSVerifyRequest: The JWS to verify.\n jws: str\n\nReturns:\n---\n JWSVerifyResponse\n payload: dict:\n The payload of the JWS.\n headers: dict:\n The headers of the JWS.\n kid: str:\n The key id of the signer.\n valid: bool:\n Whether the JWS is valid.\n error: str:\n The error message if the JWS is invalid.\n\n**References:**\n\n- [JSON Web Signature (JWS) Specification](https://www.rfc-editor.org/rfc/rfc7515.html)", "operationId": "verify_jws_v1_wallet_jws_verify_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWSVerifyRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JWSVerifyRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JWSVerifyResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/JWSVerifyResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/wallet/sd-jws/sign": { "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Sign SD-JWS", "description": "Sign a Selective Disclosure JSON Web Signature (SD-JWS).\n---\n\nThis endpoint allows users to create a Selective Disclosure JSON Web Signature (SD-JWS).\nThe SD-JWS enables the selective disclosure of specific attributes to a verifier while keeping others confidential.\n\n**Usage:**\n\n- **DID-Based Signing:** Provide the `did` field with a valid DID.\nThe Aries agent will automatically select the appropriate verification key associated with the DID.\n\n- **Verification Method-Based Signing:** Provide the `verification_method` field with a specific verification method\n(DID with verkey) to explicitly specify which key to use for signing.\n\n**Notes:**\n\n- If the issuer uses a `did:sov` DID, ensure that the DID is public.\n- The `headers` field is optional. Custom headers can be specified, but the `typ`, `alg`,\n and `kid` fields are automatically populated by the Aries agent based on the signing method.\n- The `non_sd_list` field specifies attributes that are **not** selectively disclosed.\n Attributes listed here will always be included in the SD-JWS.\n\n**Non-Selective Disclosure (`non_sd_list`):**\n\n- To exclude list elements:\n - Use the format `\"[start:end]\"` where `start` and `end` define the range\n (e.g., `\"nationalities[1:3]\"`).\n- To exclude specific dictionary attributes:\n - Use the format `\".\"` (e.g., `\"address.street_address\"`).\n\n**Example Request Body:**\n```json\n{\n \"did\": \"did:sov:39TXHazGAYif5FUFCjQhYX\",\n \"payload\": {\n \"credential_subject\": \"reference_to_holder\",\n \"given_name\": \"John\",\n \"family_name\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone_number\": \"+27-123-4567\",\n \"nationalities\": [\"a\",\"b\",\"c\",\"d\"],\n \"address\": {\n \"street_address\": \"123 Main St\",\n \"locality\": \"Anytown\",\n \"region\": \"Anywhere\",\n \"country\": \"ZA\"\n },\n \"birthdate\": \"1940-01-01\"\n },\n \"non_sd_list\": [\n \"given_name\",\n \"address\",\n \"address.street_address\",\n \"nationalities\",\n \"nationalities[1:3]\"\n ]\n}\n```\n\nRequest Body:\n---\n SDJWSCreateRequest:\n `did` (str, optional): The DID to sign the SD-JWS with.\n `verification_method` (str, optional): The verification method (DID with verkey) to use for signing.\n `payload` (dict): The JSON payload to be signed.\n `headers` (dict, optional): Custom headers for the SD-JWS.\n `non_sd_list` (List[str], optional): List of attributes excluded from selective disclosure.\n\nResponse:\n---\n SDJWSCreateResponse:\n `sd_jws` (str): The resulting SD-JWS string concatenated with the necessary disclosures in the format\n `~~~...~`.\n\n**References:**\n\n- [Selective Disclosure JSON Web Token (SD-JWT)\n Specification](https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html)", "operationId": "sign_sd_jws_v1_wallet_sd_jws_sign_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDJWSCreateRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SDJWSCreateRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDJWSCreateResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SDJWSCreateResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } }, - "security": [{ "APIKeyHeader": [] }] + "security": [ + { + "APIKeyHeader": [] + } + ] } }, "/v1/wallet/sd-jws/verify": { "post": { - "tags": ["wallet"], + "tags": [ + "wallet" + ], "summary": "Verify SD-JWS", "description": "Verify a Selective Disclosure JSON Web Signature (SD-JWS).\n---\n\nThis endpoint allows users to verify the authenticity and integrity of a Selective Disclosure\nJSON Web Signature (SD-JWS). It decodes the SD-JWS to retrieve the payload and headers,\nassesses its validity, and processes the disclosures.\n\n**Usage:**\n\n- Submit the SD-JWS string concatenated with the necessary disclosures to this endpoint.\n- The format should be: `~~~...~`.\n- The holder provides the SD-JWS along with the required disclosures based on the verifier's request.\n\n**Notes:**\n\n- Only the disclosures relevant to the verifier's request needs to be provided.\n Other disclosures can remain confidential.\n\n**Example Request Body:**\n```json\n{\n \"sd_jws\": \"~~~...~\"\n}\n```\n\nRequest Body:\n---\n SDJWSVerifyRequest:\n `sd_jws` (str): The concatenated SD-JWS and disclosures to verify and reveal.\n\nResponse:\n---\n SDJWSVerifyResponse:\n `valid` (bool): Indicates whether the SD-JWS is valid.\n `payload` (dict): The decoded payload of the SD-JWS.\n `headers` (dict): The headers extracted from the SD-JWS.\n `kid` (str): The Key ID of the signer.\n `disclosed_attributes` (dict): The selectively disclosed attributes based on the provided disclosures.\n `error` (str, optional): Error message if the SD-JWS verification fails.\n\n**References:**\n\n- [Selective Disclosure JSON Web Token (SD-JWT)\n Specification](https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html)", "operationId": "verify_sd_jws_v1_wallet_sd_jws_verify_post", "requestBody": { - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDJWSVerifyRequest" } } }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SDJWSVerifyRequest" + } + } + }, "required": true }, "responses": { "200": { "description": "Successful Response", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SDJWSVerifyResponse" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/SDJWSVerifyResponse" + } + } + } }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } - } - }, - "security": [{ "APIKeyHeader": [] }] - } - }, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } + } + }, + "security": [ + { + "APIKeyHeader": [] + } + ] + } + }, "/v1/sse/{wallet_id}/{topic}/{field}/{field_id}/{desired_state}": { "get": { - "tags": ["sse"], + "tags": [ + "sse" + ], "summary": "Subscribe To A Wallet Event By Topic, Field, And Desired State", "description": "Subscribe to SSE events wait for a desired state with a field filter.\n---\n***This endpoint can't be called on the swagger UI, as it requires a stream response.***\n\nWait for a desired state to be reached for some event for this wallet and topic,\nfiltering for payloads that contain `field:field_id`.\n\nexample: `/{wallet_id}/credentials/connection_id/some-uuid/done` will stream a credential exchange event on a\nspecific connection with state done.\nThe field and field ID pair must be present in the payload (other than state) for the event to be streamed.\nThe stream will be closed after the event is returned.\n\nParameters:\n-----------\n wallet_id:\n The ID of the wallet subscribing to the events.\n topic:\n The topic to which the wallet is subscribing.\n field:\n The field to which the wallet is subscribing.\n field_id:\n The ID of the field subscribing to the events.\n desired_state:\n The desired state to be reached.\n look_back:\n Number of seconds to look back for events before subscribing.", "operationId": "Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get", - "security": [{ "APIKeyHeader": [] }], + "security": [ + { + "APIKeyHeader": [] + } + ], "parameters": [ - { "name": "wallet_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Wallet Id" } }, - { "name": "topic", "in": "path", "required": true, "schema": { "type": "string", "title": "Topic" } }, - { "name": "field", "in": "path", "required": true, "schema": { "type": "string", "title": "Field" } }, - { "name": "field_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Field Id" } }, + { + "name": "wallet_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Wallet Id" + } + }, + { + "name": "topic", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Topic" + } + }, + { + "name": "field", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Field" + } + }, + { + "name": "field_id", + "in": "path", + "required": true, + "schema": { + "type": "string", + "title": "Field Id" + } + }, { "name": "desired_state", "in": "path", "required": true, - "schema": { "type": "string", "title": "Desired State" } + "schema": { + "type": "string", + "title": "Desired State" + } }, { "name": "look_back", "in": "query", "required": false, "schema": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "description": "Number of seconds to look back for events", "default": 60, "title": "Look Back" @@ -2092,10 +4004,18 @@ } ], "responses": { - "200": { "description": "Successful Response" }, + "200": { + "description": "Successful Response" + }, "422": { "description": "Validation Error", - "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/HTTPValidationError" + } + } + } } } } @@ -2105,143 +4025,347 @@ "schemas": { "AcceptInvitation": { "properties": { - "alias": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" }, - "invitation": { "$ref": "#/components/schemas/ReceiveInvitationRequest" } + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, + "invitation": { + "$ref": "#/components/schemas/ReceiveInvitationRequest" + } }, "type": "object", - "required": ["invitation"], + "required": [ + "invitation" + ], "title": "AcceptInvitation" }, "AcceptOobInvitation": { "properties": { - "alias": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" }, + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, "use_existing_connection": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Use Existing Connection" }, - "invitation": { "$ref": "#/components/schemas/InvitationMessage-Input" } + "invitation": { + "$ref": "#/components/schemas/InvitationMessage-Input" + } }, "type": "object", - "required": ["invitation"], + "required": [ + "invitation" + ], "title": "AcceptOobInvitation" }, "AcceptProofRequest": { "properties": { "save_exchange_record": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Save Exchange Record", "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete." }, - "proof_id": { "type": "string", "title": "Proof Id" }, - "type": { "$ref": "#/components/schemas/ProofRequestType", "default": "indy" }, - "indy_presentation_spec": { "anyOf": [{ "$ref": "#/components/schemas/IndyPresSpec" }, { "type": "null" }] }, - "dif_presentation_spec": { "anyOf": [{ "$ref": "#/components/schemas/DIFPresSpec" }, { "type": "null" }] } + "proof_id": { + "type": "string", + "title": "Proof Id" + }, + "type": { + "$ref": "#/components/schemas/ProofRequestType", + "default": "indy" + }, + "indy_presentation_spec": { + "anyOf": [ + { + "$ref": "#/components/schemas/IndyPresSpec" + }, + { + "type": "null" + } + ] + }, + "dif_presentation_spec": { + "anyOf": [ + { + "$ref": "#/components/schemas/DIFPresSpec" + }, + { + "type": "null" + } + ] + } }, "type": "object", - "required": ["proof_id"], + "required": [ + "proof_id" + ], "title": "AcceptProofRequest" }, "AttachDecorator-Input": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Attachment identifier" }, "byte_count": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Byte Count", "description": "Byte count of data included by reference" }, - "data": { "$ref": "#/components/schemas/AttachDecoratorData-Input" }, + "data": { + "$ref": "#/components/schemas/AttachDecoratorData-Input" + }, "description": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Description", "description": "Human-readable description of content" }, "filename": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Filename", "description": "File name" }, "lastmod_time": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Lastmod Time", "description": "Hint regarding last modification datetime, in ISO-8601 format" }, "mime-type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Mime-Type", "description": "MIME type" } }, "type": "object", - "required": ["data"], + "required": [ + "data" + ], "title": "AttachDecorator", "description": "AttachDecorator" }, "AttachDecorator-Output": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Attachment identifier" }, "byte_count": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Byte Count", "description": "Byte count of data included by reference" }, - "data": { "$ref": "#/components/schemas/AttachDecoratorData-Output" }, + "data": { + "$ref": "#/components/schemas/AttachDecoratorData-Output" + }, "description": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Description", "description": "Human-readable description of content" }, "filename": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Filename", "description": "File name" }, "lastmod_time": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Lastmod Time", "description": "Hint regarding last modification datetime, in ISO-8601 format" }, "mime-type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Mime-Type", "description": "MIME type" } }, "type": "object", - "required": ["data"], + "required": [ + "data" + ], "title": "AttachDecorator", "description": "AttachDecorator" }, "AttachDecoratorData-Input": { "properties": { "base64": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Base64", "description": "Base64-encoded data" }, "json": { - "anyOf": [{ "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "items": { + "type": "object" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Json", "description": "JSON-serialized data" }, "jws": { - "anyOf": [{ "$ref": "#/components/schemas/AttachDecoratorDataJWS-Input" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/AttachDecoratorDataJWS-Input" + }, + { + "type": "null" + } + ], "description": "Detached Java Web Signature" }, "links": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Links", "description": "List of hypertext links to data" }, "sha256": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Sha256", "description": "SHA256 hash (binhex encoded) of content" } @@ -2253,29 +4377,73 @@ "AttachDecoratorData-Output": { "properties": { "base64": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Base64", "description": "Base64-encoded data" }, "json": { - "anyOf": [{ "type": "object" }, { "items": { "type": "object" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "items": { + "type": "object" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Json", "description": "JSON-serialized data" }, "jws": { - "anyOf": [{ "$ref": "#/components/schemas/AttachDecoratorDataJWS-Output" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/AttachDecoratorDataJWS-Output" + }, + { + "type": "null" + } + ], "description": "Detached Java Web Signature" }, "links": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Links", "description": "List of hypertext links to data" }, "sha256": { - "anyOf": [{ "type": "string" }, { "type": "null" }], - "title": "Sha256", - "description": "SHA256 hash (binhex encoded) of content" - } + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Sha256", + "description": "SHA256 hash (binhex encoded) of content" + } }, "type": "object", "title": "AttachDecoratorData", @@ -2283,36 +4451,82 @@ }, "AttachDecoratorData1JWS": { "properties": { - "header": { "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" }, + "header": { + "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" + }, "protected": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Protected", "description": "protected JWS header" }, - "signature": { "type": "string", "title": "Signature", "description": "signature" } + "signature": { + "type": "string", + "title": "Signature", + "description": "signature" + } }, "type": "object", - "required": ["header", "signature"], + "required": [ + "header", + "signature" + ], "title": "AttachDecoratorData1JWS", "description": "AttachDecoratorData1JWS" }, "AttachDecoratorDataJWS-Input": { "properties": { - "header": { "anyOf": [{ "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" }, { "type": "null" }] }, + "header": { + "anyOf": [ + { + "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" + }, + { + "type": "null" + } + ] + }, "protected": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Protected", "description": "protected JWS header" }, "signature": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Signature", "description": "signature" }, "signatures": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/AttachDecoratorData1JWS" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/AttachDecoratorData1JWS" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Signatures", "description": "List of signatures" @@ -2324,21 +4538,51 @@ }, "AttachDecoratorDataJWS-Output": { "properties": { - "header": { "anyOf": [{ "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" }, { "type": "null" }] }, + "header": { + "anyOf": [ + { + "$ref": "#/components/schemas/AttachDecoratorDataJWSHeader" + }, + { + "type": "null" + } + ] + }, "protected": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Protected", "description": "protected JWS header" }, "signature": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Signature", "description": "signature" }, "signatures": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/AttachDecoratorData1JWS" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/AttachDecoratorData1JWS" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Signatures", "description": "List of signatures" @@ -2350,22 +4594,42 @@ }, "AttachDecoratorDataJWSHeader": { "properties": { - "kid": { "type": "string", "title": "Kid", "description": "Key identifier, in W3C did:key or DID URL format" } + "kid": { + "type": "string", + "title": "Kid", + "description": "Key identifier, in W3C did:key or DID URL format" + } }, "type": "object", - "required": ["kid"], + "required": [ + "kid" + ], "title": "AttachDecoratorDataJWSHeader", "description": "AttachDecoratorDataJWSHeader" }, "AttachmentDef": { "properties": { "id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Id", "description": "Attachment identifier" }, "type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Type", "description": "Attachment type" } @@ -2377,7 +4641,17 @@ "AttributeMimeTypesResult": { "properties": { "results": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Results" } }, @@ -2387,13 +4661,83 @@ }, "ClaimFormat": { "properties": { - "di_vc": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Di Vc" }, - "jwt": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Jwt" }, - "jwt_vc": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Jwt Vc" }, - "jwt_vp": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Jwt Vp" }, - "ldp": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Ldp" }, - "ldp_vc": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Ldp Vc" }, - "ldp_vp": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Ldp Vp" } + "di_vc": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Di Vc" + }, + "jwt": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Jwt" + }, + "jwt_vc": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Jwt Vc" + }, + "jwt_vp": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Jwt Vp" + }, + "ldp": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Ldp" + }, + "ldp_vc": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Ldp Vc" + }, + "ldp_vp": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Ldp Vp" + } }, "type": "object", "title": "ClaimFormat", @@ -2402,7 +4746,12 @@ "ClearPendingRevocationsRequest": { "properties": { "revocation_registry_credential_map": { - "additionalProperties": { "items": { "type": "string" }, "type": "array" }, + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, "type": "object", "title": "Revocation Registry Credential Map", "description": "A map of revocation registry IDs to lists of credential revocation IDs for which pending revocations should be cleared. Providing an empty list for a registry ID clears all pending revocations for that ID. An empty dictionary signifies that the action should be applied to clear all pending revocations across all registry IDs.", @@ -2415,51 +4764,218 @@ "ClearPendingRevocationsResult": { "properties": { "revocation_registry_credential_map": { - "additionalProperties": { "items": { "type": "string" }, "type": "array" }, + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, "type": "object", "title": "Revocation Registry Credential Map", "description": "The resulting revocations that are still pending after a clear-pending request has been completed." } }, "type": "object", - "required": ["revocation_registry_credential_map"], + "required": [ + "revocation_registry_credential_map" + ], "title": "ClearPendingRevocationsResult" }, "ConnectToPublicDid": { - "properties": { "public_did": { "type": "string", "title": "Public Did" } }, + "properties": { + "public_did": { + "type": "string", + "title": "Public Did" + } + }, "type": "object", - "required": ["public_did"], + "required": [ + "public_did" + ], "title": "ConnectToPublicDid" }, "Connection": { "properties": { - "alias": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" }, - "connection_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Connection Id" }, + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, + "connection_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Connection Id" + }, "connection_protocol": { - "anyOf": [{ "type": "string", "enum": ["connections/1.0", "didexchange/1.0"] }, { "type": "null" }], + "anyOf": [ + { + "type": "string", + "enum": [ + "connections/1.0", + "didexchange/1.0" + ] + }, + { + "type": "null" + } + ], "title": "Connection Protocol" }, - "created_at": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Created At" }, - "error_msg": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error Msg" }, - "invitation_key": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Invitation Key" }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Created At" + }, + "error_msg": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error Msg" + }, + "invitation_key": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Invitation Key" + }, "invitation_mode": { - "anyOf": [{ "type": "string", "enum": ["once", "multi", "static"] }, { "type": "null" }], + "anyOf": [ + { + "type": "string", + "enum": [ + "once", + "multi", + "static" + ] + }, + { + "type": "null" + } + ], "title": "Invitation Mode" }, - "invitation_msg_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Invitation Msg Id" }, - "my_did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "My Did" }, - "state": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "State" }, - "their_did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Their Did" }, - "their_label": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Their Label" }, - "their_public_did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Their Public Did" }, + "invitation_msg_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Invitation Msg Id" + }, + "my_did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "My Did" + }, + "state": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "State" + }, + "their_did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Their Did" + }, + "their_label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Their Label" + }, + "their_public_did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Their Public Did" + }, "their_role": { "anyOf": [ - { "type": "string", "enum": ["invitee", "requester", "inviter", "responder"] }, - { "type": "null" } + { + "type": "string", + "enum": [ + "invitee", + "requester", + "inviter", + "responder" + ] + }, + { + "type": "null" + } ], "title": "Their Role" }, - "updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Updated At" } + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Updated At" + } }, "type": "object", "title": "Connection" @@ -2467,42 +4983,104 @@ "ConnectionInvitation": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" }, "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", "description": "DID for connection invitation" }, "imageUrl": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Imageurl", "description": "Optional image URL for connection invitation" }, "label": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Label", "description": "Optional label for connection invitation" }, "recipientKeys": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Recipientkeys", "description": "List of recipient keys" }, "routingKeys": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Routingkeys", "description": "List of routing keys" }, "serviceEndpoint": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Serviceendpoint", "description": "Service endpoint at which to reach this agent" } @@ -2514,23 +5092,87 @@ "Constraints": { "properties": { "fields": { - "anyOf": [{ "items": { "$ref": "#/components/schemas/DIFField" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/DIFField" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Fields" }, "is_holder": { - "anyOf": [{ "items": { "$ref": "#/components/schemas/DIFHolder" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/DIFHolder" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Is Holder" }, "limit_disclosure": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Limit Disclosure", "description": "LimitDisclosure" }, - "status_active": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Active" }, - "status_revoked": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Revoked" }, - "status_suspended": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Status Suspended" }, + "status_active": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Status Active" + }, + "status_revoked": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Status Revoked" + }, + "status_suspended": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Status Suspended" + }, "subject_is_issuer": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Subject Is Issuer", "description": "SubjectIsIssuer" } @@ -2544,20 +5186,53 @@ "schema_id": { "type": "string", "title": "Schema Id", - "examples": ["CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3"] + "examples": [ + "CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3" + ] }, - "tag": { "type": "string", "title": "Tag", "examples": ["default"] }, - "support_revocation": { "type": "boolean", "title": "Support Revocation", "default": false } + "tag": { + "type": "string", + "title": "Tag", + "examples": [ + "default" + ] + }, + "support_revocation": { + "type": "boolean", + "title": "Support Revocation", + "default": false + } }, "type": "object", - "required": ["schema_id", "tag"], + "required": [ + "schema_id", + "tag" + ], "title": "CreateCredentialDefinition" }, "CreateInvitation": { "properties": { - "alias": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" }, - "multi_use": { "type": "boolean", "title": "Multi Use", "default": false }, - "use_public_did": { "type": "boolean", "title": "Use Public Did", "default": false } + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, + "multi_use": { + "type": "boolean", + "title": "Multi Use", + "default": false + }, + "use_public_did": { + "type": "boolean", + "title": "Use Public Did", + "default": false + } }, "type": "object", "title": "CreateInvitation" @@ -2565,32 +5240,105 @@ "CreateOffer": { "properties": { "save_exchange_record": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Save Exchange Record", "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete." }, - "type": { "$ref": "#/components/schemas/CredentialType", "default": "indy" }, + "type": { + "$ref": "#/components/schemas/CredentialType", + "default": "indy" + }, "indy_credential_detail": { - "anyOf": [{ "$ref": "#/components/schemas/IndyCredential" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyCredential" + }, + { + "type": "null" + } + ] }, - "ld_credential_detail": { "anyOf": [{ "$ref": "#/components/schemas/LDProofVCDetail" }, { "type": "null" }] } + "ld_credential_detail": { + "anyOf": [ + { + "$ref": "#/components/schemas/LDProofVCDetail" + }, + { + "type": "null" + } + ] + } }, "type": "object", "title": "CreateOffer" }, "CreateOobInvitation": { "properties": { - "alias": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alias" }, - "multi_use": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Multi Use" }, - "use_public_did": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Use Public Did" }, + "alias": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alias" + }, + "multi_use": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Multi Use" + }, + "use_public_did": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Use Public Did" + }, "attachments": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/AttachmentDef" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/AttachmentDef" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Attachments" }, - "create_connection": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Create Connection" } + "create_connection": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Create Connection" + } }, "type": "object", "title": "CreateOobInvitation" @@ -2598,41 +5346,107 @@ "CreateProofRequest": { "properties": { "save_exchange_record": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Save Exchange Record", "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete." }, - "comment": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Comment" }, - "type": { "$ref": "#/components/schemas/ProofRequestType", "default": "indy" }, + "comment": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Comment" + }, + "type": { + "$ref": "#/components/schemas/ProofRequestType", + "default": "indy" + }, "indy_proof_request": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequest-Input" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest-Input" + }, + { + "type": "null" + } + ] }, - "dif_proof_request": { "anyOf": [{ "$ref": "#/components/schemas/DIFProofRequest" }, { "type": "null" }] } + "dif_proof_request": { + "anyOf": [ + { + "$ref": "#/components/schemas/DIFProofRequest" + }, + { + "type": "null" + } + ] + } }, "type": "object", "title": "CreateProofRequest" }, "CreateSchema": { "properties": { - "name": { "type": "string", "title": "Name", "examples": ["test_schema"] }, - "version": { "type": "string", "title": "Version", "examples": ["0.3.0"] }, + "name": { + "type": "string", + "title": "Name", + "examples": [ + "test_schema" + ] + }, + "version": { + "type": "string", + "title": "Version", + "examples": [ + "0.3" + ] + }, "attribute_names": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Attribute Names", - "examples": [["name", "age"]] + "examples": [ + [ + "name", + "age" + ] + ] } }, "type": "object", - "required": ["name", "version", "attribute_names"], + "required": [ + "name", + "version", + "attribute_names" + ], "title": "CreateSchema" }, "CredInfoList": { "properties": { "results": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/app__models__wallet__IndyCredInfo" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/app__models__wallet__IndyCredInfo" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Results" } @@ -2643,7 +5457,14 @@ "CredRevokedResult": { "properties": { "revoked": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Revoked", "description": "Whether credential is revoked on the ledger" } @@ -2655,78 +5476,236 @@ "Credential": { "properties": { "@context": { - "items": { "anyOf": [{ "type": "string" }, { "type": "object" }] }, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, "type": "array", "title": "@Context", "description": "The JSON-LD context of the credential" }, - "credentialStatus": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Credentialstatus" }, - "credentialSubject": { "type": "object", "title": "Credentialsubject" }, + "credentialStatus": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Credentialstatus" + }, + "credentialSubject": { + "type": "object", + "title": "Credentialsubject" + }, "expirationDate": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Expirationdate", "description": "The expiration date" }, "id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Id", "description": "The ID of the credential" }, - "issuanceDate": { "type": "string", "title": "Issuancedate", "description": "The issuance date" }, + "issuanceDate": { + "type": "string", + "title": "Issuancedate", + "description": "The issuance date" + }, "issuer": { - "anyOf": [{ "type": "string" }, { "type": "object" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ], "title": "Issuer", "description": "The JSON-LD Verifiable Credential Issuer. Either string of object with id field." }, "proof": { - "anyOf": [{ "$ref": "#/components/schemas/LinkedDataProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/LinkedDataProof" + }, + { + "type": "null" + } + ], "description": "The proof of the credential" }, "type": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Type", "description": "The JSON-LD type of the credential" }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", - "required": ["@context", "credentialSubject", "issuanceDate", "issuer", "type"], + "required": [ + "@context", + "credentialSubject", + "issuanceDate", + "issuer", + "type" + ], "title": "Credential", "description": "Credential" }, "CredentialDefinition": { "properties": { - "id": { "type": "string", "title": "Id", "examples": ["5Q1Zz9foMeAA8Q7mrmzCfZ:3:CL:7:default"] }, - "tag": { "type": "string", "title": "Tag", "examples": ["default"] }, + "id": { + "type": "string", + "title": "Id", + "examples": [ + "5Q1Zz9foMeAA8Q7mrmzCfZ:3:CL:7:default" + ] + }, + "tag": { + "type": "string", + "title": "Tag", + "examples": [ + "default" + ] + }, "schema_id": { "type": "string", "title": "Schema Id", - "examples": ["CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3"] + "examples": [ + "CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3" + ] } }, "type": "object", - "required": ["id", "tag", "schema_id"], + "required": [ + "id", + "tag", + "schema_id" + ], "title": "CredentialDefinition" }, "CredentialExchange": { "properties": { "attributes": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Attributes" }, - "connection_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Connection Id" }, - "created_at": { "type": "string", "title": "Created At" }, + "connection_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Connection Id" + }, + "created_at": { + "type": "string", + "title": "Created At" + }, "credential_definition_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Credential Definition Id" }, - "credential_id": { "type": "string", "title": "Credential Id", "deprecated": true }, - "credential_exchange_id": { "type": "string", "title": "Credential Exchange Id" }, - "did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Did" }, - "error_msg": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error Msg" }, - "role": { "type": "string", "enum": ["issuer", "holder"], "title": "Role" }, - "schema_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Schema Id" }, + "credential_id": { + "type": "string", + "title": "Credential Id", + "deprecated": true + }, + "credential_exchange_id": { + "type": "string", + "title": "Credential Exchange Id" + }, + "did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Did" + }, + "error_msg": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error Msg" + }, + "role": { + "type": "string", + "enum": [ + "issuer", + "holder" + ], + "title": "Role" + }, + "schema_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Schema Id" + }, "state": { "anyOf": [ { @@ -2746,32 +5725,87 @@ "deleted" ] }, - { "type": "null" } + { + "type": "null" + } ], "title": "State" }, - "thread_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Thread Id" }, - "type": { "type": "string", "title": "Type", "default": "indy" }, - "updated_at": { "type": "string", "title": "Updated At" } + "thread_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Thread Id" + }, + "type": { + "type": "string", + "title": "Type", + "default": "indy" + }, + "updated_at": { + "type": "string", + "title": "Updated At" + } }, "type": "object", - "required": ["created_at", "credential_id", "credential_exchange_id", "role", "updated_at"], + "required": [ + "created_at", + "credential_id", + "credential_exchange_id", + "role", + "updated_at" + ], "title": "CredentialExchange" }, "CredentialSchema": { "properties": { - "id": { "type": "string", "title": "Id", "examples": ["CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3"] }, - "name": { "type": "string", "title": "Name", "examples": ["test_schema"] }, - "version": { "type": "string", "title": "Version", "examples": ["0.3.0"] }, + "id": { + "type": "string", + "title": "Id", + "examples": [ + "CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3" + ] + }, + "name": { + "type": "string", + "title": "Name", + "examples": [ + "test_schema" + ] + }, + "version": { + "type": "string", + "title": "Version", + "examples": [ + "0.3" + ] + }, "attribute_names": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Attribute Names", - "examples": [["name", "age"]] + "examples": [ + [ + "name", + "age" + ] + ] } }, "type": "object", - "required": ["id", "name", "version", "attribute_names"], + "required": [ + "id", + "name", + "version", + "attribute_names" + ], "title": "CredentialSchema" }, "CredentialStatusOptions": { @@ -2781,76 +5815,176 @@ "title": "Type", "description": "Credential status method type to use for the credential. Should match status method registered in the Verifiable Credential Extension Registry" }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", - "required": ["type"], + "required": [ + "type" + ], "title": "CredentialStatusOptions", "description": "CredentialStatusOptions" }, - "CredentialType": { "type": "string", "enum": ["indy", "jwt", "ld_proof"], "title": "CredentialType" }, + "CredentialType": { + "type": "string", + "enum": [ + "indy", + "jwt", + "ld_proof" + ], + "title": "CredentialType" + }, "DID": { "properties": { - "did": { "type": "string", "title": "Did", "description": "DID of interest" }, + "did": { + "type": "string", + "title": "Did", + "description": "DID of interest" + }, "key_type": { "type": "string", - "enum": ["ed25519", "x25519", "bls12381g1", "bls12381g2", "bls12381g1g2"], + "enum": [ + "ed25519", + "x25519", + "bls12381g1", + "bls12381g2", + "bls12381g1g2" + ], "title": "Key Type", "description": "Key type associated with the DID" }, "metadata": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Metadata", "description": "Additional metadata associated with the DID" }, "method": { "type": "string", - "enum": ["sov", "key", "web", "did:peer:2", "did:peer:4"], + "enum": [ + "sov", + "key", + "web", + "did:peer:2", + "did:peer:4" + ], "title": "Method", "description": "Did method associated with the DID" }, "posture": { "type": "string", - "enum": ["public", "posted", "wallet_only"], + "enum": [ + "public", + "posted", + "wallet_only" + ], "title": "Posture", "description": "Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet" }, - "verkey": { "type": "string", "title": "Verkey", "description": "Public verification key" } + "verkey": { + "type": "string", + "title": "Verkey", + "description": "Public verification key" + } }, "type": "object", - "required": ["did", "key_type", "method", "posture", "verkey"], + "required": [ + "did", + "key_type", + "method", + "posture", + "verkey" + ], "title": "DID", "description": "DID" }, "DIDCreate": { "properties": { "method": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Method", "description": "Method for the requested DID. Supported methods are 'sov', 'key', 'web', 'did:peer:2', or 'did:peer:4'.", "default": "sov", - "examples": ["sov", "key", "web", "did:peer:2", "did:peer:4"] + "examples": [ + "sov", + "key", + "web", + "did:peer:2", + "did:peer:4" + ] }, "options": { - "anyOf": [{ "$ref": "#/components/schemas/DIDCreateOptions" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/DIDCreateOptions" + }, + { + "type": "null" + } + ], "description": "(Deprecated) Define a key type and/or a DID depending on the chosen DID method.", "deprecated": true, - "examples": [{ "did": "did:peer:2...", "key_type": "ed25519" }] + "examples": [ + { + "did": "did:peer:2...", + "key_type": "ed25519" + } + ] }, "seed": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Seed", "description": "Optional seed to use for DID. Must be enabled in configuration before use." }, "key_type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Key Type", "description": "Key type to use for the DID key_pair. Validated with the chosen DID method's supported key types.", "default": "ed25519", - "examples": ["ed25519", "bls12381g2"] + "examples": [ + "ed25519", + "bls12381g2" + ] }, "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", "description": "Specify the final value of DID (including `did::` prefix) if the method supports it." } @@ -2862,7 +5996,14 @@ "DIDCreateOptions": { "properties": { "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", "description": "Specify final value of the did (including did:: prefix)if the method supports or requires so." }, @@ -2873,28 +6014,50 @@ } }, "type": "object", - "required": ["key_type"], + "required": [ + "key_type" + ], "title": "DIDCreateOptions", "description": "DIDCreateOptions" }, "DIDEndpoint": { "properties": { - "did": { "type": "string", "title": "Did", "description": "DID of interest" }, + "did": { + "type": "string", + "title": "Did", + "description": "DID of interest" + }, "endpoint": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Endpoint", "description": "Endpoint to set (omit to delete)" } }, "type": "object", - "required": ["did"], + "required": [ + "did" + ], "title": "DIDEndpoint", "description": "DIDEndpoint" }, "DIDXRejectRequest": { "properties": { "reason": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Reason", "description": "Reason for rejecting the DID Exchange" } @@ -2905,19 +6068,63 @@ }, "DIFField": { "properties": { - "filter": { "anyOf": [{ "$ref": "#/components/schemas/Filter" }, { "type": "null" }] }, - "id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Id", "description": "ID" }, + "filter": { + "anyOf": [ + { + "$ref": "#/components/schemas/Filter" + }, + { + "type": "null" + } + ] + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id", + "description": "ID" + }, "path": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Path" }, "predicate": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Predicate", "description": "Preference" }, "purpose": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Purpose", "description": "Purpose" } @@ -2929,12 +6136,29 @@ "DIFHolder": { "properties": { "directive": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Directive", "description": "Preference" }, "field_id": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Field Id" } }, @@ -2945,12 +6169,26 @@ "DIFOptions": { "properties": { "challenge": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Challenge", "description": "Challenge protect against replay attack" }, "domain": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Domain", "description": "Domain protect against replay attack" } @@ -2962,20 +6200,48 @@ "DIFPresSpec": { "properties": { "issuer_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Issuer Id", "description": "Issuer identifier to sign the presentation, if different from current public DID" }, "presentation_definition": { - "anyOf": [{ "$ref": "#/components/schemas/PresentationDefinition" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/PresentationDefinition" + }, + { + "type": "null" + } + ] }, "record_ids": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Record Ids", "description": "Mapping of input_descriptor id to list of stored W3C credential record_id" }, "reveal_doc": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Reveal Doc", "description": "reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required" } @@ -2986,70 +6252,220 @@ }, "DIFProofRequest": { "properties": { - "options": { "anyOf": [{ "$ref": "#/components/schemas/DIFOptions" }, { "type": "null" }] }, - "presentation_definition": { "$ref": "#/components/schemas/PresentationDefinition" }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "options": { + "anyOf": [ + { + "$ref": "#/components/schemas/DIFOptions" + }, + { + "type": "null" + } + ] + }, + "presentation_definition": { + "$ref": "#/components/schemas/PresentationDefinition" + }, + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", - "required": ["presentation_definition"], + "required": [ + "presentation_definition" + ], "title": "DIFProofRequest", "description": "DIFProofRequest" }, "Filter": { "properties": { "const": { - "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Const", "description": "Const" }, "enum": { "anyOf": [ { - "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }] }, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + } + ] + }, "type": "array" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Enum" }, "exclusiveMaximum": { - "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Exclusivemaximum", "description": "ExclusiveMaximum" }, "exclusiveMinimum": { - "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Exclusiveminimum", "description": "ExclusiveMinimum" }, - "format": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Format", "description": "Format" }, + "format": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Format", + "description": "Format" + }, "maxLength": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Maxlength", "description": "Max Length" }, "maximum": { - "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Maximum", "description": "Maximum" }, "minLength": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Minlength", "description": "Min Length" }, "minimum": { - "anyOf": [{ "type": "string" }, { "type": "integer" }, { "type": "number" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + }, + { + "type": "number" + }, + { + "type": "null" + } + ], "title": "Minimum", "description": "Minimum" }, - "not": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Not", "description": "Not" }, + "not": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Not", + "description": "Not" + }, "pattern": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Pattern", "description": "Pattern" }, - "type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Type", "description": "Type" } + "type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Type", + "description": "Type" + } }, "type": "object", "title": "Filter", @@ -3057,7 +6473,13 @@ }, "HTTPValidationError": { "properties": { - "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } + "detail": { + "items": { + "$ref": "#/components/schemas/ValidationError" + }, + "type": "array", + "title": "Detail" + } }, "type": "object", "title": "HTTPValidationError" @@ -3065,12 +6487,26 @@ "Hangup": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" } @@ -3086,42 +6522,133 @@ "description": "Credential info" }, "interval": { - "anyOf": [{ "$ref": "#/components/schemas/IndyNonRevocationInterval" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyNonRevocationInterval" + }, + { + "type": "null" + } + ], "description": "Non-revocation interval from presentation request" }, "presentation_referents": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Presentation Referents" } }, "type": "object", - "required": ["cred_info"], + "required": [ + "cred_info" + ], "title": "IndyCredPrecis", "description": "IndyCredPrecis" }, "IndyCredential": { "properties": { - "credential_definition_id": { "type": "string", "title": "Credential Definition Id" }, - "attributes": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Attributes" } + "credential_definition_id": { + "type": "string", + "title": "Credential Definition Id" + }, + "attributes": { + "additionalProperties": { + "type": "string" + }, + "type": "object", + "title": "Attributes" + } }, "type": "object", - "required": ["credential_definition_id", "attributes"], + "required": [ + "credential_definition_id", + "attributes" + ], "title": "IndyCredential" }, "IndyEQProof": { "properties": { - "a_prime": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "A Prime" }, - "e": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "E" }, + "a_prime": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "A Prime" + }, + "e": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "E" + }, "m": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "M" }, - "m2": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "M2" }, + "m2": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "M2" + }, "revealed_attrs": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Revealed Attrs" }, - "v": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "V" } + "v": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "V" + } }, "type": "object", "title": "IndyEQProof", @@ -3129,19 +6656,78 @@ }, "IndyGEProof": { "properties": { - "alpha": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Alpha" }, - "mj": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Mj" }, - "predicate": { "anyOf": [{ "$ref": "#/components/schemas/IndyGEProofPred" }, { "type": "null" }] }, + "alpha": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Alpha" + }, + "mj": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Mj" + }, + "predicate": { + "anyOf": [ + { + "$ref": "#/components/schemas/IndyGEProofPred" + }, + { + "type": "null" + } + ] + }, "r": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "R" }, "t": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "T" }, "u": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "U" } }, @@ -3152,17 +6738,38 @@ "IndyGEProofPred": { "properties": { "attr_name": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Attr Name", "description": "Attribute name, indy-canonicalized" }, "p_type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "P Type", "description": "Predicate type" }, "value": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Value", "description": "Predicate threshold value" } @@ -3174,11 +6781,31 @@ "IndyNonRevocProof": { "properties": { "c_list": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "C List" }, "x_list": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "X List" } }, @@ -3189,12 +6816,30 @@ "IndyNonRevocationInterval": { "properties": { "from": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "From", "description": "Earliest time of interest in non-revocation interval" }, "to": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "To", "description": "Latest time of interest in non-revocation interval" } @@ -3206,42 +6851,76 @@ "IndyPresSpec": { "properties": { "requested_attributes": { - "additionalProperties": { "$ref": "#/components/schemas/IndyRequestedCredsRequestedAttr" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyRequestedCredsRequestedAttr" + }, "type": "object", "title": "Requested Attributes", "description": "Nested object mapping proof request attribute referents to requested-attribute specifiers" }, "requested_predicates": { - "additionalProperties": { "$ref": "#/components/schemas/IndyRequestedCredsRequestedPred" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyRequestedCredsRequestedPred" + }, "type": "object", "title": "Requested Predicates", "description": "Nested object mapping proof request predicate referents to requested-predicate specifiers" }, "self_attested_attributes": { - "additionalProperties": { "type": "string" }, + "additionalProperties": { + "type": "string" + }, "type": "object", "title": "Self Attested Attributes", "description": "Self-attested attributes to build into proof" }, "trace": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Trace", "description": "Whether to trace event (default false)" } }, "type": "object", - "required": ["requested_attributes", "requested_predicates", "self_attested_attributes"], + "required": [ + "requested_attributes", + "requested_predicates", + "self_attested_attributes" + ], "title": "IndyPresSpec", "description": "IndyPresSpec" }, "IndyPrimaryProof": { "properties": { "eq_proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyEQProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyEQProof" + }, + { + "type": "null" + } + ], "description": "Indy equality proof" }, "ge_proofs": { - "anyOf": [{ "items": { "$ref": "#/components/schemas/IndyGEProof" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/IndyGEProof" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Ge Proofs", "description": "Indy GE proofs" } @@ -3254,18 +6933,39 @@ "properties": { "identifiers": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/IndyProofIdentifier" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/IndyProofIdentifier" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Identifiers", "description": "Indy proof.identifiers content" }, "proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofProof" + }, + { + "type": "null" + } + ], "description": "Indy proof.proof content" }, "requested_proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequestedProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequestedProof" + }, + { + "type": "null" + } + ], "description": "Indy proof.requested_proof content" } }, @@ -3276,22 +6976,52 @@ "IndyProofIdentifier": { "properties": { "cred_def_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Def Id", "description": "Credential definition identifier" }, "rev_reg_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Rev Reg Id", "description": "Revocation registry identifier" }, "schema_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Schema Id", "description": "Schema identifier" }, "timestamp": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "Timestamp", "description": "Timestamp epoch" } @@ -3303,13 +7033,27 @@ "IndyProofProof": { "properties": { "aggregated_proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofProofAggregatedProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofProofAggregatedProof" + }, + { + "type": "null" + } + ], "description": "Indy proof aggregated proof" }, "proofs": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/IndyProofProofProofsProof" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/IndyProofProofProofsProof" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Proofs", "description": "Indy proof proofs" @@ -3322,14 +7066,31 @@ "IndyProofProofAggregatedProof": { "properties": { "c_hash": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "C Hash", "description": "c_hash value" }, "c_list": { "anyOf": [ - { "items": { "items": { "type": "integer" }, "type": "array" }, "type": "array" }, - { "type": "null" } + { + "items": { + "items": { + "type": "integer" + }, + "type": "array" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "C List", "description": "c_list value" @@ -3342,11 +7103,25 @@ "IndyProofProofProofsProof": { "properties": { "non_revoc_proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyNonRevocProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyNonRevocProof" + }, + { + "type": "null" + } + ], "description": "Indy non-revocation proof" }, "primary_proof": { - "anyOf": [{ "$ref": "#/components/schemas/IndyPrimaryProof" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/IndyPrimaryProof" + }, + { + "type": "null" + } + ], "description": "Indy primary proof" } }, @@ -3357,22 +7132,56 @@ "IndyProofReqAttrSpec": { "properties": { "name": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Attribute name" }, "names": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Names", "description": "Attribute name group" }, "non_revoked": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofReqAttrSpecNonRevoked" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofReqAttrSpecNonRevoked" + }, + { + "type": "null" + } + ] }, "restrictions": { "anyOf": [ - { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, - { "type": "null" } + { + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "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" @@ -3385,12 +7194,30 @@ "IndyProofReqAttrSpecNonRevoked": { "properties": { "from": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "From", "description": "Earliest time of interest in non-revocation interval" }, "to": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "To", "description": "Latest time of interest in non-revocation interval" } @@ -3401,35 +7228,86 @@ }, "IndyProofReqPredSpec": { "properties": { - "name": { "type": "string", "title": "Name", "description": "Attribute name" }, + "name": { + "type": "string", + "title": "Name", + "description": "Attribute name" + }, "non_revoked": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofReqPredSpecNonRevoked" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofReqPredSpecNonRevoked" + }, + { + "type": "null" + } + ] + }, + "p_type": { + "type": "string", + "title": "P Type", + "description": "Predicate type ('<', '<=', '>=', or '>')" + }, + "p_value": { + "type": "integer", + "title": "P Value", + "description": "Threshold value" }, - "p_type": { "type": "string", "title": "P Type", "description": "Predicate type ('<', '<=', '>=', or '>')" }, - "p_value": { "type": "integer", "title": "P Value", "description": "Threshold value" }, "restrictions": { "anyOf": [ - { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array" }, - { "type": "null" } + { + "items": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "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" } }, "type": "object", - "required": ["name", "p_type", "p_value"], + "required": [ + "name", + "p_type", + "p_value" + ], "title": "IndyProofReqPredSpec", "description": "IndyProofReqPredSpec" }, "IndyProofReqPredSpecNonRevoked": { "properties": { "from": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "From", "description": "Earliest time of interest in non-revocation interval" }, "to": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "To", "description": "Latest time of interest in non-revocation interval" } @@ -3440,72 +7318,164 @@ }, "IndyProofRequest-Input": { "properties": { - "name": { "type": "string", "title": "Name", "description": "Proof request name", "default": "Proof" }, + "name": { + "type": "string", + "title": "Name", + "description": "Proof request name", + "default": "Proof" + }, "non_revoked": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequestNonRevoked" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequestNonRevoked" + }, + { + "type": "null" + } + ] + }, + "nonce": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nonce", + "description": "Nonce" }, - "nonce": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Nonce", "description": "Nonce" }, "requested_attributes": { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofReqAttrSpec" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofReqAttrSpec" + }, "type": "object", "title": "Requested Attributes", "description": "Requested attribute specifications of proof request" }, "requested_predicates": { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofReqPredSpec" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofReqPredSpec" + }, "type": "object", "title": "Requested Predicates", "description": "Requested predicate specifications of proof request" }, - "version": { "type": "string", "title": "Version", "description": "Proof request version", "default": "1.0" } + "version": { + "type": "string", + "title": "Version", + "description": "Proof request version", + "default": "1.0" + } }, "type": "object", - "required": ["requested_attributes", "requested_predicates"], + "required": [ + "requested_attributes", + "requested_predicates" + ], "title": "IndyProofRequest" }, "IndyProofRequest-Output": { "properties": { "name": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Proof request name" }, "non_revoked": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequestNonRevoked" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequestNonRevoked" + }, + { + "type": "null" + } + ] + }, + "nonce": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Nonce", + "description": "Nonce" }, - "nonce": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Nonce", "description": "Nonce" }, "requested_attributes": { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofReqAttrSpec" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofReqAttrSpec" + }, "type": "object", "title": "Requested Attributes", "description": "Requested attribute specifications of proof request" }, "requested_predicates": { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofReqPredSpec" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofReqPredSpec" + }, "type": "object", "title": "Requested Predicates", "description": "Requested predicate specifications of proof request" }, "version": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Version", "description": "Proof request version" } }, "type": "object", - "required": ["requested_attributes", "requested_predicates"], + "required": [ + "requested_attributes", + "requested_predicates" + ], "title": "IndyProofRequest", "description": "IndyProofRequest" }, "IndyProofRequestNonRevoked": { "properties": { "from": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "From", "description": "Earliest time of interest in non-revocation interval" }, "to": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "To", "description": "Latest time of interest in non-revocation interval" } @@ -3519,10 +7489,14 @@ "predicates": { "anyOf": [ { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofRequestedProofPredicate" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofRequestedProofPredicate" + }, "type": "object" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Predicates", "description": "Proof requested proof predicates." @@ -3530,10 +7504,14 @@ "revealed_attr_groups": { "anyOf": [ { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttrGroup" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttrGroup" + }, "type": "object" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Revealed Attr Groups", "description": "Proof requested proof revealed attribute groups" @@ -3541,21 +7519,39 @@ "revealed_attrs": { "anyOf": [ { - "additionalProperties": { "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttr" }, + "additionalProperties": { + "$ref": "#/components/schemas/IndyProofRequestedProofRevealedAttr" + }, "type": "object" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Revealed Attrs", "description": "Proof requested proof revealed attributes" }, "self_attested_attrs": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Self Attested Attrs", "description": "Proof requested proof self-attested attributes" }, "unrevealed_attrs": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Unrevealed Attrs", "description": "Unrevealed attributes" } @@ -3567,7 +7563,14 @@ "IndyProofRequestedProofPredicate": { "properties": { "sub_proof_index": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Sub Proof Index", "description": "Sub-proof index" } @@ -3579,13 +7582,38 @@ "IndyProofRequestedProofRevealedAttr": { "properties": { "encoded": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Encoded", "description": "Encoded value" }, - "raw": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Raw", "description": "Raw value" }, + "raw": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Raw", + "description": "Raw value" + }, "sub_proof_index": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Sub Proof Index", "description": "Sub-proof index" } @@ -3597,14 +7625,28 @@ "IndyProofRequestedProofRevealedAttrGroup": { "properties": { "sub_proof_index": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Sub Proof Index", "description": "Sub-proof index" }, "values": { "anyOf": [ - { "additionalProperties": { "$ref": "#/components/schemas/RawEncoded" }, "type": "object" }, - { "type": "null" } + { + "additionalProperties": { + "$ref": "#/components/schemas/RawEncoded" + }, + "type": "object" + }, + { + "type": "null" + } ], "title": "Values", "description": "Indy proof requested proof revealed attr groups group value" @@ -3622,13 +7664,22 @@ "description": "Wallet credential identifier (typically but not necessarily a UUID)" }, "revealed": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Revealed", "description": "Whether to reveal attribute in proof (default true)" } }, "type": "object", - "required": ["cred_id"], + "required": [ + "cred_id" + ], "title": "IndyRequestedCredsRequestedAttr", "description": "IndyRequestedCredsRequestedAttr" }, @@ -3640,37 +7691,110 @@ "description": "Wallet credential identifier (typically but not necessarily a UUID)" }, "timestamp": { - "anyOf": [{ "type": "integer", "maximum": 1.8446744073709552e19, "minimum": 0.0 }, { "type": "null" }], + "anyOf": [ + { + "type": "integer", + "maximum": 18446744073709552000, + "minimum": 0 + }, + { + "type": "null" + } + ], "title": "Timestamp", "description": "Epoch timestamp of interest for non-revocation proof" } }, "type": "object", - "required": ["cred_id"], + "required": [ + "cred_id" + ], "title": "IndyRequestedCredsRequestedPred", "description": "IndyRequestedCredsRequestedPred" }, "InputDescriptors": { "properties": { - "constraints": { "anyOf": [{ "$ref": "#/components/schemas/Constraints" }, { "type": "null" }] }, + "constraints": { + "anyOf": [ + { + "$ref": "#/components/schemas/Constraints" + }, + { + "type": "null" + } + ] + }, "group": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Group" }, - "id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Id", "description": "ID" }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Id", + "description": "ID" + }, "metadata": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Metadata", "description": "Metadata dictionary" }, - "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name" }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name" + }, "purpose": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Purpose", "description": "Purpose" }, "schema": { - "anyOf": [{ "$ref": "#/components/schemas/SchemasInputDescriptorFilter" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/SchemasInputDescriptorFilter" + }, + { + "type": "null" + } + ], "description": "Accepts a list of schema or a dict containing filters like oneof_filter." } }, @@ -3681,56 +7805,139 @@ "InvitationMessage-Input": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" }, "accept": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Accept", "description": "List of mime type in order of preference" }, "goal": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Goal", "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message" }, "goal_code": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Goal Code", "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message" }, "handshake_protocols": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Handshake Protocols" }, "imageUrl": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Imageurl", "description": "Optional image URL for out-of-band invitation" }, "label": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Label", "description": "Optional label" }, "requests~attach": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/AttachDecorator-Input" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/AttachDecorator-Input" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Requests~Attach", "description": "Optional request attachment" }, "services": { "anyOf": [ - { "items": { "anyOf": [{ "type": "string" }, { "type": "object" }] }, "type": "array" }, - { "type": "null" } + { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Services" } @@ -3742,56 +7949,139 @@ "InvitationMessage-Output": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" }, "accept": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Accept", "description": "List of mime type in order of preference" }, "goal": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Goal", "description": "A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message" }, "goal_code": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Goal Code", "description": "A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message" }, "handshake_protocols": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Handshake Protocols" }, "imageUrl": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Imageurl", "description": "Optional image URL for out-of-band invitation" }, "label": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Label", "description": "Optional label" }, "requests~attach": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/AttachDecorator-Output" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/AttachDecorator-Output" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Requests~Attach", "description": "Optional request attachment" }, "services": { "anyOf": [ - { "items": { "anyOf": [{ "type": "string" }, { "type": "object" }] }, "type": "array" }, - { "type": "null" } + { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Services" } @@ -3803,46 +8093,109 @@ "InvitationRecord": { "properties": { "created_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Time of record creation" }, "invi_msg_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Invi Msg Id", "description": "Invitation message identifier" }, "invitation": { - "anyOf": [{ "$ref": "#/components/schemas/InvitationMessage-Output" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/InvitationMessage-Output" + }, + { + "type": "null" + } + ], "description": "Out of band invitation message" }, "invitation_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Invitation Id", "description": "Invitation record identifier" }, "invitation_url": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Invitation Url", "description": "Invitation message URL" }, "oob_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Oob Id", "description": "Out of band record identifier" }, "state": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "State", "description": "Out of band message exchange state" }, "trace": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Trace", "description": "Record trace information, based on agent configuration" }, "updated_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Time of last record update" } @@ -3853,59 +8206,136 @@ }, "InvitationResult": { "properties": { - "connection_id": { "type": "string", "title": "Connection Id", "description": "Connection identifier" }, - "invitation": { "$ref": "#/components/schemas/ConnectionInvitation" }, - "invitation_url": { "type": "string", "title": "Invitation Url", "description": "Invitation URL" } + "connection_id": { + "type": "string", + "title": "Connection Id", + "description": "Connection identifier" + }, + "invitation": { + "$ref": "#/components/schemas/ConnectionInvitation" + }, + "invitation_url": { + "type": "string", + "title": "Invitation Url", + "description": "Invitation URL" + } }, "type": "object", - "required": ["connection_id", "invitation", "invitation_url"], + "required": [ + "connection_id", + "invitation", + "invitation_url" + ], "title": "InvitationResult", "description": "InvitationResult" }, "IssuerCredRevRecord": { "properties": { "created_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Time of record creation" }, "cred_def_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Def Id", "description": "Credential definition identifier" }, "cred_ex_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Ex Id", "description": "Credential exchange record identifier at credential issue" }, "cred_ex_version": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Ex Version", "description": "Credential exchange version" }, "cred_rev_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Rev Id", "description": "Credential revocation identifier" }, "record_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Record Id", "description": "Issuer credential revocation record identifier" }, "rev_reg_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Rev Reg Id", "description": "Revocation registry identifier" }, "state": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "State", "description": "Issue credential revocation record state" }, "updated_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Time of last record update" } @@ -3917,14 +8347,38 @@ "JWSCreateRequest": { "properties": { "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", - "examples": ["did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq"] + "examples": [ + "did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq" + ] + }, + "headers": { + "type": "object", + "title": "Headers", + "default": {} + }, + "payload": { + "type": "object", + "title": "Payload", + "description": "Payload to sign" }, - "headers": { "type": "object", "title": "Headers", "default": {} }, - "payload": { "type": "object", "title": "Payload", "description": "Payload to sign" }, "verification_method": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Verification Method", "description": "Information used for proof verification", "examples": [ @@ -3933,7 +8387,9 @@ } }, "type": "object", - "required": ["payload"], + "required": [ + "payload" + ], "title": "JWSCreateRequest" }, "JWSCreateResponse": { @@ -3947,7 +8403,9 @@ } }, "type": "object", - "required": ["jws"], + "required": [ + "jws" + ], "title": "JWSCreateResponse" }, "JWSVerifyRequest": { @@ -3961,13 +8419,22 @@ } }, "type": "object", - "required": ["jws"], + "required": [ + "jws" + ], "title": "JWSVerifyRequest" }, "JWSVerifyResponse": { "properties": { "error": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error", "description": "Error text" }, @@ -3991,32 +8458,118 @@ "did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq" ] }, - "payload": { "type": "object", "title": "Payload", "description": "Payload from verified JWT" }, - "valid": { "type": "boolean", "title": "Valid" } + "payload": { + "type": "object", + "title": "Payload", + "description": "Payload from verified JWT" + }, + "valid": { + "type": "boolean", + "title": "Valid" + } }, "type": "object", - "required": ["headers", "kid", "payload", "valid"], + "required": [ + "headers", + "kid", + "payload", + "valid" + ], "title": "JWSVerifyResponse" }, "JsonLdSignRequest": { "properties": { - "credential_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Credential Id" }, - "credential": { "anyOf": [{ "type": "object" }, { "type": "null" }], "title": "Credential" }, - "verkey": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Verkey" }, - "pub_did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Pub Did" }, - "signature_options": { "anyOf": [{ "$ref": "#/components/schemas/SignatureOptions" }, { "type": "null" }] } + "credential_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Credential Id" + }, + "credential": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "title": "Credential" + }, + "verkey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Verkey" + }, + "pub_did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Pub Did" + }, + "signature_options": { + "anyOf": [ + { + "$ref": "#/components/schemas/SignatureOptions" + }, + { + "type": "null" + } + ] + } }, "type": "object", "title": "JsonLdSignRequest" }, "JsonLdVerifyRequest": { "properties": { - "doc": { "type": "object", "title": "Doc" }, - "public_did": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Public Did" }, - "verkey": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Verkey" } + "doc": { + "type": "object", + "title": "Doc" + }, + "public_did": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Public Did" + }, + "verkey": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Verkey" + } }, "type": "object", - "required": ["doc"], + "required": [ + "doc" + ], "title": "JsonLdVerifyRequest" }, "LDProofVCDetail": { @@ -4029,50 +8582,110 @@ "$ref": "#/components/schemas/LDProofVCOptions", "description": "Options for specifying how the linked data proof is created." }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", - "required": ["credential", "options"], + "required": [ + "credential", + "options" + ], "title": "LDProofVCDetail", "description": "LDProofVCDetail" }, "LDProofVCOptions": { "properties": { "challenge": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Challenge", "description": "A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder)" }, "created": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Created", "description": "The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time" }, "credentialStatus": { - "anyOf": [{ "$ref": "#/components/schemas/CredentialStatusOptions" }, { "type": "null" }], + "anyOf": [ + { + "$ref": "#/components/schemas/CredentialStatusOptions" + }, + { + "type": "null" + } + ], "description": "The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status" }, "domain": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Domain", "description": "The intended domain of validity for the proof" }, "proofPurpose": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Proofpurpose", "description": "The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification" }, "proofType": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Prooftype", "description": "The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry" }, "verificationMethod": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Verificationmethod", "description": "The verification method to use for the proof. Should match a verification method in the wallet" }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", "title": "LDProofVCOptions", @@ -4081,33 +8694,79 @@ "LinkedDataProof": { "properties": { "challenge": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Challenge", "description": "Associates a challenge with a proof, for use with a proofPurpose such as authentication" }, "created": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Created", "description": "The string value of an ISO8601 combined date and time string generated by the Signature Algorithm" }, "domain": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Domain", "description": "A string value specifying the restricted domain of the signature." }, "jws": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Jws", "description": "Associates a Detached Json Web Signature with a proof" }, "nonce": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Nonce", "description": "The nonce" }, - "proofPurpose": { "type": "string", "title": "Proofpurpose", "description": "Proof purpose" }, + "proofPurpose": { + "type": "string", + "title": "Proofpurpose", + "description": "Proof purpose" + }, "proofValue": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Proofvalue", "description": "The proof value of a proof" }, @@ -4121,78 +8780,190 @@ "title": "Verificationmethod", "description": "Information used for proof verification" }, - "additional_properties": { "type": "object", "title": "Additional Properties", "default": {} } + "additional_properties": { + "type": "object", + "title": "Additional Properties", + "default": {} + } }, "type": "object", - "required": ["proofPurpose", "type", "verificationMethod"], + "required": [ + "proofPurpose", + "type", + "verificationMethod" + ], "title": "LinkedDataProof", "description": "LinkedDataProof" }, "Message": { "properties": { - "connection_id": { "type": "string", "title": "Connection Id" }, - "content": { "type": "string", "title": "Content" } + "connection_id": { + "type": "string", + "title": "Connection Id" + }, + "content": { + "type": "string", + "title": "Content" + } }, "type": "object", - "required": ["connection_id", "content"], + "required": [ + "connection_id", + "content" + ], "title": "Message" }, "OobRecord": { "properties": { "attach_thread_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Attach Thread Id", "description": "Connection record identifier" }, "connection_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Connection Id", "description": "Connection record identifier" }, "created_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Created At", "description": "Time of record creation" }, - "invi_msg_id": { "type": "string", "title": "Invi Msg Id", "description": "Invitation message identifier" }, + "invi_msg_id": { + "type": "string", + "title": "Invi Msg Id", + "description": "Invitation message identifier" + }, "invitation": { "$ref": "#/components/schemas/InvitationMessage-Output", "description": "Out of band invitation message" }, "multi_use": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Multi Use", "description": "Allow for multiple uses of the oob invitation" }, - "oob_id": { "type": "string", "title": "Oob Id", "description": "Oob record identifier" }, + "oob_id": { + "type": "string", + "title": "Oob Id", + "description": "Oob record identifier" + }, "our_recipient_key": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Our Recipient Key", "description": "Recipient key used for oob invitation" }, - "role": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Role", "description": "OOB Role" }, - "state": { "type": "string", "title": "State", "description": "Out of band message exchange state" }, - "their_service": { "anyOf": [{ "$ref": "#/components/schemas/ServiceDecorator" }, { "type": "null" }] }, + "role": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Role", + "description": "OOB Role" + }, + "state": { + "type": "string", + "title": "State", + "description": "Out of band message exchange state" + }, + "their_service": { + "anyOf": [ + { + "$ref": "#/components/schemas/ServiceDecorator" + }, + { + "type": "null" + } + ] + }, "trace": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Trace", "description": "Record trace information, based on agent configuration" }, "updated_at": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Updated At", "description": "Time of last record update" } }, "type": "object", - "required": ["invi_msg_id", "invitation", "oob_id", "state"], + "required": [ + "invi_msg_id", + "invitation", + "oob_id", + "state" + ], "title": "OobRecord", "description": "OobRecord" }, "PendingRevocations": { "properties": { "pending_cred_rev_ids": { - "items": { "anyOf": [{ "type": "integer" }, { "type": "null" }] }, + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ] + }, "type": "array", "title": "Pending Cred Rev Ids", "default": [] @@ -4204,7 +8975,14 @@ "PingRequestResponse": { "properties": { "thread_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Thread Id", "description": "Thread ID of the ping message" } @@ -4215,33 +8993,77 @@ }, "PresentationDefinition": { "properties": { - "format": { "anyOf": [{ "$ref": "#/components/schemas/ClaimFormat" }, { "type": "null" }] }, + "format": { + "anyOf": [ + { + "$ref": "#/components/schemas/ClaimFormat" + }, + { + "type": "null" + } + ] + }, "id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Id", "description": "Unique Resource Identifier" }, "input_descriptors": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/InputDescriptors" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/InputDescriptors" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Input Descriptors" }, "name": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Name", "description": "Human-friendly name that describes what the presentation definition pertains to" }, "purpose": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Purpose", "description": "Describes the purpose for which the Presentation Definition's inputs are being requested" }, "submission_requirements": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/SubmissionRequirements" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/SubmissionRequirements" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "Submission Requirements" } @@ -4252,16 +9074,75 @@ }, "PresentationExchange": { "properties": { - "connection_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Connection Id" }, - "created_at": { "type": "string", "title": "Created At" }, - "error_msg": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Error Msg" }, - "parent_thread_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Parent Thread Id" }, - "presentation": { "anyOf": [{ "$ref": "#/components/schemas/IndyProof" }, { "type": "null" }] }, + "connection_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Connection Id" + }, + "created_at": { + "type": "string", + "title": "Created At" + }, + "error_msg": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Error Msg" + }, + "parent_thread_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Parent Thread Id" + }, + "presentation": { + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProof" + }, + { + "type": "null" + } + ] + }, "presentation_request": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequest-Output" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest-Output" + }, + { + "type": "null" + } + ] + }, + "proof_id": { + "type": "string", + "title": "Proof Id" + }, + "role": { + "type": "string", + "enum": [ + "prover", + "verifier" + ], + "title": "Role" }, - "proof_id": { "type": "string", "title": "Proof Id" }, - "role": { "type": "string", "enum": ["prover", "verifier"], "title": "Role" }, "state": { "anyOf": [ { @@ -4278,23 +9159,72 @@ "deleted" ] }, - { "type": "null" } + { + "type": "null" + } ], "title": "State" }, - "thread_id": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Thread Id" }, - "updated_at": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Updated At" }, - "verified": { "anyOf": [{ "type": "boolean" }, { "type": "null" }], "title": "Verified" } + "thread_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Thread Id" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Updated At" + }, + "verified": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "title": "Verified" + } }, "type": "object", - "required": ["created_at", "proof_id", "role"], + "required": [ + "created_at", + "proof_id", + "role" + ], "title": "PresentationExchange" }, - "ProofRequestType": { "type": "string", "enum": ["indy", "jwt", "ld_proof"], "title": "ProofRequestType" }, + "ProofRequestType": { + "type": "string", + "enum": [ + "indy", + "jwt", + "ld_proof" + ], + "title": "ProofRequestType" + }, "PublishRevocationsRequest": { "properties": { "revocation_registry_credential_map": { - "additionalProperties": { "items": { "type": "string" }, "type": "array" }, + "additionalProperties": { + "items": { + "type": "string" + }, + "type": "array" + }, "type": "object", "title": "Revocation Registry Credential Map", "description": "A map of revocation registry IDs to lists of credential revocation IDs that should be published. Providing an empty list for a registry ID publishes all pending revocations for that ID. An empty dictionary signifies that the action should be applied to all pending revocations across all registry IDs.", @@ -4307,11 +9237,29 @@ "RawEncoded": { "properties": { "encoded": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Encoded", "description": "Encoded value" }, - "raw": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Raw", "description": "Raw value" } + "raw": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Raw", + "description": "Raw value" + } }, "type": "object", "title": "RawEncoded", @@ -4320,42 +9268,104 @@ "ReceiveInvitationRequest": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" }, "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", "description": "DID for connection invitation" }, "imageUrl": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Imageurl", "description": "Optional image URL for connection invitation" }, "label": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Label", "description": "Optional label for connection invitation" }, "recipientKeys": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Recipientkeys", "description": "List of recipient keys" }, "routingKeys": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Routingkeys", "description": "List of routing keys" }, "serviceEndpoint": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Serviceendpoint", "description": "Service endpoint at which to reach this agent" } @@ -4366,7 +9376,10 @@ }, "RejectProofRequest": { "properties": { - "proof_id": { "type": "string", "title": "Proof Id" }, + "proof_id": { + "type": "string", + "title": "Proof Id" + }, "problem_report": { "type": "string", "title": "Problem Report", @@ -4381,23 +9394,46 @@ } }, "type": "object", - "required": ["proof_id"], + "required": [ + "proof_id" + ], "title": "RejectProofRequest" }, "RevRegWalletUpdatedResult": { "properties": { "accum_calculated": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Accum Calculated", "description": "Calculated accumulator for phantom revocations" }, "accum_fixed": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Accum Fixed", "description": "Applied ledger transaction to fix revocations" }, "rev_reg_delta": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Rev Reg Delta", "description": "Indy revocation registry delta" } @@ -4408,17 +9444,31 @@ }, "RevokeCredential": { "properties": { - "credential_exchange_id": { "type": "string", "title": "Credential Exchange Id" }, - "auto_publish_on_ledger": { "type": "boolean", "title": "Auto Publish On Ledger", "default": false } + "credential_exchange_id": { + "type": "string", + "title": "Credential Exchange Id" + }, + "auto_publish_on_ledger": { + "type": "boolean", + "title": "Auto Publish On Ledger", + "default": false + } }, "type": "object", - "required": ["credential_exchange_id"], + "required": [ + "credential_exchange_id" + ], "title": "RevokeCredential" }, "RevokedResponse": { "properties": { "cred_rev_ids_published": { - "additionalProperties": { "items": { "type": "integer" }, "type": "array" }, + "additionalProperties": { + "items": { + "type": "integer" + }, + "type": "array" + }, "type": "object", "title": "Cred Rev Ids Published", "description": "A map of revocation registry IDs to lists of credential revocation IDs (as integers) that have been revoked.When cred_rev_ids_published is empty no revocations were published.This will happen when revoke is called with auto_publish_on_ledger=False." @@ -4430,33 +9480,77 @@ "Rotate": { "properties": { "@id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Id", "description": "Message identifier" }, "@type": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "@Type", "description": "Message type" }, - "to_did": { "type": "string", "title": "To Did", "description": "The DID the rotating party is rotating to" } + "to_did": { + "type": "string", + "title": "To Did", + "description": "The DID the rotating party is rotating to" + } }, "type": "object", - "required": ["to_did"], + "required": [ + "to_did" + ], "title": "Rotate", "description": "Rotate" }, "SDJWSCreateRequest": { "properties": { "did": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Did", - "examples": ["did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq"] + "examples": [ + "did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq" + ] + }, + "headers": { + "type": "object", + "title": "Headers", + "default": {} + }, + "payload": { + "type": "object", + "title": "Payload", + "description": "Payload to sign" }, - "headers": { "type": "object", "title": "Headers", "default": {} }, - "payload": { "type": "object", "title": "Payload", "description": "Payload to sign" }, "verification_method": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Verification Method", "description": "Information used for proof verification", "examples": [ @@ -4464,14 +9558,33 @@ ] }, "non_sd_list": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Non Sd List", "default": [], - "examples": [["name", "address", "address.street_address", "nationalities[1:3]"]] + "examples": [ + [ + "name", + "address", + "address.street_address", + "nationalities[1:3]" + ] + ] } }, "type": "object", - "required": ["payload"], + "required": [ + "payload" + ], "title": "SDJWSCreateRequest" }, "SDJWSCreateResponse": { @@ -4485,7 +9598,9 @@ } }, "type": "object", - "required": ["sd_jws"], + "required": [ + "sd_jws" + ], "title": "SDJWSCreateResponse" }, "SDJWSVerifyRequest": { @@ -4499,13 +9614,22 @@ } }, "type": "object", - "required": ["sd_jws"], + "required": [ + "sd_jws" + ], "title": "SDJWSVerifyRequest" }, "SDJWSVerifyResponse": { "properties": { "error": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error", "description": "Error text" }, @@ -4529,33 +9653,88 @@ "did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq" ] }, - "payload": { "type": "object", "title": "Payload", "description": "Payload from verified JWT" }, - "valid": { "type": "boolean", "title": "Valid" }, + "payload": { + "type": "object", + "title": "Payload", + "description": "Payload from verified JWT" + }, + "valid": { + "type": "boolean", + "title": "Valid" + }, "disclosures": { - "items": { "items": { "anyOf": [{ "type": "string" }, { "type": "object" }] }, "type": "array" }, + "items": { + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "object" + } + ] + }, + "type": "array" + }, "type": "array", "title": "Disclosures", "description": "Disclosure arrays associated with the SD-JWT", "examples": [ [ - ["fx1iT_mETjGiC-JzRARnVg", "name", "Alice"], - ["n4-t3mlh8jSS6yMIT7QHnA", "street_address", { "_sd": ["kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng"] }] + [ + "fx1iT_mETjGiC-JzRARnVg", + "name", + "Alice" + ], + [ + "n4-t3mlh8jSS6yMIT7QHnA", + "street_address", + { + "_sd": [ + "kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng" + ] + } + ] ] ] } }, "type": "object", - "required": ["headers", "kid", "payload", "valid", "disclosures"], + "required": [ + "headers", + "kid", + "payload", + "valid", + "disclosures" + ], "title": "SDJWSVerifyResponse" }, "SchemaInputDescriptor": { "properties": { "required": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Required", "description": "Required" }, - "uri": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Uri", "description": "URI" } + "uri": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Uri", + "description": "URI" + } }, "type": "object", "title": "SchemaInputDescriptor", @@ -4564,17 +9743,31 @@ "SchemasInputDescriptorFilter": { "properties": { "oneof_filter": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Oneof Filter", "description": "oneOf" }, "uri_groups": { "anyOf": [ { - "items": { "items": { "$ref": "#/components/schemas/SchemaInputDescriptor" }, "type": "array" }, + "items": { + "items": { + "$ref": "#/components/schemas/SchemaInputDescriptor" + }, + "type": "array" + }, "type": "array" }, - { "type": "null" } + { + "type": "null" + } ], "title": "Uri Groups" } @@ -4586,50 +9779,134 @@ "SendCredential": { "properties": { "save_exchange_record": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Save Exchange Record", "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete." }, - "type": { "$ref": "#/components/schemas/CredentialType", "default": "indy" }, + "type": { + "$ref": "#/components/schemas/CredentialType", + "default": "indy" + }, "indy_credential_detail": { - "anyOf": [{ "$ref": "#/components/schemas/IndyCredential" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyCredential" + }, + { + "type": "null" + } + ] + }, + "ld_credential_detail": { + "anyOf": [ + { + "$ref": "#/components/schemas/LDProofVCDetail" + }, + { + "type": "null" + } + ] }, - "ld_credential_detail": { "anyOf": [{ "$ref": "#/components/schemas/LDProofVCDetail" }, { "type": "null" }] }, - "connection_id": { "type": "string", "title": "Connection Id" } + "connection_id": { + "type": "string", + "title": "Connection Id" + } }, "type": "object", - "required": ["connection_id"], + "required": [ + "connection_id" + ], "title": "SendCredential" }, "SendProofRequest": { "properties": { "save_exchange_record": { - "anyOf": [{ "type": "boolean" }, { "type": "null" }], + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], "title": "Save Exchange Record", "description": "Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete." }, - "comment": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Comment" }, - "type": { "$ref": "#/components/schemas/ProofRequestType", "default": "indy" }, + "comment": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Comment" + }, + "type": { + "$ref": "#/components/schemas/ProofRequestType", + "default": "indy" + }, "indy_proof_request": { - "anyOf": [{ "$ref": "#/components/schemas/IndyProofRequest-Input" }, { "type": "null" }] + "anyOf": [ + { + "$ref": "#/components/schemas/IndyProofRequest-Input" + }, + { + "type": "null" + } + ] + }, + "dif_proof_request": { + "anyOf": [ + { + "$ref": "#/components/schemas/DIFProofRequest" + }, + { + "type": "null" + } + ] }, - "dif_proof_request": { "anyOf": [{ "$ref": "#/components/schemas/DIFProofRequest" }, { "type": "null" }] }, - "connection_id": { "type": "string", "title": "Connection Id" } + "connection_id": { + "type": "string", + "title": "Connection Id" + } }, "type": "object", - "required": ["connection_id"], + "required": [ + "connection_id" + ], "title": "SendProofRequest" }, "ServiceDecorator": { "properties": { "recipientKeys": { - "items": { "type": "string" }, + "items": { + "type": "string" + }, "type": "array", "title": "Recipientkeys", "description": "List of recipient keys" }, "routingKeys": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Routingkeys", "description": "List of routing keys" }, @@ -4640,70 +9917,209 @@ } }, "type": "object", - "required": ["recipientKeys", "serviceEndpoint"], + "required": [ + "recipientKeys", + "serviceEndpoint" + ], "title": "ServiceDecorator", "description": "ServiceDecorator" }, "SetDidEndpointRequest": { - "properties": { "endpoint": { "type": "string", "title": "Endpoint" } }, + "properties": { + "endpoint": { + "type": "string", + "title": "Endpoint" + } + }, "type": "object", - "required": ["endpoint"], + "required": [ + "endpoint" + ], "title": "SetDidEndpointRequest" }, "SignResponse": { "properties": { "error": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Error", "description": "Error text" }, "signed_doc": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Signed Doc", "description": "Signed document" } }, "type": "object", - "title": "SignResponse", - "description": "SignResponse" - }, - "SignatureOptions": { - "properties": { - "challenge": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Challenge" }, - "domain": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Domain" }, - "proofPurpose": { "type": "string", "title": "Proofpurpose" }, - "type": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Type" }, - "verificationMethod": { "type": "string", "title": "Verificationmethod" } - }, - "type": "object", - "required": ["proofPurpose", "verificationMethod"], + "title": "SignResponse", + "description": "SignResponse" + }, + "SignatureOptions": { + "properties": { + "challenge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Challenge" + }, + "domain": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Domain" + }, + "proofPurpose": { + "type": "string", + "title": "Proofpurpose" + }, + "type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Type" + }, + "verificationMethod": { + "type": "string", + "title": "Verificationmethod" + } + }, + "type": "object", + "required": [ + "proofPurpose", + "verificationMethod" + ], "title": "SignatureOptions", "description": "SignatureOptions" }, "SubmissionRequirements": { "properties": { "count": { - "anyOf": [{ "type": "integer" }, { "type": "null" }], + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], "title": "Count", "description": "Count Value" }, - "from": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "From", "description": "From" }, + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "From", + "description": "From" + }, "from_nested": { "anyOf": [ - { "items": { "$ref": "#/components/schemas/SubmissionRequirements" }, "type": "array" }, - { "type": "null" } + { + "items": { + "$ref": "#/components/schemas/SubmissionRequirements" + }, + "type": "array" + }, + { + "type": "null" + } ], "title": "From Nested" }, - "max": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Max", "description": "Max Value" }, - "min": { "anyOf": [{ "type": "integer" }, { "type": "null" }], "title": "Min", "description": "Min Value" }, - "name": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Name", "description": "Name" }, + "max": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Max", + "description": "Max Value" + }, + "min": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "title": "Min", + "description": "Min Value" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Name", + "description": "Name" + }, "purpose": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Purpose", "description": "Purpose" }, - "rule": { "anyOf": [{ "type": "string" }, { "type": "null" }], "title": "Rule", "description": "Selection" } + "rule": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "title": "Rule", + "description": "Selection" + } }, "type": "object", "title": "SubmissionRequirements", @@ -4711,44 +10127,114 @@ }, "TrustPingMsg": { "properties": { - "connection_id": { "type": "string", "title": "Connection Id" }, - "comment": { "type": "string", "title": "Comment" } + "connection_id": { + "type": "string", + "title": "Connection Id" + }, + "comment": { + "type": "string", + "title": "Comment" + } }, "type": "object", - "required": ["connection_id", "comment"], + "required": [ + "connection_id", + "comment" + ], "title": "TrustPingMsg" }, "VCRecord": { "properties": { "contexts": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Contexts" }, "cred_tags": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Cred Tags" }, "cred_value": { - "anyOf": [{ "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], "title": "Cred Value", "description": "(JSON-serializable) credential value" }, "expanded_types": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Expanded Types" }, "given_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Given Id", "description": "Credential identifier" }, "issuer_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Issuer Id", "description": "Issuer identifier" }, "proof_types": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Proof Types" }, "credential_id": { @@ -4758,23 +10244,60 @@ "deprecated": true }, "schema_ids": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Schema Ids" }, "subject_ids": { - "anyOf": [{ "items": { "type": "string" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "type": "string" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Subject Ids" }, - "record_id": { "type": "string", "title": "Record Id", "description": "Credential identifier" } + "record_id": { + "type": "string", + "title": "Record Id", + "description": "Credential identifier" + } }, "type": "object", - "required": ["credential_id", "record_id"], + "required": [ + "credential_id", + "record_id" + ], "title": "VCRecord" }, "VCRecordList": { "properties": { "results": { - "anyOf": [{ "items": { "$ref": "#/components/schemas/VCRecord" }, "type": "array" }, { "type": "null" }], + "anyOf": [ + { + "items": { + "$ref": "#/components/schemas/VCRecord" + }, + "type": "array" + }, + { + "type": "null" + } + ], "title": "Results" } }, @@ -4784,31 +10307,74 @@ "ValidationError": { "properties": { "loc": { - "items": { "anyOf": [{ "type": "string" }, { "type": "integer" }] }, + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "integer" + } + ] + }, "type": "array", "title": "Location" }, - "msg": { "type": "string", "title": "Message" }, - "type": { "type": "string", "title": "Error Type" } + "msg": { + "type": "string", + "title": "Message" + }, + "type": { + "type": "string", + "title": "Error Type" + } }, "type": "object", - "required": ["loc", "msg", "type"], + "required": [ + "loc", + "msg", + "type" + ], "title": "ValidationError" }, "app__models__wallet__IndyCredInfo": { "properties": { "attrs": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Attrs", "description": "Attribute names and value" }, "cred_def_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Def Id", "description": "Credential definition identifier" }, "cred_rev_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Rev Id", "description": "Credential revocation identifier" }, @@ -4819,50 +10385,116 @@ "deprecated": true }, "rev_reg_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Rev Reg Id", "description": "Revocation registry identifier" }, "schema_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Schema Id", "description": "Schema identifier" }, - "referent": { "type": "string", "title": "Referent", "description": "Credential identifier" } + "referent": { + "type": "string", + "title": "Referent", + "description": "Credential identifier" + } }, "type": "object", - "required": ["credential_id", "referent"], + "required": [ + "credential_id", + "referent" + ], "title": "IndyCredInfo" }, "aries_cloudcontroller__models__indy_cred_info__IndyCredInfo": { "properties": { "attrs": { - "anyOf": [{ "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" }], + "anyOf": [ + { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + { + "type": "null" + } + ], "title": "Attrs", "description": "Attribute names and value" }, "cred_def_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Def Id", "description": "Credential definition identifier" }, "cred_rev_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Cred Rev Id", "description": "Credential revocation identifier" }, "referent": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Referent", "description": "Wallet referent" }, "rev_reg_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Rev Reg Id", "description": "Revocation registry identifier" }, "schema_id": { - "anyOf": [{ "type": "string" }, { "type": "null" }], + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], "title": "Schema Id", "description": "Schema identifier" } @@ -4872,6 +10504,12 @@ "description": "IndyCredInfo" } }, - "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "x-api-key" } } + "securitySchemes": { + "APIKeyHeader": { + "type": "apiKey", + "in": "header", + "name": "x-api-key" + } + } } } diff --git a/openapi/tenant-openapi.yaml b/docs/openapi/tenant-openapi.yaml similarity index 69% rename from openapi/tenant-openapi.yaml rename to docs/openapi/tenant-openapi.yaml index 6280f3e6b3..b13015f585 100644 --- a/openapi/tenant-openapi.yaml +++ b/docs/openapi/tenant-openapi.yaml @@ -1,24 +1,24 @@ openapi: 3.1.0 info: title: CloudAPI Tenant - description: " + description: ' - Welcome to the Aries CloudAPI Python project! + Welcome to CloudAPI Tenant! For detailed guidance on using the API, please visit our official documentation: - https://www.didx.co.za/ssi-dev-portal/docs/Welcome. + https://www.didx.co.za/acapy-cloud/index.html - " - version: 1.0.0 + ' + version: 4.2.0 servers: - - url: /tenant +- url: /tenant paths: /v1/connections/create-invitation: post: tags: - - connections + - connections summary: Create a Connection Invitation description: "Create connection invitation\n---\nThis endpoint creates an invitation\ \ object for establishing a connection with another tenant.\n\nFor every invitation\ @@ -48,29 +48,29 @@ paths: application/json: schema: anyOf: - - $ref: "#/components/schemas/CreateInvitation" - - type: "null" + - $ref: '#/components/schemas/CreateInvitation' + - type: 'null' title: Body responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/InvitationResult" - "422": + $ref: '#/components/schemas/InvitationResult' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/connections/accept-invitation: post: tags: - - connections + - connections summary: Accept a Connection Invitation description: "Accept connection invitation\n---\nTenants can use this endpoint\ \ to accept a connection invitation.\n\nThe invitation object is obtained\ @@ -90,28 +90,28 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/AcceptInvitation" + $ref: '#/components/schemas/AcceptInvitation' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' deprecated: true security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/connections: get: tags: - - connections + - connections summary: Fetch Connection Records description: "Fetch a list of connection records\n---\nThe records contain information\ \ about connections with other tenants, such as the state of the connection,\n\ @@ -130,154 +130,154 @@ paths: \ List[Connection]\n A list of connection records" operationId: get_connections_v1_connections_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination - - name: descending - in: query - required: false - schema: - type: boolean - description: Whether to return results in descending order. Results are - ordered by record created time. - default: true - title: Descending - description: Whether to return results in descending order. Results are ordered - by record created time. - - name: alias - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Alias - - name: connection_protocol - in: query - required: false - schema: - anyOf: - - enum: - - connections/1.0 - - didexchange/1.0 - type: string - - type: "null" - title: Connection Protocol - - name: invitation_key - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Invitation Key - - name: invitation_msg_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Invitation Msg Id - - name: my_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: My Did - - name: state - in: query - required: false - schema: - anyOf: - - enum: - - active - - response - - request - - start - - completed - - init - - error - - invitation - - abandoned - type: string - - type: "null" - title: State - - name: their_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Their Did - - name: their_public_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Their Public Did - - name: their_role - in: query - required: false - schema: - anyOf: - - enum: - - invitee - - requester - - inviter - - responder - type: string - - type: "null" - title: Their Role + default: 0 + title: Offset + description: Offset for pagination + - name: descending + in: query + required: false + schema: + type: boolean + description: Whether to return results in descending order. Results are + ordered by record created time. + default: true + title: Descending + description: Whether to return results in descending order. Results are ordered + by record created time. + - name: alias + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Alias + - name: connection_protocol + in: query + required: false + schema: + anyOf: + - enum: + - connections/1.0 + - didexchange/1.0 + type: string + - type: 'null' + title: Connection Protocol + - name: invitation_key + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Invitation Key + - name: invitation_msg_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Invitation Msg Id + - name: my_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: My Did + - name: state + in: query + required: false + schema: + anyOf: + - enum: + - active + - response + - request + - start + - completed + - init + - error + - invitation + - abandoned + type: string + - type: 'null' + title: State + - name: their_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Their Did + - name: their_public_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Their Public Did + - name: their_role + in: query + required: false + schema: + anyOf: + - enum: + - invitee + - requester + - inviter + - responder + type: string + - type: 'null' + title: Their Role responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/Connection" + $ref: '#/components/schemas/Connection' title: Response Get Connections V1 Connections Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/{connection_id}: get: tags: - - connections + - connections summary: Fetch a Connection Record description: "Fetch a connection record by id\n---\nA connection record contains\ \ information about a connection with other tenants, such as the state of\ @@ -287,30 +287,30 @@ paths: \nReturns:\n---\n Connection\n The connection record" operationId: get_connection_by_id_v1_connections__connection_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: path - required: true - schema: - type: string - title: Connection Id + - name: connection_id + in: path + required: true + schema: + type: string + title: Connection Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' delete: tags: - - connections + - connections summary: Delete a Connection Record description: "Delete connection record by id\n---\nThis endpoint deletes a connection\ \ record by id.\n\nIf the connection uses the didexchange protocol, then we\ @@ -322,27 +322,27 @@ paths: \ you want to delete\n\nReturns:\n---\n status_code: 204" operationId: delete_connection_by_id_v1_connections__connection_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: path - required: true - schema: - type: string - title: Connection Id + - name: connection_id + in: path + required: true + schema: + type: string + title: Connection Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/did-exchange/create-request: post: tags: - - connections + - connections summary: Create a DID Exchange Request description: "Create a DID Exchange request\n---\nThis endpoint allows you to\ \ initiate a DID Exchange request with another party using their public DID.\n\ @@ -363,86 +363,86 @@ paths: \ record created by the DID exchange request." operationId: create_did_exchange_request_v1_connections_did_exchange_create_request_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: their_public_did - in: query - required: true - schema: - type: string - title: Their Public Did - - name: alias - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Alias - - name: goal - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Goal - - name: goal_code - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Goal Code - - name: my_label - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: My Label - - name: use_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Use Did - - name: use_did_method - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Use Did Method - - name: use_public_did - in: query - required: false - schema: - type: boolean - default: false - title: Use Public Did + - name: their_public_did + in: query + required: true + schema: + type: string + title: Their Public Did + - name: alias + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Alias + - name: goal + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Goal + - name: goal_code + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Goal Code + - name: my_label + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: My Label + - name: use_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Use Did + - name: use_did_method + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Use Did Method + - name: use_public_did + in: query + required: false + schema: + type: boolean + default: false + title: Use Public Did responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/did-exchange/accept-request: post: tags: - - connections + - connections summary: Accept a DID Exchange Request description: "Accept a stored DID Exchange request\n---\nThis endpoint allows\ \ you to accept a request by providing the connection ID.\n\nParameters:\n\ @@ -451,31 +451,31 @@ paths: \ record created by accepting the DID exchange request." operationId: accept_did_exchange_request_v1_connections_did_exchange_accept_request_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: query - required: true - schema: - type: string - title: Connection Id + - name: connection_id + in: query + required: true + schema: + type: string + title: Connection Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/did-exchange/reject: post: tags: - - connections + - connections summary: Reject or Abandon a DID Exchange description: "Reject or abandon a DID Exchange\n---\nThis endpoint allows you\ \ to reject or abandon a DID Exchange request. You can optionally provide\ @@ -483,39 +483,39 @@ paths: \ connection record after rejecting the DID exchange request." operationId: reject_did_exchange_v1_connections_did_exchange_reject_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: query - required: true - schema: - type: string - title: Connection Id + - name: connection_id + in: query + required: true + schema: + type: string + title: Connection Id requestBody: content: application/json: schema: anyOf: - - $ref: "#/components/schemas/DIDXRejectRequest" - - type: "null" + - $ref: '#/components/schemas/DIDXRejectRequest' + - type: 'null' title: Body responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/did-rotate: post: tags: - - connections + - connections summary: Begin DID Rotation description: "Begin the rotation of a DID as a rotator.\n---\nThis endpoint\ \ allows you to begin the DID rotation for an existing connection. The `to_did`\ @@ -526,37 +526,37 @@ paths: \ The record after the DID rotation is initiated." operationId: rotate_did_v1_connections_did_rotate_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: query - required: true - schema: - type: string - title: Connection Id - - name: to_did - in: query - required: true - schema: - type: string - title: To Did + - name: connection_id + in: query + required: true + schema: + type: string + title: Connection Id + - name: to_did + in: query + required: true + schema: + type: string + title: To Did responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Rotate" - "422": + $ref: '#/components/schemas/Rotate' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/connections/did-rotate/hangup: post: tags: - - connections + - connections summary: Hangup DID Rotation description: "Send a hangup for a DID rotation as the rotator.\n---\nThis endpoint\ \ allows you to hangup a DID rotation process for an existing connection.\n\ @@ -565,31 +565,31 @@ paths: \ The record after the DID rotation is hung up." operationId: hangup_did_rotation_v1_connections_did_rotate_hangup_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: connection_id - in: query - required: true - schema: - type: string - title: Connection Id + - name: connection_id + in: query + required: true + schema: + type: string + title: Connection Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Hangup" - "422": + $ref: '#/components/schemas/Hangup' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/definitions/schemas: post: tags: - - definitions + - definitions summary: Create a new Schema description: "Create and publish a new schema to the ledger\n---\n**NB**: Only\ \ governance can create schemas.\n\nA schema is used to create credential\ @@ -604,29 +604,29 @@ paths: \ created schema object" operationId: create_schema_v1_definitions_schemas_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/CreateSchema" + $ref: '#/components/schemas/CreateSchema' responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialSchema" - "422": + $ref: '#/components/schemas/CredentialSchema' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' get: tags: - - definitions + - definitions summary: Get Created Schemas description: "Get created schemas\n---\nAll tenants can call this endpoint to\ \ view available schemas.\n\nIf governance calls this endpoint, it will return\ @@ -640,60 +640,60 @@ paths: \ List[CredentialSchema]\n A list of created schemas" operationId: get_schemas_v1_definitions_schemas_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: schema_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Id - - name: schema_issuer_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Issuer Did - - name: schema_name - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Name - - name: schema_version - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Version + - name: schema_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Id + - name: schema_issuer_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Issuer Did + - name: schema_name + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Name + - name: schema_version + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Version responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/CredentialSchema" + $ref: '#/components/schemas/CredentialSchema' title: Response Get Schemas V1 Definitions Schemas Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/definitions/schemas/{schema_id}: get: tags: - - definitions + - definitions summary: Get a Schema description: "Retrieve schema by id\n---\nThis endpoint fetches a schema from\ \ the ledger, using the schema_id.\n\nAny tenant can call this endpoint to\ @@ -702,31 +702,31 @@ paths: \ CredentialSchema\n The schema object" operationId: get_schema_v1_definitions_schemas__schema_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: schema_id - in: path - required: true - schema: - type: string - title: Schema Id + - name: schema_id + in: path + required: true + schema: + type: string + title: Schema Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialSchema" - "422": + $ref: '#/components/schemas/CredentialSchema' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/definitions/credentials: post: tags: - - definitions + - definitions summary: Create a new Credential Definition description: "Create a credential definition\n---\nOnly issuers can create credential\ \ definitions.\n\nA credential definition essentially builds off a schema,\ @@ -743,29 +743,29 @@ paths: \ definition" operationId: create_credential_definition_v1_definitions_credentials_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/CreateCredentialDefinition" + $ref: '#/components/schemas/CreateCredentialDefinition' responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialDefinition" - "422": + $ref: '#/components/schemas/CredentialDefinition' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' get: tags: - - definitions + - definitions summary: Get Created Credential Definitions description: "Get credential definitions created by the tenant\n---\nThis endpoint\ \ returns all credential definitions created by the tenant. Only issuers can\ @@ -777,77 +777,77 @@ paths: \ created credential definitions" operationId: get_credential_definitions_v1_definitions_credentials_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: issuer_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Issuer Did - - name: credential_definition_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Credential Definition Id - - name: schema_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Id - - name: schema_issuer_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Issuer Did - - name: schema_name - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Name - - name: schema_version - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Schema Version + - name: issuer_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Issuer Did + - name: credential_definition_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Credential Definition Id + - name: schema_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Id + - name: schema_issuer_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Issuer Did + - name: schema_name + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Name + - name: schema_version + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Schema Version responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/CredentialDefinition" + $ref: '#/components/schemas/CredentialDefinition' title: Response Get Credential Definitions V1 Definitions Credentials Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/definitions/credentials/{credential_definition_id}: get: tags: - - definitions + - definitions summary: Get a Credential Definition description: "Get credential definition by id\n---\nThis endpoint returns information\ \ for a credential definition.\n\nAnyone can call this, whether they created\ @@ -857,31 +857,31 @@ paths: \nReturns:\n---\n CredentialDefinition\n The credential definition" operationId: get_credential_definition_by_id_v1_definitions_credentials__credential_definition_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_definition_id - in: path - required: true - schema: - type: string - title: Credential Definition Id + - name: credential_definition_id + in: path + required: true + schema: + type: string + title: Credential Definition Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialDefinition" - "422": + $ref: '#/components/schemas/CredentialDefinition' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials: post: tags: - - issuer + - issuer summary: Send Holder a Credential description: "Create and send a credential, automating the issuer-side flow\n\ ---\nNB: Only a tenant with the issuer role can send credentials.\n\nWhen\ @@ -901,29 +901,29 @@ paths: \ A record of this credential exchange" operationId: send_credential_v1_issuer_credentials_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/SendCredential" + $ref: '#/components/schemas/SendCredential' responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialExchange" - "422": + $ref: '#/components/schemas/CredentialExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' get: tags: - - issuer + - issuer summary: Fetch Credential Exchange Records description: "Get a list of credential exchange records\n---\nBoth holders and\ \ issuers can call this endpoint, because they each have their own records\ @@ -950,113 +950,113 @@ paths: \ A list of credential exchange records" operationId: get_credentials_v1_issuer_credentials_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination - - name: descending - in: query - required: false - schema: - type: boolean - description: Whether to return results in descending order. Results are - ordered by record created time. - default: true - title: Descending - description: Whether to return results in descending order. Results are ordered - by record created time. - - name: connection_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Connection Id - - name: role - in: query - required: false - schema: - anyOf: - - enum: - - issuer - - holder - type: string - - type: "null" - title: Role - - name: state - in: query - required: false - schema: - anyOf: - - enum: - - proposal-sent - - proposal-received - - offer-sent - - offer-received - - request-sent - - request-received - - credential-issued - - credential-received - - credential-revoked - - abandoned - - done - - deleted - type: string - - type: "null" - title: State - - name: thread_id - in: query - required: false - schema: - anyOf: - - type: string - format: uuid - - type: "null" - title: Thread Id + default: 0 + title: Offset + description: Offset for pagination + - name: descending + in: query + required: false + schema: + type: boolean + description: Whether to return results in descending order. Results are + ordered by record created time. + default: true + title: Descending + description: Whether to return results in descending order. Results are ordered + by record created time. + - name: connection_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Connection Id + - name: role + in: query + required: false + schema: + anyOf: + - enum: + - issuer + - holder + type: string + - type: 'null' + title: Role + - name: state + in: query + required: false + schema: + anyOf: + - enum: + - proposal-sent + - proposal-received + - offer-sent + - offer-received + - request-sent + - request-received + - credential-issued + - credential-received + - credential-revoked + - abandoned + - done + - deleted + type: string + - type: 'null' + title: State + - name: thread_id + in: query + required: false + schema: + anyOf: + - type: string + format: uuid + - type: 'null' + title: Thread Id responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/CredentialExchange" + $ref: '#/components/schemas/CredentialExchange' title: Response Get Credentials V1 Issuer Credentials Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/create-offer: post: tags: - - issuer + - issuer summary: Create a Credential Offer (not bound to a connection) description: "Create a credential offer, not bound to any connection\n---\n\ NB: Only a tenant with the issuer role can create credential offers.\n\nThis\ @@ -1081,27 +1081,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CreateOffer" + $ref: '#/components/schemas/CreateOffer' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialExchange" - "422": + $ref: '#/components/schemas/CredentialExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/issuer/credentials/{credential_exchange_id}/request: post: tags: - - issuer + - issuer summary: Accept a Credential Offer description: "Sends a request to accept a credential offer\n---\nThe holder\ \ uses this endpoint to accept an offer from an issuer.\n\nIn technical terms,\ @@ -1116,45 +1116,45 @@ paths: \ An updated record of this credential exchange" operationId: request_credential_v1_issuer_credentials__credential_exchange_id__request_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_exchange_id - in: path - required: true - schema: - type: string - title: Credential Exchange Id - - name: save_exchange_record - in: query - required: false - schema: - anyOf: - - type: boolean - - type: "null" - description: Controls exchange record retention after exchange is complete. - None uses wallet default (typically to delete), true forces save, false - forces delete. - title: Save Exchange Record + - name: credential_exchange_id + in: path + required: true + schema: + type: string + title: Credential Exchange Id + - name: save_exchange_record + in: query + required: false + schema: + anyOf: + - type: boolean + - type: 'null' description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete. + title: Save Exchange Record + description: Controls exchange record retention after exchange is complete. + None uses wallet default (typically to delete), true forces save, false + forces delete. responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialExchange" - "422": + $ref: '#/components/schemas/CredentialExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/{credential_exchange_id}/store: post: tags: - - issuer + - issuer summary: Store a Received Credential in Wallet description: "NB: Deprecated because credentials are automatically stored in\ \ wallet after they are accepted\n---\n\nStore a credential\n---\nStore a\ @@ -1168,31 +1168,31 @@ paths: operationId: store_credential_v1_issuer_credentials__credential_exchange_id__store_post deprecated: true security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_exchange_id - in: path - required: true - schema: - type: string - title: Credential Exchange Id + - name: credential_exchange_id + in: path + required: true + schema: + type: string + title: Credential Exchange Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialExchange" - "422": + $ref: '#/components/schemas/CredentialExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/{credential_exchange_id}: get: tags: - - issuer + - issuer summary: Fetch a single Credential Exchange Record description: "Get a credential exchange record by credential id\n---\nBoth holders\ \ and issuers can call this endpoint, because they each have their own records\ @@ -1213,30 +1213,30 @@ paths: \ record" operationId: get_credential_v1_issuer_credentials__credential_exchange_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_exchange_id - in: path - required: true - schema: - type: string - title: Credential Exchange Id + - name: credential_exchange_id + in: path + required: true + schema: + type: string + title: Credential Exchange Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredentialExchange" - "422": + $ref: '#/components/schemas/CredentialExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' delete: tags: - - issuer + - issuer summary: Delete an Exchange Record description: "Delete a credential exchange record\n---\nThis will remove a specific\ \ credential exchange from your storage records.\n\nParameters:\n---\n \ @@ -1244,27 +1244,27 @@ paths: \ record that you want to delete\n\nReturns:\n---\n status_code: 204" operationId: remove_credential_exchange_record_v1_issuer_credentials__credential_exchange_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_exchange_id - in: path - required: true - schema: - type: string - title: Credential Exchange Id + - name: credential_exchange_id + in: path + required: true + schema: + type: string + title: Credential Exchange Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/revoke: post: tags: - - revocation + - revocation summary: Revoke a Credential (if revocable) description: "Revoke a credential\n---\nRevoke a credential by providing the\ \ identifier of the exchange.\n\nIf an issuer is going to revoke more than\ @@ -1284,27 +1284,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/RevokeCredential" + $ref: '#/components/schemas/RevokeCredential' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/RevokedResponse" - "422": + $ref: '#/components/schemas/RevokedResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/issuer/credentials/revocation/record: get: tags: - - revocation + - revocation summary: Fetch a Revocation Record description: "Get a credential revocation record\n---\nFetch a credential revocation\ \ record by providing the credential exchange id.\nRecords can also be fetched\ @@ -1320,49 +1320,49 @@ paths: \ and revocation_registry_id must be." operationId: get_credential_revocation_record_v1_issuer_credentials_revocation_record_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_exchange_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Credential Exchange Id - - name: credential_revocation_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Credential Revocation Id - - name: revocation_registry_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Revocation Registry Id + - name: credential_exchange_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Credential Exchange Id + - name: credential_revocation_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Credential Revocation Id + - name: revocation_registry_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Revocation Registry Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/IssuerCredRevRecord" - "422": + $ref: '#/components/schemas/IssuerCredRevRecord' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/publish-revocations: post: tags: - - revocation + - revocation summary: Publish Pending Revocations description: "Write pending revocations to the ledger\n---\nRevocations that\ \ are in a pending state can be published to the ledger.\n\nThe endpoint accepts\ @@ -1393,27 +1393,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/PublishRevocationsRequest" + $ref: '#/components/schemas/PublishRevocationsRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/RevokedResponse" - "422": + $ref: '#/components/schemas/RevokedResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/issuer/credentials/clear-pending-revocations: post: tags: - - revocation + - revocation summary: Clear Pending Revocations description: "Clear pending revocations\n---\nRevocations that are in a pending\ \ state can be cleared, such that they are no longer set to be revoked.\n\n\ @@ -1443,27 +1443,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ClearPendingRevocationsRequest" + $ref: '#/components/schemas/ClearPendingRevocationsRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/ClearPendingRevocationsResult" - "422": + $ref: '#/components/schemas/ClearPendingRevocationsResult' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/issuer/credentials/get-pending-revocations/{revocation_registry_id}: get: tags: - - revocation + - revocation summary: Get Pending Revocations description: "Get pending revocations\n---\nGet the pending revocations for\ \ a given revocation registry ID.\n\nParameters:\n---\n revocation_registry_id:\ @@ -1472,31 +1472,31 @@ paths: \ cred_rev_ids pending revocation for a given revocation registry ID" operationId: get_pending_revocations_v1_issuer_credentials_get_pending_revocations__revocation_registry_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: revocation_registry_id - in: path - required: true - schema: - type: string - title: Revocation Registry Id + - name: revocation_registry_id + in: path + required: true + schema: + type: string + title: Revocation Registry Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PendingRevocations" - "422": + $ref: '#/components/schemas/PendingRevocations' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/issuer/credentials/fix-revocation-registry/{revocation_registry_id}: put: tags: - - revocation + - revocation summary: Fix Revocation Registry Entry State description: "Fix Revocation Registry Entry State\n---\nFix the revocation registry\ \ entry state for a given revocation registry ID.\n\nIf issuer's revocation\ @@ -1512,38 +1512,38 @@ paths: \ The delta between wallet and ledger state for this revocation registry" operationId: fix_revocation_registry_entry_state_v1_issuer_credentials_fix_revocation_registry__revocation_registry_id__put security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: revocation_registry_id - in: path - required: true - schema: - type: string - title: Revocation Registry Id - - name: apply_ledger_update - in: query - required: false - schema: - type: boolean - default: false - title: Apply Ledger Update + - name: revocation_registry_id + in: path + required: true + schema: + type: string + title: Revocation Registry Id + - name: apply_ledger_update + in: query + required: false + schema: + type: boolean + default: false + title: Apply Ledger Update responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/RevRegWalletUpdatedResult" - "422": + $ref: '#/components/schemas/RevRegWalletUpdatedResult' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/jsonld/sign: post: tags: - - jsonld + - jsonld summary: Sign Jsonld description: Sign a JSON-LD structure operationId: sign_jsonld_v1_jsonld_sign_post @@ -1551,27 +1551,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/JsonLdSignRequest" + $ref: '#/components/schemas/JsonLdSignRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/SignResponse" - "422": + $ref: '#/components/schemas/SignResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/jsonld/verify: post: tags: - - jsonld + - jsonld summary: Verify Jsonld description: Verify a JSON-LD structure operationId: verify_jsonld_v1_jsonld_verify_post @@ -1579,23 +1579,23 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/JsonLdVerifyRequest" + $ref: '#/components/schemas/JsonLdVerifyRequest' required: true responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/messaging/send-message: post: tags: - - messaging + - messaging summary: Send a Message description: "Send basic message\n---\n\nSend a message to a tenant via a connection.\ \ The other tenant will receive\nthe message on topic `basic-message` for\ @@ -1609,26 +1609,26 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Message" + $ref: '#/components/schemas/Message' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: {} - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/messaging/trust-ping: post: tags: - - messaging + - messaging summary: Send Trust Ping description: "Send trust ping\n---\nSend a trust ping to a connection to ensure\ \ that the connection is active and ready.\n\nSee the Aries\n[Trust Ping Protocol](https://github.com/hyperledger/aries-rfcs/blob/main/features/0048-trust-ping/README.md)\n\ @@ -1642,27 +1642,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/TrustPingMsg" + $ref: '#/components/schemas/TrustPingMsg' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PingRequestResponse" - "422": + $ref: '#/components/schemas/PingRequestResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/oob/create-invitation: post: tags: - - out-of-band + - out-of-band summary: Create OOB Invitation description: "Create an out-of-band invitation\n---\n\nThe attachment field\ \ is used to include a credential offer or a proof request in the invitation.\n\ @@ -1686,28 +1686,28 @@ paths: application/json: schema: anyOf: - - $ref: "#/components/schemas/CreateOobInvitation" - - type: "null" + - $ref: '#/components/schemas/CreateOobInvitation' + - type: 'null' title: Body responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/InvitationRecord" - "422": + $ref: '#/components/schemas/InvitationRecord' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/oob/accept-invitation: post: tags: - - out-of-band + - out-of-band summary: Accept OOB Invitation description: "Accept out-of-band invitation\n---\n\nAs with the accept connection\ \ invitation endpoint, the invitation object from the create-invitation endpoint\n\ @@ -1723,27 +1723,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/AcceptOobInvitation" + $ref: '#/components/schemas/AcceptOobInvitation' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/OobRecord" - "422": + $ref: '#/components/schemas/OobRecord' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/oob/connect-public-did: post: tags: - - out-of-band + - out-of-band summary: Connect with Public DID description: "Connect using public DID as implicit invitation\n---\n\nA connection\ \ will automatically be established with the public DID.\n\nRequest body:\n\ @@ -1754,27 +1754,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ConnectToPublicDid" + $ref: '#/components/schemas/ConnectToPublicDid' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/Connection" - "422": + $ref: '#/components/schemas/Connection' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/verifier/send-request: post: tags: - - verifier + - verifier summary: Send a Proof Request to a connection description: "Send proof request\n---\nNB: Only a tenant with the verifier role\ \ can send a proof request.\n\nThe verifier uses this endpoint to send a proof\ @@ -1799,27 +1799,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/SendProofRequest" + $ref: '#/components/schemas/SendProofRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PresentationExchange" - "422": + $ref: '#/components/schemas/PresentationExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/verifier/create-request: post: tags: - - verifier + - verifier summary: Create a Proof Request (not bound to a connection) description: "Creates a presentation request that is not bound to any specific\ \ proposal or connection\n---\nThis endpoint is used to create a proof request\ @@ -1846,27 +1846,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/CreateProofRequest" + $ref: '#/components/schemas/CreateProofRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PresentationExchange" - "422": + $ref: '#/components/schemas/PresentationExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/verifier/accept-request: post: tags: - - verifier + - verifier summary: Accept a Proof Request description: "Accept proof request\n---\nA prover uses this endpoint to respond\ \ to a proof request, by sending a presentation to the verifier.\n\nAn Indy\ @@ -1890,27 +1890,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/AcceptProofRequest" + $ref: '#/components/schemas/AcceptProofRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PresentationExchange" - "422": + $ref: '#/components/schemas/PresentationExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/verifier/reject-request: post: tags: - - verifier + - verifier summary: Reject a Proof Request description: "Reject proof request\n---\nA prover uses this endpoint to notify\ \ the verifier that they cannot or refuse to respond to a proof request.\n\ @@ -1928,23 +1928,23 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/RejectProofRequest" + $ref: '#/components/schemas/RejectProofRequest' required: true responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/verifier/proofs: get: tags: - - verifier + - verifier summary: Get Presentation Exchange Records description: "Get all presentation exchange records for this tenant\n---\nThese\ \ records contains information about proof requests and presentations.\n\n\ @@ -1960,110 +1960,110 @@ paths: \ The list of presentation exchange records" operationId: get_proof_records_v1_verifier_proofs_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination - - name: descending - in: query - required: false - schema: - type: boolean - description: Whether to return results in descending order. Results are - ordered by record created time. - default: true - title: Descending - description: Whether to return results in descending order. Results are ordered - by record created time. - - name: connection_id - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Connection Id - - name: role - in: query - required: false - schema: - anyOf: - - enum: - - prover - - verifier - type: string - - type: "null" - title: Role - - name: state - in: query - required: false - schema: - anyOf: - - enum: - - abandoned - - done - - presentation-received - - presentation-sent - - proposal-received - - proposal-sent - - request-received - - request-sent - - deleted - type: string - - type: "null" - title: State - - name: thread_id - in: query - required: false - schema: - anyOf: - - type: string - format: uuid - - type: "null" - title: Thread Id + default: 0 + title: Offset + description: Offset for pagination + - name: descending + in: query + required: false + schema: + type: boolean + description: Whether to return results in descending order. Results are + ordered by record created time. + default: true + title: Descending + description: Whether to return results in descending order. Results are ordered + by record created time. + - name: connection_id + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Connection Id + - name: role + in: query + required: false + schema: + anyOf: + - enum: + - prover + - verifier + type: string + - type: 'null' + title: Role + - name: state + in: query + required: false + schema: + anyOf: + - enum: + - abandoned + - done + - presentation-received + - presentation-sent + - proposal-received + - proposal-sent + - request-received + - request-sent + - deleted + type: string + - type: 'null' + title: State + - name: thread_id + in: query + required: false + schema: + anyOf: + - type: string + format: uuid + - type: 'null' + title: Thread Id responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/PresentationExchange" + $ref: '#/components/schemas/PresentationExchange' title: Response Get Proof Records V1 Verifier Proofs Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/verifier/proofs/{proof_id}: get: tags: - - verifier + - verifier summary: Get a Presentation Exchange Record description: "Get a specific presentation exchange record\n---\nThis fetches\ \ a specific presentation exchange record by providing the proof ID.\n\nParameters:\n\ @@ -2072,30 +2072,30 @@ paths: \ exchange record for the proof ID" operationId: get_proof_record_v1_verifier_proofs__proof_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: proof_id - in: path - required: true - schema: - type: string - title: Proof Id + - name: proof_id + in: path + required: true + schema: + type: string + title: Proof Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/PresentationExchange" - "422": + $ref: '#/components/schemas/PresentationExchange' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' delete: tags: - - verifier + - verifier summary: Delete a Presentation Exchange Record description: "Delete a presentation exchange record\n---\nThis will remove a\ \ specific presentation exchange from your storage records.\n\nParameters:\n\ @@ -2103,27 +2103,27 @@ paths: \ record that you want to delete\n\nReturns:\n---\n status_code: 204" operationId: delete_proof_v1_verifier_proofs__proof_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: proof_id - in: path - required: true - schema: - type: string - title: Proof Id + - name: proof_id + in: path + required: true + schema: + type: string + title: Proof Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/verifier/proofs/{proof_id}/credentials: get: tags: - - verifier + - verifier summary: Get Matching Credentials for a Proof description: "Get matching credentials for a presentation exchange\n---\nThis\ \ endpoint returns a list of possible credentials that the prover can use\ @@ -2138,68 +2138,68 @@ paths: \ A list of applicable Indy credentials" operationId: get_credentials_by_proof_id_v1_verifier_proofs__proof_id__credentials_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: proof_id - in: path - required: true - schema: - type: string - title: Proof Id - - name: referent - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Referent - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: proof_id + in: path + required: true + schema: + type: string + title: Proof Id + - name: referent + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Referent + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination + default: 0 + title: Offset + description: Offset for pagination responses: - "200": + '200': description: Successful Response content: application/json: schema: type: array items: - $ref: "#/components/schemas/IndyCredPrecis" + $ref: '#/components/schemas/IndyCredPrecis' title: Response Get Credentials By Proof Id V1 Verifier Proofs Proof Id Credentials Get - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials: get: tags: - - wallet + - wallet summary: Fetch a list of credentials from the wallet description: "Fetch a list of credentials from the wallet\n---\n\nThe `wql`\ \ (Wallet Query Language) parameter can be used to filter credentials returned\ @@ -2212,115 +2212,115 @@ paths: \ records." operationId: list_credentials_v1_wallet_credentials_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - maximum: 10000 - minimum: 1 - - type: "null" - description: Number of results to return - default: 1000 - title: Limit + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + maximum: 10000 + minimum: 1 + - type: 'null' description: Number of results to return - - name: offset - in: query - required: false - schema: - anyOf: - - type: integer - minimum: 0 - - type: "null" - description: Offset for pagination - default: 0 - title: Offset + default: 1000 + title: Limit + description: Number of results to return + - name: offset + in: query + required: false + schema: + anyOf: + - type: integer + minimum: 0 + - type: 'null' description: Offset for pagination - - name: wql - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Wql + default: 0 + title: Offset + description: Offset for pagination + - name: wql + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Wql responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredInfoList" - "422": + $ref: '#/components/schemas/CredInfoList' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials/{credential_id}: get: tags: - - wallet + - wallet summary: Fetch a credential by ID description: "Fetch a specific credential by ID\n---\n\nParameters:\n---\n \ \ credential_id: str\n The ID of the credential to fetch.\n\nReturns:\n\ ---\n IndyCredInfo\n The credential record." operationId: get_credential_record_v1_wallet_credentials__credential_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/app__models__wallet__IndyCredInfo" - "422": + $ref: '#/components/schemas/app__models__wallet__IndyCredInfo' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' delete: tags: - - wallet + - wallet summary: Delete a credential by ID description: "Remove a specific credential from the wallet by ID\n---\n\nParameters:\n\ ---\n credential_id: str\n The ID of the credential to delete.\n\ \nReturns:\n---\n status_code: 204" operationId: delete_credential_v1_wallet_credentials__credential_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials/{credential_id}/mime-types: get: tags: - - wallet + - wallet summary: Retrieve attribute MIME types of a credential description: "Retrieve attribute MIME types of a specific credential by ID\n\ ---\n\nParameters:\n---\n credential_id: str\n The ID of the credential\ @@ -2328,31 +2328,31 @@ paths: \ The attribute MIME types of the credential." operationId: get_credential_mime_types_v1_wallet_credentials__credential_id__mime_types_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/AttributeMimeTypesResult" - "422": + $ref: '#/components/schemas/AttributeMimeTypesResult' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials/{credential_id}/revocation-status: get: tags: - - wallet + - wallet summary: Get revocation status of a credential description: "Query the revocation status of a specific credential by ID\n---\n\ \nThe revocation status of a credential can be queried over a specific time\ @@ -2365,47 +2365,47 @@ paths: \ status of the credential." operationId: get_credential_revocation_status_v1_wallet_credentials__credential_id__revocation_status_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id - - name: from_ - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: "From " - - name: to - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: To + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id + - name: from_ + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: 'From ' + - name: to + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: To responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/CredRevokedResult" - "422": + $ref: '#/components/schemas/CredRevokedResult' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials/w3c: get: tags: - - wallet + - wallet summary: Fetch a list of W3C credentials from the wallet description: "Fetch a list of W3C credentials from the wallet\n---\n\nThe W3C\ \ credentials can be filtered by the parameters provided.\n\nOptional Parameters:\n\ @@ -2415,128 +2415,128 @@ paths: \ A list of W3C credential records." operationId: list_w3c_credentials_v1_wallet_credentials_w3c_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: limit - in: query - required: false - schema: - anyOf: - - type: integer - - type: "null" - title: Limit - - name: issuer_did - in: query - required: false - schema: - anyOf: - - type: string - - type: "null" - title: Issuer Did + - name: limit + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' + title: Limit + - name: issuer_did + in: query + required: false + schema: + anyOf: + - type: string + - type: 'null' + title: Issuer Did requestBody: content: application/json: schema: anyOf: - - type: array - items: - type: string - - type: "null" + - type: array + items: + type: string + - type: 'null' title: Schema Ids responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/VCRecordList" - "422": + $ref: '#/components/schemas/VCRecordList' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/credentials/w3c/{credential_id}: get: tags: - - wallet + - wallet summary: Fetch a W3C credential by ID description: "Fetch a specific W3C credential by ID\n---\n\nParameters:\n---\n\ \ credential_id: str\n The ID of the W3C credential to fetch.\n\n\ Returns:\n---\n VCRecord\n The W3C credential." operationId: get_w3c_credential_v1_wallet_credentials_w3c__credential_id__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/VCRecord" - "422": + $ref: '#/components/schemas/VCRecord' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' delete: tags: - - wallet + - wallet summary: Delete W3C credential description: "Remove a specific W3C credential from the wallet by ID\n---\n\n\ Parameters:\n---\n credential_id: str\n The ID of the W3C credential\ \ to delete.\n\nReturns:\n---\n status_code: 204" operationId: delete_w3c_credential_v1_wallet_credentials_w3c__credential_id__delete security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: credential_id - in: path - required: true - schema: - type: string - title: Credential Id + - name: credential_id + in: path + required: true + schema: + type: string + title: Credential Id responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/dids: get: tags: - - wallet + - wallet summary: List DIDs description: "Retrieve List of DIDs\n---\n\nThis endpoint allows you to retrieve\ \ a list of DIDs in the wallet.\n\nResponse:\n---\n Returns a list of DID\ \ objects." operationId: list_dids_v1_wallet_dids_get responses: - "200": + '200': description: Successful Response content: application/json: schema: items: - $ref: "#/components/schemas/DID" + $ref: '#/components/schemas/DID' type: array title: Response List Dids V1 Wallet Dids Get security: - - APIKeyHeader: [] + - APIKeyHeader: [] post: tags: - - wallet + - wallet summary: Create Local DID description: "Create Local DID\n---\n\nThis endpoint allows you to create a\ \ new DID in the wallet.\nThe `method` parameter is optional and can be set\ @@ -2555,45 +2555,45 @@ paths: application/json: schema: anyOf: - - $ref: "#/components/schemas/DIDCreate" - - type: "null" + - $ref: '#/components/schemas/DIDCreate' + - type: 'null' title: Did Create responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/DID" - "422": + $ref: '#/components/schemas/DID' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/wallet/dids/public: get: tags: - - wallet + - wallet summary: Fetch Public DID description: "Fetch the Current Public DID\n---\n\nThis endpoint allows you\ \ to fetch the current public DID.\nBy default, only issuers will have public\ \ DIDs.\n\nResponse:\n---\n Returns the public DID." operationId: get_public_did_v1_wallet_dids_public_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/DID" + $ref: '#/components/schemas/DID' put: tags: - - wallet + - wallet summary: Set Public DID description: "Set the Current Public DID\n---\n\nThis endpoint allows you to\ \ set the current public DID.\n\n**Notes:**\n - Requires an active endorser\ @@ -2602,88 +2602,88 @@ paths: ---\n Returns the public DID." operationId: set_public_did_v1_wallet_dids_public_put security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: did - in: query - required: true - schema: - type: string - title: Did + - name: did + in: query + required: true + schema: + type: string + title: Did responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/DID" - "422": + $ref: '#/components/schemas/DID' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/dids/{did}/rotate-keypair: patch: tags: - - wallet + - wallet summary: Rotate Key Pair description: "Rotate Key Pair for DID\n---\n\nThis endpoint allows you to rotate\ \ the key pair for a DID.\n\nParameters:\n---\n did: str\n\nResponse:\n\ ---\n 204 No Content" operationId: rotate_keypair_v1_wallet_dids__did__rotate_keypair_patch security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: did - in: path - required: true - schema: - type: string - title: Did + - name: did + in: path + required: true + schema: + type: string + title: Did responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/dids/{did}/endpoint: get: tags: - - wallet + - wallet summary: Get DID Endpoint description: "Get DID Endpoint\n---\n\nThis endpoint allows you to fetch the\ \ endpoint for a DID.\n\nParameters:\n---\n did: str\n\nResponse:\n---\n\ \ Returns the endpoint for the DID." operationId: get_did_endpoint_v1_wallet_dids__did__endpoint_get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: did - in: path - required: true - schema: - type: string - title: Did + - name: did + in: path + required: true + schema: + type: string + title: Did responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/DIDEndpoint" - "422": + $ref: '#/components/schemas/DIDEndpoint' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' post: tags: - - wallet + - wallet summary: Set DID Endpoint description: "Update Endpoint of DID in Wallet (and on Ledger, if it is a Public\ \ DID)\n---\n\nThis endpoint allows you to update the endpoint for a DID.\n\ @@ -2691,33 +2691,33 @@ paths: \ endpoint: str" operationId: set_did_endpoint_v1_wallet_dids__did__endpoint_post security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: did - in: path - required: true - schema: - type: string - title: Did + - name: did + in: path + required: true + schema: + type: string + title: Did requestBody: required: true content: application/json: schema: - $ref: "#/components/schemas/SetDidEndpointRequest" + $ref: '#/components/schemas/SetDidEndpointRequest' responses: - "204": + '204': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' /v1/wallet/jws/sign: post: tags: - - wallet + - wallet summary: Sign JWS description: "Sign a JSON Web Signature (JWS).\n---\n\nThis endpoint allows\ \ users to sign a JSON payload, creating a JWS,\nusing either a DID or a specific\ @@ -2748,27 +2748,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/JWSCreateRequest" + $ref: '#/components/schemas/JWSCreateRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/JWSCreateResponse" - "422": + $ref: '#/components/schemas/JWSCreateResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/wallet/jws/verify: post: tags: - - wallet + - wallet summary: Verify JWS description: "Verify a JSON Web Signature (JWS)\n---\n\nThis endpoint allows\ \ users to verify the authenticity and integrity of a JWS string previously\ @@ -2785,27 +2785,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/JWSVerifyRequest" + $ref: '#/components/schemas/JWSVerifyRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/JWSVerifyResponse" - "422": + $ref: '#/components/schemas/JWSVerifyResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/wallet/sd-jws/sign: post: tags: - - wallet + - wallet summary: Sign SD-JWS description: "Sign a Selective Disclosure JSON Web Signature (SD-JWS).\n---\n\ \nThis endpoint allows users to create a Selective Disclosure JSON Web Signature\ @@ -2852,27 +2852,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/SDJWSCreateRequest" + $ref: '#/components/schemas/SDJWSCreateRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/SDJWSCreateResponse" - "422": + $ref: '#/components/schemas/SDJWSCreateResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/wallet/sd-jws/verify: post: tags: - - wallet + - wallet summary: Verify SD-JWS description: "Verify a Selective Disclosure JSON Web Signature (SD-JWS).\n---\n\ \nThis endpoint allows users to verify the authenticity and integrity of a\ @@ -2901,27 +2901,27 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/SDJWSVerifyRequest" + $ref: '#/components/schemas/SDJWSVerifyRequest' required: true responses: - "200": + '200': description: Successful Response content: application/json: schema: - $ref: "#/components/schemas/SDJWSVerifyResponse" - "422": + $ref: '#/components/schemas/SDJWSVerifyResponse' + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' security: - - APIKeyHeader: [] + - APIKeyHeader: [] /v1/sse/{wallet_id}/{topic}/{field}/{field_id}/{desired_state}: get: tags: - - sse + - sse summary: Subscribe To A Wallet Event By Topic, Field, And Desired State description: "Subscribe to SSE events wait for a desired state with a field\ \ filter.\n---\n***This endpoint can't be called on the swagger UI, as it\ @@ -2940,97 +2940,97 @@ paths: \ to look back for events before subscribing." operationId: Subscribe_to_a_Wallet_Event_by_Topic__Field__and_Desired_State_v1_sse__wallet_id___topic___field___field_id___desired_state__get security: - - APIKeyHeader: [] + - APIKeyHeader: [] parameters: - - name: wallet_id - in: path - required: true - schema: - type: string - title: Wallet Id - - name: topic - in: path - required: true - schema: - type: string - title: Topic - - name: field - in: path - required: true - schema: - type: string - title: Field - - name: field_id - in: path - required: true - schema: - type: string - title: Field Id - - name: desired_state - in: path - required: true - schema: - type: string - title: Desired State - - name: look_back - in: query - required: false - schema: - anyOf: - - type: integer - - type: "null" - description: Number of seconds to look back for events - default: 60 - title: Look Back + - name: wallet_id + in: path + required: true + schema: + type: string + title: Wallet Id + - name: topic + in: path + required: true + schema: + type: string + title: Topic + - name: field + in: path + required: true + schema: + type: string + title: Field + - name: field_id + in: path + required: true + schema: + type: string + title: Field Id + - name: desired_state + in: path + required: true + schema: + type: string + title: Desired State + - name: look_back + in: query + required: false + schema: + anyOf: + - type: integer + - type: 'null' description: Number of seconds to look back for events + default: 60 + title: Look Back + description: Number of seconds to look back for events responses: - "200": + '200': description: Successful Response - "422": + '422': description: Validation Error content: application/json: schema: - $ref: "#/components/schemas/HTTPValidationError" + $ref: '#/components/schemas/HTTPValidationError' components: schemas: AcceptInvitation: properties: alias: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alias invitation: - $ref: "#/components/schemas/ReceiveInvitationRequest" + $ref: '#/components/schemas/ReceiveInvitationRequest' type: object required: - - invitation + - invitation title: AcceptInvitation AcceptOobInvitation: properties: alias: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alias use_existing_connection: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Use Existing Connection invitation: - $ref: "#/components/schemas/InvitationMessage-Input" + $ref: '#/components/schemas/InvitationMessage-Input' type: object required: - - invitation + - invitation title: AcceptOobInvitation AcceptProofRequest: properties: save_exchange_record: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Save Exchange Record description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false @@ -3039,144 +3039,144 @@ components: type: string title: Proof Id type: - $ref: "#/components/schemas/ProofRequestType" + $ref: '#/components/schemas/ProofRequestType' default: indy indy_presentation_spec: anyOf: - - $ref: "#/components/schemas/IndyPresSpec" - - type: "null" + - $ref: '#/components/schemas/IndyPresSpec' + - type: 'null' dif_presentation_spec: anyOf: - - $ref: "#/components/schemas/DIFPresSpec" - - type: "null" + - $ref: '#/components/schemas/DIFPresSpec' + - type: 'null' type: object required: - - proof_id + - proof_id title: AcceptProofRequest AttachDecorator-Input: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Attachment identifier byte_count: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Byte Count description: Byte count of data included by reference data: - $ref: "#/components/schemas/AttachDecoratorData-Input" + $ref: '#/components/schemas/AttachDecoratorData-Input' description: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Description description: Human-readable description of content filename: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Filename description: File name lastmod_time: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Lastmod Time description: Hint regarding last modification datetime, in ISO-8601 format mime-type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Mime-Type description: MIME type type: object required: - - data + - data title: AttachDecorator description: AttachDecorator AttachDecorator-Output: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Attachment identifier byte_count: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Byte Count description: Byte count of data included by reference data: - $ref: "#/components/schemas/AttachDecoratorData-Output" + $ref: '#/components/schemas/AttachDecoratorData-Output' description: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Description description: Human-readable description of content filename: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Filename description: File name lastmod_time: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Lastmod Time description: Hint regarding last modification datetime, in ISO-8601 format mime-type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Mime-Type description: MIME type type: object required: - - data + - data title: AttachDecorator description: AttachDecorator AttachDecoratorData-Input: properties: base64: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Base64 description: Base64-encoded data json: anyOf: - - type: object - - items: - type: object - type: array - - type: "null" + - type: object + - items: + type: object + type: array + - type: 'null' title: Json description: JSON-serialized data jws: anyOf: - - $ref: "#/components/schemas/AttachDecoratorDataJWS-Input" - - type: "null" + - $ref: '#/components/schemas/AttachDecoratorDataJWS-Input' + - type: 'null' description: Detached Java Web Signature links: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Links description: List of hypertext links to data sha256: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Sha256 description: SHA256 hash (binhex encoded) of content type: object @@ -3186,36 +3186,36 @@ components: properties: base64: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Base64 description: Base64-encoded data json: anyOf: - - type: object - - items: - type: object - type: array - - type: "null" + - type: object + - items: + type: object + type: array + - type: 'null' title: Json description: JSON-serialized data jws: anyOf: - - $ref: "#/components/schemas/AttachDecoratorDataJWS-Output" - - type: "null" + - $ref: '#/components/schemas/AttachDecoratorDataJWS-Output' + - type: 'null' description: Detached Java Web Signature links: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Links description: List of hypertext links to data sha256: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Sha256 description: SHA256 hash (binhex encoded) of content type: object @@ -3224,11 +3224,11 @@ components: AttachDecoratorData1JWS: properties: header: - $ref: "#/components/schemas/AttachDecoratorDataJWSHeader" + $ref: '#/components/schemas/AttachDecoratorDataJWSHeader' protected: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Protected description: protected JWS header signature: @@ -3237,34 +3237,34 @@ components: description: signature type: object required: - - header - - signature + - header + - signature title: AttachDecoratorData1JWS description: AttachDecoratorData1JWS AttachDecoratorDataJWS-Input: properties: header: anyOf: - - $ref: "#/components/schemas/AttachDecoratorDataJWSHeader" - - type: "null" + - $ref: '#/components/schemas/AttachDecoratorDataJWSHeader' + - type: 'null' protected: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Protected description: protected JWS header signature: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Signature description: signature signatures: anyOf: - - items: - $ref: "#/components/schemas/AttachDecoratorData1JWS" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/AttachDecoratorData1JWS' + type: array + - type: 'null' title: Signatures description: List of signatures type: object @@ -3274,26 +3274,26 @@ components: properties: header: anyOf: - - $ref: "#/components/schemas/AttachDecoratorDataJWSHeader" - - type: "null" + - $ref: '#/components/schemas/AttachDecoratorDataJWSHeader' + - type: 'null' protected: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Protected description: protected JWS header signature: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Signature description: signature signatures: anyOf: - - items: - $ref: "#/components/schemas/AttachDecoratorData1JWS" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/AttachDecoratorData1JWS' + type: array + - type: 'null' title: Signatures description: List of signatures type: object @@ -3307,21 +3307,21 @@ components: description: Key identifier, in W3C did:key or DID URL format type: object required: - - kid + - kid title: AttachDecoratorDataJWSHeader description: AttachDecoratorDataJWSHeader AttachmentDef: properties: id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Id description: Attachment identifier type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Type description: Attachment type type: object @@ -3331,10 +3331,10 @@ components: properties: results: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Results type: object title: AttributeMimeTypesResult @@ -3343,38 +3343,38 @@ components: properties: di_vc: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Di Vc jwt: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Jwt jwt_vc: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Jwt Vc jwt_vp: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Jwt Vp ldp: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Ldp ldp_vc: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Ldp Vc ldp_vp: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Ldp Vp type: object title: ClaimFormat @@ -3409,7 +3409,7 @@ components: request has been completed. type: object required: - - revocation_registry_credential_map + - revocation_registry_credential_map title: ClearPendingRevocationsResult ConnectToPublicDid: properties: @@ -3418,151 +3418,151 @@ components: title: Public Did type: object required: - - public_did + - public_did title: ConnectToPublicDid Connection: properties: alias: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alias connection_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Connection Id connection_protocol: anyOf: - - type: string - enum: - - connections/1.0 - - didexchange/1.0 - - type: "null" + - type: string + enum: + - connections/1.0 + - didexchange/1.0 + - type: 'null' title: Connection Protocol created_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created At error_msg: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error Msg invitation_key: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Invitation Key invitation_mode: anyOf: - - type: string - enum: - - once - - multi - - static - - type: "null" + - type: string + enum: + - once + - multi + - static + - type: 'null' title: Invitation Mode invitation_msg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Invitation Msg Id my_did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: My Did state: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: State their_did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Their Did their_label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Their Label their_public_did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Their Public Did their_role: anyOf: - - type: string - enum: - - invitee - - requester - - inviter - - responder - - type: "null" + - type: string + enum: + - invitee + - requester + - inviter + - responder + - type: 'null' title: Their Role updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At type: object title: Connection ConnectionInvitation: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did description: DID for connection invitation imageUrl: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Imageurl description: Optional image URL for connection invitation label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Label description: Optional label for connection invitation recipientKeys: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Recipientkeys description: List of recipient keys routingKeys: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Routingkeys description: List of routing keys serviceEndpoint: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Serviceendpoint description: Service endpoint at which to reach this agent type: object @@ -3572,43 +3572,43 @@ components: properties: fields: anyOf: - - items: - $ref: "#/components/schemas/DIFField" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/DIFField' + type: array + - type: 'null' title: Fields is_holder: anyOf: - - items: - $ref: "#/components/schemas/DIFHolder" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/DIFHolder' + type: array + - type: 'null' title: Is Holder limit_disclosure: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Limit Disclosure description: LimitDisclosure status_active: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Status Active status_revoked: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Status Revoked status_suspended: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Status Suspended subject_is_issuer: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Subject Is Issuer description: SubjectIsIssuer type: object @@ -3620,27 +3620,27 @@ components: type: string title: Schema Id examples: - - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 + - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 tag: type: string title: Tag examples: - - default + - default support_revocation: type: boolean title: Support Revocation default: false type: object required: - - schema_id - - tag + - schema_id + - tag title: CreateCredentialDefinition CreateInvitation: properties: alias: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alias multi_use: type: boolean @@ -3656,53 +3656,53 @@ components: properties: save_exchange_record: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Save Exchange Record description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete. type: - $ref: "#/components/schemas/CredentialType" + $ref: '#/components/schemas/CredentialType' default: indy indy_credential_detail: anyOf: - - $ref: "#/components/schemas/IndyCredential" - - type: "null" + - $ref: '#/components/schemas/IndyCredential' + - type: 'null' ld_credential_detail: anyOf: - - $ref: "#/components/schemas/LDProofVCDetail" - - type: "null" + - $ref: '#/components/schemas/LDProofVCDetail' + - type: 'null' type: object title: CreateOffer CreateOobInvitation: properties: alias: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alias multi_use: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Multi Use use_public_did: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Use Public Did attachments: anyOf: - - items: - $ref: "#/components/schemas/AttachmentDef" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/AttachmentDef' + type: array + - type: 'null' title: Attachments create_connection: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Create Connection type: object title: CreateOobInvitation @@ -3710,28 +3710,28 @@ components: properties: save_exchange_record: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Save Exchange Record description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete. comment: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Comment type: - $ref: "#/components/schemas/ProofRequestType" + $ref: '#/components/schemas/ProofRequestType' default: indy indy_proof_request: anyOf: - - $ref: "#/components/schemas/IndyProofRequest-Input" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequest-Input' + - type: 'null' dif_proof_request: anyOf: - - $ref: "#/components/schemas/DIFProofRequest" - - type: "null" + - $ref: '#/components/schemas/DIFProofRequest' + - type: 'null' type: object title: CreateProofRequest CreateSchema: @@ -3740,34 +3740,34 @@ components: type: string title: Name examples: - - test_schema + - test_schema version: type: string title: Version examples: - - 0.3.0 + - '0.3' attribute_names: items: type: string type: array title: Attribute Names examples: - - - name - - age + - - name + - age type: object required: - - name - - version - - attribute_names + - name + - version + - attribute_names title: CreateSchema CredInfoList: properties: results: anyOf: - - items: - $ref: "#/components/schemas/app__models__wallet__IndyCredInfo" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/app__models__wallet__IndyCredInfo' + type: array + - type: 'null' title: Results type: object title: CredInfoList @@ -3775,8 +3775,8 @@ components: properties: revoked: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Revoked description: Whether credential is revoked on the ledger type: object @@ -3784,32 +3784,32 @@ components: description: CredRevokedResult Credential: properties: - "@context": + '@context': items: anyOf: - - type: string - - type: object + - type: string + - type: object type: array - title: "@Context" + title: '@Context' description: The JSON-LD context of the credential credentialStatus: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Credentialstatus credentialSubject: type: object title: Credentialsubject expirationDate: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Expirationdate description: The expiration date id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Id description: The ID of the credential issuanceDate: @@ -3818,15 +3818,15 @@ components: description: The issuance date issuer: anyOf: - - type: string - - type: object + - type: string + - type: object title: Issuer description: The JSON-LD Verifiable Credential Issuer. Either string of object with id field. proof: anyOf: - - $ref: "#/components/schemas/LinkedDataProof" - - type: "null" + - $ref: '#/components/schemas/LinkedDataProof' + - type: 'null' description: The proof of the credential type: items: @@ -3840,11 +3840,11 @@ components: default: {} type: object required: - - "@context" - - credentialSubject - - issuanceDate - - issuer - - type + - '@context' + - credentialSubject + - issuanceDate + - issuer + - type title: Credential description: Credential CredentialDefinition: @@ -3853,44 +3853,44 @@ components: type: string title: Id examples: - - 5Q1Zz9foMeAA8Q7mrmzCfZ:3:CL:7:default + - 5Q1Zz9foMeAA8Q7mrmzCfZ:3:CL:7:default tag: type: string title: Tag examples: - - default + - default schema_id: type: string title: Schema Id examples: - - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 + - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 type: object required: - - id - - tag - - schema_id + - id + - tag + - schema_id title: CredentialDefinition CredentialExchange: properties: attributes: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Attributes connection_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Connection Id created_at: type: string title: Created At credential_definition_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Credential Definition Id credential_id: type: string @@ -3901,47 +3901,47 @@ components: title: Credential Exchange Id did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did error_msg: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error Msg role: type: string enum: - - issuer - - holder + - issuer + - holder title: Role schema_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Schema Id state: anyOf: - - type: string - enum: - - proposal-sent - - proposal-received - - offer-sent - - offer-received - - request-sent - - request-received - - credential-issued - - credential-received - - credential-revoked - - abandoned - - done - - deleted - - type: "null" + - type: string + enum: + - proposal-sent + - proposal-received + - offer-sent + - offer-received + - request-sent + - request-received + - credential-issued + - credential-received + - credential-revoked + - abandoned + - done + - deleted + - type: 'null' title: State thread_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Thread Id type: type: string @@ -3952,11 +3952,11 @@ components: title: Updated At type: object required: - - created_at - - credential_id - - credential_exchange_id - - role - - updated_at + - created_at + - credential_id + - credential_exchange_id + - role + - updated_at title: CredentialExchange CredentialSchema: properties: @@ -3964,31 +3964,31 @@ components: type: string title: Id examples: - - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 + - CXQseFxV34pcb8vf32XhEa:2:test_schema:0.3 name: type: string title: Name examples: - - test_schema + - test_schema version: type: string title: Version examples: - - 0.3.0 + - '0.3' attribute_names: items: type: string type: array title: Attribute Names examples: - - - name - - age + - - name + - age type: object required: - - id - - name - - version - - attribute_names + - id + - name + - version + - attribute_names title: CredentialSchema CredentialStatusOptions: properties: @@ -4004,15 +4004,15 @@ components: default: {} type: object required: - - type + - type title: CredentialStatusOptions description: CredentialStatusOptions CredentialType: type: string enum: - - indy - - jwt - - ld_proof + - indy + - jwt + - ld_proof title: CredentialType DID: properties: @@ -4023,35 +4023,35 @@ components: key_type: type: string enum: - - ed25519 - - x25519 - - bls12381g1 - - bls12381g2 - - bls12381g1g2 + - ed25519 + - x25519 + - bls12381g1 + - bls12381g2 + - bls12381g1g2 title: Key Type description: Key type associated with the DID metadata: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Metadata description: Additional metadata associated with the DID method: type: string enum: - - sov - - key - - web - - did:peer:2 - - did:peer:4 + - sov + - key + - web + - did:peer:2 + - did:peer:4 title: Method description: Did method associated with the DID posture: type: string enum: - - public - - posted - - wallet_only + - public + - posted + - wallet_only title: Posture description: Whether DID is current public DID, posted to ledger but not current public DID, or local to the wallet @@ -4061,83 +4061,83 @@ components: description: Public verification key type: object required: - - did - - key_type - - method - - posture - - verkey + - did + - key_type + - method + - posture + - verkey title: DID description: DID DIDCreate: properties: method: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Method description: Method for the requested DID. Supported methods are 'sov', 'key', 'web', 'did:peer:2', or 'did:peer:4'. default: sov examples: - - sov - - key - - web - - did:peer:2 - - did:peer:4 + - sov + - key + - web + - did:peer:2 + - did:peer:4 options: anyOf: - - $ref: "#/components/schemas/DIDCreateOptions" - - type: "null" + - $ref: '#/components/schemas/DIDCreateOptions' + - type: 'null' description: (Deprecated) Define a key type and/or a DID depending on the chosen DID method. deprecated: true examples: - - did: did:peer:2... - key_type: ed25519 + - did: did:peer:2... + key_type: ed25519 seed: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Seed description: Optional seed to use for DID. Must be enabled in configuration before use. key_type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Key Type description: Key type to use for the DID key_pair. Validated with the chosen DID method's supported key types. default: ed25519 examples: - - ed25519 - - bls12381g2 + - ed25519 + - bls12381g2 did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did description: Specify the final value of DID (including `did::` prefix) if the method supports it. type: object title: DIDCreate - description: "Extends the AcapyDIDCreate model with smart defaults and a simplified + description: 'Extends the AcapyDIDCreate model with smart defaults and a simplified interface. Handles deprecated `options` field from client requests by populating `key_type` and `did`. Downstream processes should use the appropriate `options` structure based - on the model's fields." + on the model''s fields.' DIDCreateOptions: properties: did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did - description: "Specify final value of the did (including did:: prefix)if - the method supports or requires so." + description: 'Specify final value of the did (including did:: prefix)if + the method supports or requires so.' key_type: type: string title: Key Type @@ -4145,7 +4145,7 @@ components: DID method's supported key types. type: object required: - - key_type + - key_type title: DIDCreateOptions description: DIDCreateOptions DIDEndpoint: @@ -4156,21 +4156,21 @@ components: description: DID of interest endpoint: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Endpoint description: Endpoint to set (omit to delete) type: object required: - - did + - did title: DIDEndpoint description: DIDEndpoint DIDXRejectRequest: properties: reason: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Reason description: Reason for rejecting the DID Exchange type: object @@ -4180,31 +4180,31 @@ components: properties: filter: anyOf: - - $ref: "#/components/schemas/Filter" - - type: "null" + - $ref: '#/components/schemas/Filter' + - type: 'null' id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Id description: ID path: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Path predicate: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Predicate description: Preference purpose: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Purpose description: Purpose type: object @@ -4214,16 +4214,16 @@ components: properties: directive: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Directive description: Preference field_id: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Field Id type: object title: DIFHolder @@ -4232,14 +4232,14 @@ components: properties: challenge: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Challenge description: Challenge protect against replay attack domain: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Domain description: Domain protect against replay attack type: object @@ -4249,26 +4249,26 @@ components: properties: issuer_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Issuer Id description: Issuer identifier to sign the presentation, if different from current public DID presentation_definition: anyOf: - - $ref: "#/components/schemas/PresentationDefinition" - - type: "null" + - $ref: '#/components/schemas/PresentationDefinition' + - type: 'null' record_ids: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Record Ids description: Mapping of input_descriptor id to list of stored W3C credential record_id reveal_doc: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Reveal Doc description: reveal doc [JSON-LD frame] dict used to derive the credential when selective disclosure is required @@ -4279,105 +4279,105 @@ components: properties: options: anyOf: - - $ref: "#/components/schemas/DIFOptions" - - type: "null" + - $ref: '#/components/schemas/DIFOptions' + - type: 'null' presentation_definition: - $ref: "#/components/schemas/PresentationDefinition" + $ref: '#/components/schemas/PresentationDefinition' additional_properties: type: object title: Additional Properties default: {} type: object required: - - presentation_definition + - presentation_definition title: DIFProofRequest description: DIFProofRequest Filter: properties: const: anyOf: - - type: string - - type: integer - - type: number - - type: "null" + - type: string + - type: integer + - type: number + - type: 'null' title: Const description: Const enum: anyOf: - - items: - anyOf: - - type: string - - type: integer - - type: number - type: array - - type: "null" + - items: + anyOf: + - type: string + - type: integer + - type: number + type: array + - type: 'null' title: Enum exclusiveMaximum: anyOf: - - type: string - - type: integer - - type: number - - type: "null" + - type: string + - type: integer + - type: number + - type: 'null' title: Exclusivemaximum description: ExclusiveMaximum exclusiveMinimum: anyOf: - - type: string - - type: integer - - type: number - - type: "null" + - type: string + - type: integer + - type: number + - type: 'null' title: Exclusiveminimum description: ExclusiveMinimum format: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Format description: Format maxLength: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Maxlength description: Max Length maximum: anyOf: - - type: string - - type: integer - - type: number - - type: "null" + - type: string + - type: integer + - type: number + - type: 'null' title: Maximum description: Maximum minLength: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Minlength description: Min Length minimum: anyOf: - - type: string - - type: integer - - type: number - - type: "null" + - type: string + - type: integer + - type: number + - type: 'null' title: Minimum description: Minimum not: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Not description: Not pattern: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Pattern description: Pattern type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Type description: Type type: object @@ -4387,24 +4387,24 @@ components: properties: detail: items: - $ref: "#/components/schemas/ValidationError" + $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError Hangup: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type type: object title: Hangup @@ -4412,23 +4412,23 @@ components: IndyCredPrecis: properties: cred_info: - $ref: "#/components/schemas/aries_cloudcontroller__models__indy_cred_info__IndyCredInfo" + $ref: '#/components/schemas/aries_cloudcontroller__models__indy_cred_info__IndyCredInfo' description: Credential info interval: anyOf: - - $ref: "#/components/schemas/IndyNonRevocationInterval" - - type: "null" + - $ref: '#/components/schemas/IndyNonRevocationInterval' + - type: 'null' description: Non-revocation interval from presentation request presentation_referents: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Presentation Referents type: object required: - - cred_info + - cred_info title: IndyCredPrecis description: IndyCredPrecis IndyCredential: @@ -4443,44 +4443,44 @@ components: title: Attributes type: object required: - - credential_definition_id - - attributes + - credential_definition_id + - attributes title: IndyCredential IndyEQProof: properties: a_prime: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: A Prime e: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: E m: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: M m2: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: M2 revealed_attrs: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Revealed Attrs v: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: V type: object title: IndyEQProof @@ -4489,38 +4489,38 @@ components: properties: alpha: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Alpha mj: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Mj predicate: anyOf: - - $ref: "#/components/schemas/IndyGEProofPred" - - type: "null" + - $ref: '#/components/schemas/IndyGEProofPred' + - type: 'null' r: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: R t: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: T u: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: U type: object title: IndyGEProof @@ -4529,20 +4529,20 @@ components: properties: attr_name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Attr Name description: Attribute name, indy-canonicalized p_type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: P Type description: Predicate type value: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Value description: Predicate threshold value type: object @@ -4552,17 +4552,17 @@ components: properties: c_list: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: C List x_list: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: X List type: object title: IndyNonRevocProof @@ -4571,18 +4571,18 @@ components: properties: from: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: From description: Earliest time of interest in non-revocation interval to: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: To description: Latest time of interest in non-revocation interval type: object @@ -4592,14 +4592,14 @@ components: properties: requested_attributes: additionalProperties: - $ref: "#/components/schemas/IndyRequestedCredsRequestedAttr" + $ref: '#/components/schemas/IndyRequestedCredsRequestedAttr' type: object title: Requested Attributes description: Nested object mapping proof request attribute referents to requested-attribute specifiers requested_predicates: additionalProperties: - $ref: "#/components/schemas/IndyRequestedCredsRequestedPred" + $ref: '#/components/schemas/IndyRequestedCredsRequestedPred' type: object title: Requested Predicates description: Nested object mapping proof request predicate referents to @@ -4612,30 +4612,30 @@ components: description: Self-attested attributes to build into proof trace: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Trace description: Whether to trace event (default false) type: object required: - - requested_attributes - - requested_predicates - - self_attested_attributes + - requested_attributes + - requested_predicates + - self_attested_attributes title: IndyPresSpec description: IndyPresSpec IndyPrimaryProof: properties: eq_proof: anyOf: - - $ref: "#/components/schemas/IndyEQProof" - - type: "null" + - $ref: '#/components/schemas/IndyEQProof' + - type: 'null' description: Indy equality proof ge_proofs: anyOf: - - items: - $ref: "#/components/schemas/IndyGEProof" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/IndyGEProof' + type: array + - type: 'null' title: Ge Proofs description: Indy GE proofs type: object @@ -4645,21 +4645,21 @@ components: properties: identifiers: anyOf: - - items: - $ref: "#/components/schemas/IndyProofIdentifier" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/IndyProofIdentifier' + type: array + - type: 'null' title: Identifiers description: Indy proof.identifiers content proof: anyOf: - - $ref: "#/components/schemas/IndyProofProof" - - type: "null" + - $ref: '#/components/schemas/IndyProofProof' + - type: 'null' description: Indy proof.proof content requested_proof: anyOf: - - $ref: "#/components/schemas/IndyProofRequestedProof" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequestedProof' + - type: 'null' description: Indy proof.requested_proof content type: object title: IndyProof @@ -4668,28 +4668,28 @@ components: properties: cred_def_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Def Id description: Credential definition identifier rev_reg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Rev Reg Id description: Revocation registry identifier schema_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Schema Id description: Schema identifier timestamp: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: Timestamp description: Timestamp epoch type: object @@ -4699,15 +4699,15 @@ components: properties: aggregated_proof: anyOf: - - $ref: "#/components/schemas/IndyProofProofAggregatedProof" - - type: "null" + - $ref: '#/components/schemas/IndyProofProofAggregatedProof' + - type: 'null' description: Indy proof aggregated proof proofs: anyOf: - - items: - $ref: "#/components/schemas/IndyProofProofProofsProof" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/IndyProofProofProofsProof' + type: array + - type: 'null' title: Proofs description: Indy proof proofs type: object @@ -4717,18 +4717,18 @@ components: properties: c_hash: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: C Hash description: c_hash value c_list: anyOf: - - items: - items: - type: integer - type: array + - items: + items: + type: integer type: array - - type: "null" + type: array + - type: 'null' title: C List description: c_list value type: object @@ -4738,13 +4738,13 @@ components: properties: non_revoc_proof: anyOf: - - $ref: "#/components/schemas/IndyNonRevocProof" - - type: "null" + - $ref: '#/components/schemas/IndyNonRevocProof' + - type: 'null' description: Indy non-revocation proof primary_proof: anyOf: - - $ref: "#/components/schemas/IndyPrimaryProof" - - type: "null" + - $ref: '#/components/schemas/IndyPrimaryProof' + - type: 'null' description: Indy primary proof type: object title: IndyProofProofProofsProof @@ -4753,35 +4753,35 @@ components: properties: name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Name description: Attribute name names: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Names description: Attribute name group non_revoked: anyOf: - - $ref: "#/components/schemas/IndyProofReqAttrSpecNonRevoked" - - type: "null" + - $ref: '#/components/schemas/IndyProofReqAttrSpecNonRevoked' + - type: 'null' restrictions: anyOf: - - items: - additionalProperties: - type: string - type: object - type: array - - type: "null" + - items: + additionalProperties: + type: string + type: object + type: array + - type: 'null' title: Restrictions - description: "If present, credential must satisfy one of given 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" + represents a credential attribute name' type: object title: IndyProofReqAttrSpec description: IndyProofReqAttrSpec @@ -4789,18 +4789,18 @@ components: properties: from: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: From description: Earliest time of interest in non-revocation interval to: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: To description: Latest time of interest in non-revocation interval type: object @@ -4814,8 +4814,8 @@ components: description: Attribute name non_revoked: anyOf: - - $ref: "#/components/schemas/IndyProofReqPredSpecNonRevoked" - - type: "null" + - $ref: '#/components/schemas/IndyProofReqPredSpecNonRevoked' + - type: 'null' p_type: type: string title: P Type @@ -4826,40 +4826,40 @@ components: description: Threshold value restrictions: anyOf: - - items: - additionalProperties: - type: string - type: object - type: array - - type: "null" + - items: + additionalProperties: + type: string + type: object + type: array + - type: 'null' title: Restrictions - description: "If present, credential must satisfy one of given 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" + represents a credential attribute name' type: object required: - - name - - p_type - - p_value + - name + - p_type + - p_value title: IndyProofReqPredSpec description: IndyProofReqPredSpec IndyProofReqPredSpecNonRevoked: properties: from: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: From description: Earliest time of interest in non-revocation interval to: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: To description: Latest time of interest in non-revocation interval type: object @@ -4874,23 +4874,23 @@ components: default: Proof non_revoked: anyOf: - - $ref: "#/components/schemas/IndyProofRequestNonRevoked" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequestNonRevoked' + - type: 'null' nonce: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Nonce description: Nonce requested_attributes: additionalProperties: - $ref: "#/components/schemas/IndyProofReqAttrSpec" + $ref: '#/components/schemas/IndyProofReqAttrSpec' type: object title: Requested Attributes description: Requested attribute specifications of proof request requested_predicates: additionalProperties: - $ref: "#/components/schemas/IndyProofReqPredSpec" + $ref: '#/components/schemas/IndyProofReqPredSpec' type: object title: Requested Predicates description: Requested predicate specifications of proof request @@ -4898,70 +4898,70 @@ components: type: string title: Version description: Proof request version - default: "1.0" + default: '1.0' type: object required: - - requested_attributes - - requested_predicates + - requested_attributes + - requested_predicates title: IndyProofRequest IndyProofRequest-Output: properties: name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Name description: Proof request name non_revoked: anyOf: - - $ref: "#/components/schemas/IndyProofRequestNonRevoked" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequestNonRevoked' + - type: 'null' nonce: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Nonce description: Nonce requested_attributes: additionalProperties: - $ref: "#/components/schemas/IndyProofReqAttrSpec" + $ref: '#/components/schemas/IndyProofReqAttrSpec' type: object title: Requested Attributes description: Requested attribute specifications of proof request requested_predicates: additionalProperties: - $ref: "#/components/schemas/IndyProofReqPredSpec" + $ref: '#/components/schemas/IndyProofReqPredSpec' type: object title: Requested Predicates description: Requested predicate specifications of proof request version: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Version description: Proof request version type: object required: - - requested_attributes - - requested_predicates + - requested_attributes + - requested_predicates title: IndyProofRequest description: IndyProofRequest IndyProofRequestNonRevoked: properties: from: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: From description: Earliest time of interest in non-revocation interval to: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: To description: Latest time of interest in non-revocation interval type: object @@ -4971,38 +4971,38 @@ components: properties: predicates: anyOf: - - additionalProperties: - $ref: "#/components/schemas/IndyProofRequestedProofPredicate" - type: object - - type: "null" + - additionalProperties: + $ref: '#/components/schemas/IndyProofRequestedProofPredicate' + type: object + - type: 'null' title: Predicates description: Proof requested proof predicates. revealed_attr_groups: anyOf: - - additionalProperties: - $ref: "#/components/schemas/IndyProofRequestedProofRevealedAttrGroup" - type: object - - type: "null" + - additionalProperties: + $ref: '#/components/schemas/IndyProofRequestedProofRevealedAttrGroup' + type: object + - type: 'null' title: Revealed Attr Groups description: Proof requested proof revealed attribute groups revealed_attrs: anyOf: - - additionalProperties: - $ref: "#/components/schemas/IndyProofRequestedProofRevealedAttr" - type: object - - type: "null" + - additionalProperties: + $ref: '#/components/schemas/IndyProofRequestedProofRevealedAttr' + type: object + - type: 'null' title: Revealed Attrs description: Proof requested proof revealed attributes self_attested_attrs: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Self Attested Attrs description: Proof requested proof self-attested attributes unrevealed_attrs: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Unrevealed Attrs description: Unrevealed attributes type: object @@ -5012,8 +5012,8 @@ components: properties: sub_proof_index: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Sub Proof Index description: Sub-proof index type: object @@ -5023,20 +5023,20 @@ components: properties: encoded: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Encoded description: Encoded value raw: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Raw description: Raw value sub_proof_index: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Sub Proof Index description: Sub-proof index type: object @@ -5046,16 +5046,16 @@ components: properties: sub_proof_index: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Sub Proof Index description: Sub-proof index values: anyOf: - - additionalProperties: - $ref: "#/components/schemas/RawEncoded" - type: object - - type: "null" + - additionalProperties: + $ref: '#/components/schemas/RawEncoded' + type: object + - type: 'null' title: Values description: Indy proof requested proof revealed attr groups group value type: object @@ -5070,13 +5070,13 @@ components: a UUID) revealed: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Revealed description: Whether to reveal attribute in proof (default true) type: object required: - - cred_id + - cred_id title: IndyRequestedCredsRequestedAttr description: IndyRequestedCredsRequestedAttr IndyRequestedCredsRequestedPred: @@ -5088,58 +5088,58 @@ components: a UUID) timestamp: anyOf: - - type: integer - maximum: 1.8446744073709552e+19 - minimum: 0.0 - - type: "null" + - type: integer + maximum: 1.8446744073709552e+19 + minimum: 0.0 + - type: 'null' title: Timestamp description: Epoch timestamp of interest for non-revocation proof type: object required: - - cred_id + - cred_id title: IndyRequestedCredsRequestedPred description: IndyRequestedCredsRequestedPred InputDescriptors: properties: constraints: anyOf: - - $ref: "#/components/schemas/Constraints" - - type: "null" + - $ref: '#/components/schemas/Constraints' + - type: 'null' group: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Group id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Id description: ID metadata: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Metadata description: Metadata dictionary name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Name description: Name purpose: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Purpose description: Purpose schema: anyOf: - - $ref: "#/components/schemas/SchemasInputDescriptorFilter" - - type: "null" + - $ref: '#/components/schemas/SchemasInputDescriptorFilter' + - type: 'null' description: Accepts a list of schema or a dict containing filters like oneof_filter. type: object @@ -5147,152 +5147,152 @@ components: description: InputDescriptors InvitationMessage-Input: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type accept: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Accept description: List of mime type in order of preference goal: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Goal description: A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message goal_code: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Goal Code description: A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message handshake_protocols: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Handshake Protocols imageUrl: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Imageurl description: Optional image URL for out-of-band invitation label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Label description: Optional label requests~attach: anyOf: - - items: - $ref: "#/components/schemas/AttachDecorator-Input" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/AttachDecorator-Input' + type: array + - type: 'null' title: Requests~Attach description: Optional request attachment services: anyOf: - - items: - anyOf: - - type: string - - type: object - type: array - - type: "null" + - items: + anyOf: + - type: string + - type: object + type: array + - type: 'null' title: Services type: object title: InvitationMessage description: InvitationMessage InvitationMessage-Output: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type accept: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Accept description: List of mime type in order of preference goal: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Goal description: A self-attested string that the receiver may want to display to the user about the context-specific goal of the out-of-band message goal_code: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Goal Code description: A self-attested code the receiver may want to display to the user or use in automatically deciding what to do with the out-of-band message handshake_protocols: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Handshake Protocols imageUrl: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Imageurl description: Optional image URL for out-of-band invitation label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Label description: Optional label requests~attach: anyOf: - - items: - $ref: "#/components/schemas/AttachDecorator-Output" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/AttachDecorator-Output' + type: array + - type: 'null' title: Requests~Attach description: Optional request attachment services: anyOf: - - items: - anyOf: - - type: string - - type: object - type: array - - type: "null" + - items: + anyOf: + - type: string + - type: object + type: array + - type: 'null' title: Services type: object title: InvitationMessage @@ -5301,55 +5301,55 @@ components: properties: created_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created At description: Time of record creation invi_msg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Invi Msg Id description: Invitation message identifier invitation: anyOf: - - $ref: "#/components/schemas/InvitationMessage-Output" - - type: "null" + - $ref: '#/components/schemas/InvitationMessage-Output' + - type: 'null' description: Out of band invitation message invitation_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Invitation Id description: Invitation record identifier invitation_url: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Invitation Url description: Invitation message URL oob_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Oob Id description: Out of band record identifier state: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: State description: Out of band message exchange state trace: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Trace description: Record trace information, based on agent configuration updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At description: Time of last record update type: object @@ -5362,72 +5362,72 @@ components: title: Connection Id description: Connection identifier invitation: - $ref: "#/components/schemas/ConnectionInvitation" + $ref: '#/components/schemas/ConnectionInvitation' invitation_url: type: string title: Invitation Url description: Invitation URL type: object required: - - connection_id - - invitation - - invitation_url + - connection_id + - invitation + - invitation_url title: InvitationResult description: InvitationResult IssuerCredRevRecord: properties: created_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created At description: Time of record creation cred_def_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Def Id description: Credential definition identifier cred_ex_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Ex Id description: Credential exchange record identifier at credential issue cred_ex_version: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Ex Version description: Credential exchange version cred_rev_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Rev Id description: Credential revocation identifier record_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Record Id description: Issuer credential revocation record identifier rev_reg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Rev Reg Id description: Revocation registry identifier state: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: State description: Issue credential revocation record state updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At description: Time of last record update type: object @@ -5437,11 +5437,11 @@ components: properties: did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq headers: type: object title: Headers @@ -5452,15 +5452,15 @@ components: description: Payload to sign verification_method: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Verification Method description: Information used for proof verification examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq type: object required: - - payload + - payload title: JWSCreateRequest JWSCreateResponse: properties: @@ -5468,10 +5468,10 @@ components: type: string title: Jws examples: - - eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJFZERTQSIsICJraWQiOiAiZGlkOmtleTp6Nk1rakNqeHVUWHhWUFdTOUpZajJaaUt0S3ZTUzFzckM2a0JSZXM0V0NCMm1TV3EjejZNa2pDanh1VFh4VlBXUzlKWWoyWmlLdEt2U1Mxc3JDNmtCUmVzNFdDQjJtU1dxIn0.e30.rOLhhAaMfWb_rFzgKofXRuv72bj7SjRcPieICMV1TE1eJrTG-RoIJ6crrEc_mRmnFtI7dExEZAnCqd4LzGozAA + - eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJFZERTQSIsICJraWQiOiAiZGlkOmtleTp6Nk1rakNqeHVUWHhWUFdTOUpZajJaaUt0S3ZTUzFzckM2a0JSZXM0V0NCMm1TV3EjejZNa2pDanh1VFh4VlBXUzlKWWoyWmlLdEt2U1Mxc3JDNmtCUmVzNFdDQjJtU1dxIn0.e30.rOLhhAaMfWb_rFzgKofXRuv72bj7SjRcPieICMV1TE1eJrTG-RoIJ6crrEc_mRmnFtI7dExEZAnCqd4LzGozAA type: object required: - - jws + - jws title: JWSCreateResponse JWSVerifyRequest: properties: @@ -5479,17 +5479,17 @@ components: type: string title: Jws examples: - - eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJFZERTQSIsICJraWQiOiAiZGlkOmtleTp6Nk1rakNqeHVUWHhWUFdTOUpZajJaaUt0S3ZTUzFzckM2a0JSZXM0V0NCMm1TV3EjejZNa2pDanh1VFh4VlBXUzlKWWoyWmlLdEt2U1Mxc3JDNmtCUmVzNFdDQjJtU1dxIn0.e30.rOLhhAaMfWb_rFzgKofXRuv72bj7SjRcPieICMV1TE1eJrTG-RoIJ6crrEc_mRmnFtI7dExEZAnCqd4LzGozAA + - eyJ0eXAiOiAiSldUIiwgImFsZyI6ICJFZERTQSIsICJraWQiOiAiZGlkOmtleTp6Nk1rakNqeHVUWHhWUFdTOUpZajJaaUt0S3ZTUzFzckM2a0JSZXM0V0NCMm1TV3EjejZNa2pDanh1VFh4VlBXUzlKWWoyWmlLdEt2U1Mxc3JDNmtCUmVzNFdDQjJtU1dxIn0.e30.rOLhhAaMfWb_rFzgKofXRuv72bj7SjRcPieICMV1TE1eJrTG-RoIJ6crrEc_mRmnFtI7dExEZAnCqd4LzGozAA type: object required: - - jws + - jws title: JWSVerifyRequest JWSVerifyResponse: properties: error: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error description: Error text headers: @@ -5497,15 +5497,15 @@ components: title: Headers description: Headers from verified JWT. examples: - - alg: EdDSA - kid: did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq - typ: JWT + - alg: EdDSA + kid: did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + typ: JWT kid: type: string title: Kid description: kid of signer examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq payload: type: object title: Payload @@ -5515,37 +5515,37 @@ components: title: Valid type: object required: - - headers - - kid - - payload - - valid + - headers + - kid + - payload + - valid title: JWSVerifyResponse JsonLdSignRequest: properties: credential_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Credential Id credential: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Credential verkey: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Verkey pub_did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Pub Did signature_options: anyOf: - - $ref: "#/components/schemas/SignatureOptions" - - type: "null" + - $ref: '#/components/schemas/SignatureOptions' + - type: 'null' type: object title: JsonLdSignRequest JsonLdVerifyRequest: @@ -5555,25 +5555,25 @@ components: title: Doc public_did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Public Did verkey: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Verkey type: object required: - - doc + - doc title: JsonLdVerifyRequest LDProofVCDetail: properties: credential: - $ref: "#/components/schemas/Credential" + $ref: '#/components/schemas/Credential' description: Detail of the JSON-LD Credential to be issued options: - $ref: "#/components/schemas/LDProofVCOptions" + $ref: '#/components/schemas/LDProofVCOptions' description: Options for specifying how the linked data proof is created. additional_properties: type: object @@ -5581,57 +5581,57 @@ components: default: {} type: object required: - - credential - - options + - credential + - options title: LDProofVCDetail description: LDProofVCDetail LDProofVCOptions: properties: challenge: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Challenge description: A challenge to include in the proof. SHOULD be provided by the requesting party of the credential (=holder) created: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created description: The date and time of the proof (with a maximum accuracy in seconds). Defaults to current system time credentialStatus: anyOf: - - $ref: "#/components/schemas/CredentialStatusOptions" - - type: "null" + - $ref: '#/components/schemas/CredentialStatusOptions' + - type: 'null' description: The credential status mechanism to use for the credential. Omitting the property indicates the issued credential will not include a credential status domain: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Domain description: The intended domain of validity for the proof proofPurpose: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Proofpurpose description: The proof purpose used for the proof. Should match proof purposes registered in the Linked Data Proofs Specification proofType: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Prooftype description: The proof type used for the proof. Should match suites registered in the Linked Data Cryptographic Suite Registry verificationMethod: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Verificationmethod description: The verification method to use for the proof. Should match a verification method in the wallet @@ -5646,34 +5646,34 @@ components: properties: challenge: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Challenge description: Associates a challenge with a proof, for use with a proofPurpose such as authentication created: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created description: The string value of an ISO8601 combined date and time string generated by the Signature Algorithm domain: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Domain description: A string value specifying the restricted domain of the signature. jws: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Jws description: Associates a Detached Json Web Signature with a proof nonce: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Nonce description: The nonce proofPurpose: @@ -5682,8 +5682,8 @@ components: description: Proof purpose proofValue: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Proofvalue description: The proof value of a proof type: @@ -5701,9 +5701,9 @@ components: default: {} type: object required: - - proofPurpose - - type - - verificationMethod + - proofPurpose + - type + - verificationMethod title: LinkedDataProof description: LinkedDataProof Message: @@ -5716,27 +5716,27 @@ components: title: Content type: object required: - - connection_id - - content + - connection_id + - content title: Message OobRecord: properties: attach_thread_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Attach Thread Id description: Connection record identifier connection_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Connection Id description: Connection record identifier created_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Created At description: Time of record creation invi_msg_id: @@ -5744,12 +5744,12 @@ components: title: Invi Msg Id description: Invitation message identifier invitation: - $ref: "#/components/schemas/InvitationMessage-Output" + $ref: '#/components/schemas/InvitationMessage-Output' description: Out of band invitation message multi_use: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Multi Use description: Allow for multiple uses of the oob invitation oob_id: @@ -5758,14 +5758,14 @@ components: description: Oob record identifier our_recipient_key: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Our Recipient Key description: Recipient key used for oob invitation role: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Role description: OOB Role state: @@ -5774,26 +5774,26 @@ components: description: Out of band message exchange state their_service: anyOf: - - $ref: "#/components/schemas/ServiceDecorator" - - type: "null" + - $ref: '#/components/schemas/ServiceDecorator' + - type: 'null' trace: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Trace description: Record trace information, based on agent configuration updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At description: Time of last record update type: object required: - - invi_msg_id - - invitation - - oob_id - - state + - invi_msg_id + - invitation + - oob_id + - state title: OobRecord description: OobRecord PendingRevocations: @@ -5801,8 +5801,8 @@ components: pending_cred_rev_ids: items: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' type: array title: Pending Cred Rev Ids default: [] @@ -5812,8 +5812,8 @@ components: properties: thread_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Thread Id description: Thread ID of the ping message type: object @@ -5823,41 +5823,41 @@ components: properties: format: anyOf: - - $ref: "#/components/schemas/ClaimFormat" - - type: "null" + - $ref: '#/components/schemas/ClaimFormat' + - type: 'null' id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Id description: Unique Resource Identifier input_descriptors: anyOf: - - items: - $ref: "#/components/schemas/InputDescriptors" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/InputDescriptors' + type: array + - type: 'null' title: Input Descriptors name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Name description: Human-friendly name that describes what the presentation definition pertains to purpose: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Purpose description: Describes the purpose for which the Presentation Definition's inputs are being requested submission_requirements: anyOf: - - items: - $ref: "#/components/schemas/SubmissionRequirements" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/SubmissionRequirements' + type: array + - type: 'null' title: Submission Requirements type: object title: PresentationDefinition @@ -5866,81 +5866,81 @@ components: properties: connection_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Connection Id created_at: type: string title: Created At error_msg: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error Msg parent_thread_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Parent Thread Id presentation: anyOf: - - $ref: "#/components/schemas/IndyProof" - - type: "null" + - $ref: '#/components/schemas/IndyProof' + - type: 'null' presentation_request: anyOf: - - $ref: "#/components/schemas/IndyProofRequest-Output" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequest-Output' + - type: 'null' proof_id: type: string title: Proof Id role: type: string enum: - - prover - - verifier + - prover + - verifier title: Role state: anyOf: - - type: string - enum: - - abandoned - - done - - presentation-received - - presentation-sent - - proposal-received - - proposal-sent - - request-received - - request-sent - - deleted - - type: "null" + - type: string + enum: + - abandoned + - done + - presentation-received + - presentation-sent + - proposal-received + - proposal-sent + - request-received + - request-sent + - deleted + - type: 'null' title: State thread_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Thread Id updated_at: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Updated At verified: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Verified type: object required: - - created_at - - proof_id - - role + - created_at + - proof_id + - role title: PresentationExchange ProofRequestType: type: string enum: - - indy - - jwt - - ld_proof + - indy + - jwt + - ld_proof title: ProofRequestType PublishRevocationsRequest: properties: @@ -5963,14 +5963,14 @@ components: properties: encoded: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Encoded description: Encoded value raw: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Raw description: Raw value type: object @@ -5978,56 +5978,56 @@ components: description: RawEncoded ReceiveInvitationRequest: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did description: DID for connection invitation imageUrl: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Imageurl description: Optional image URL for connection invitation label: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Label description: Optional label for connection invitation recipientKeys: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Recipientkeys description: List of recipient keys routingKeys: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Routingkeys description: List of routing keys serviceEndpoint: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Serviceendpoint description: Service endpoint at which to reach this agent type: object @@ -6051,26 +6051,26 @@ components: default: false type: object required: - - proof_id + - proof_id title: RejectProofRequest RevRegWalletUpdatedResult: properties: accum_calculated: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Accum Calculated description: Calculated accumulator for phantom revocations accum_fixed: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Accum Fixed description: Applied ledger transaction to fix revocations rev_reg_delta: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Rev Reg Delta description: Indy revocation registry delta type: object @@ -6087,7 +6087,7 @@ components: default: false type: object required: - - credential_exchange_id + - credential_exchange_id title: RevokeCredential RevokedResponse: properties: @@ -6106,17 +6106,17 @@ components: title: RevokedResponse Rotate: properties: - "@id": + '@id': anyOf: - - type: string - - type: "null" - title: "@Id" + - type: string + - type: 'null' + title: '@Id' description: Message identifier - "@type": + '@type': anyOf: - - type: string - - type: "null" - title: "@Type" + - type: string + - type: 'null' + title: '@Type' description: Message type to_did: type: string @@ -6124,18 +6124,18 @@ components: description: The DID the rotating party is rotating to type: object required: - - to_did + - to_did title: Rotate description: Rotate SDJWSCreateRequest: properties: did: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Did examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq headers: type: object title: Headers @@ -6146,28 +6146,28 @@ components: description: Payload to sign verification_method: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Verification Method description: Information used for proof verification examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq non_sd_list: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Non Sd List default: [] examples: - - - name - - address - - address.street_address - - nationalities[1:3] + - - name + - address + - address.street_address + - nationalities[1:3] type: object required: - - payload + - payload title: SDJWSCreateRequest SDJWSCreateResponse: properties: @@ -6175,10 +6175,10 @@ components: type: string title: Sd Jws examples: - - eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ + - eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ type: object required: - - sd_jws + - sd_jws title: SDJWSCreateResponse SDJWSVerifyRequest: properties: @@ -6186,17 +6186,17 @@ components: type: string title: Sd Jws examples: - - eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ + - eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk~WyJEM3BUSFdCYWNRcFdpREc2TWZKLUZnIiwgIkRFIl0~WyJPMTFySVRjRTdHcXExYW9oRkd0aDh3IiwgIlNBIl0~WyJkVmEzX1JlTGNsWTU0R1FHZm5oWlRnIiwgInVwZGF0ZWRfYXQiLCAxNTcwMDAwMDAwXQ type: object required: - - sd_jws + - sd_jws title: SDJWSVerifyRequest SDJWSVerifyResponse: properties: error: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error description: Error text headers: @@ -6204,15 +6204,15 @@ components: title: Headers description: Headers from verified JWT. examples: - - alg: EdDSA - kid: did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq - typ: JWT + - alg: EdDSA + kid: did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + typ: JWT kid: type: string title: Kid description: kid of signer examples: - - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq + - did:key:z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq#z6MkjCjxuTXxVPWS9JYj2ZiKtKvSS1srC6kBRes4WCB2mSWq payload: type: object title: Payload @@ -6224,40 +6224,40 @@ components: items: items: anyOf: - - type: string - - type: object + - type: string + - type: object type: array type: array title: Disclosures description: Disclosure arrays associated with the SD-JWT examples: - - - - fx1iT_mETjGiC-JzRARnVg - - name - - Alice - - - n4-t3mlh8jSS6yMIT7QHnA - - street_address - - _sd: - - kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng + - - - fx1iT_mETjGiC-JzRARnVg + - name + - Alice + - - n4-t3mlh8jSS6yMIT7QHnA + - street_address + - _sd: + - kLZrLK7enwfqeOzJ9-Ss88YS3mhjOAEk9lr_ix2Heng type: object required: - - headers - - kid - - payload - - valid - - disclosures + - headers + - kid + - payload + - valid + - disclosures title: SDJWSVerifyResponse SchemaInputDescriptor: properties: required: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Required description: Required uri: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Uri description: URI type: object @@ -6267,18 +6267,18 @@ components: properties: oneof_filter: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Oneof Filter description: oneOf uri_groups: anyOf: - - items: - items: - $ref: "#/components/schemas/SchemaInputDescriptor" - type: array + - items: + items: + $ref: '#/components/schemas/SchemaInputDescriptor' type: array - - type: "null" + type: array + - type: 'null' title: Uri Groups type: object title: SchemasInputDescriptorFilter @@ -6287,62 +6287,62 @@ components: properties: save_exchange_record: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Save Exchange Record description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete. type: - $ref: "#/components/schemas/CredentialType" + $ref: '#/components/schemas/CredentialType' default: indy indy_credential_detail: anyOf: - - $ref: "#/components/schemas/IndyCredential" - - type: "null" + - $ref: '#/components/schemas/IndyCredential' + - type: 'null' ld_credential_detail: anyOf: - - $ref: "#/components/schemas/LDProofVCDetail" - - type: "null" + - $ref: '#/components/schemas/LDProofVCDetail' + - type: 'null' connection_id: type: string title: Connection Id type: object required: - - connection_id + - connection_id title: SendCredential SendProofRequest: properties: save_exchange_record: anyOf: - - type: boolean - - type: "null" + - type: boolean + - type: 'null' title: Save Exchange Record description: Controls exchange record retention after exchange is complete. None uses wallet default (typically to delete), true forces save, false forces delete. comment: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Comment type: - $ref: "#/components/schemas/ProofRequestType" + $ref: '#/components/schemas/ProofRequestType' default: indy indy_proof_request: anyOf: - - $ref: "#/components/schemas/IndyProofRequest-Input" - - type: "null" + - $ref: '#/components/schemas/IndyProofRequest-Input' + - type: 'null' dif_proof_request: anyOf: - - $ref: "#/components/schemas/DIFProofRequest" - - type: "null" + - $ref: '#/components/schemas/DIFProofRequest' + - type: 'null' connection_id: type: string title: Connection Id type: object required: - - connection_id + - connection_id title: SendProofRequest ServiceDecorator: properties: @@ -6354,10 +6354,10 @@ components: description: List of recipient keys routingKeys: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Routingkeys description: List of routing keys serviceEndpoint: @@ -6366,8 +6366,8 @@ components: description: Service endpoint at which to reach this agent type: object required: - - recipientKeys - - serviceEndpoint + - recipientKeys + - serviceEndpoint title: ServiceDecorator description: ServiceDecorator SetDidEndpointRequest: @@ -6377,20 +6377,20 @@ components: title: Endpoint type: object required: - - endpoint + - endpoint title: SetDidEndpointRequest SignResponse: properties: error: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Error description: Error text signed_doc: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Signed Doc description: Signed document type: object @@ -6400,80 +6400,80 @@ components: properties: challenge: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Challenge domain: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Domain proofPurpose: type: string title: Proofpurpose type: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Type verificationMethod: type: string title: Verificationmethod type: object required: - - proofPurpose - - verificationMethod + - proofPurpose + - verificationMethod title: SignatureOptions description: SignatureOptions SubmissionRequirements: properties: count: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Count description: Count Value from: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: From description: From from_nested: anyOf: - - items: - $ref: "#/components/schemas/SubmissionRequirements" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/SubmissionRequirements' + type: array + - type: 'null' title: From Nested max: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Max description: Max Value min: anyOf: - - type: integer - - type: "null" + - type: integer + - type: 'null' title: Min description: Min Value name: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Name description: Name purpose: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Purpose description: Purpose rule: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Rule description: Selection type: object @@ -6489,56 +6489,56 @@ components: title: Comment type: object required: - - connection_id - - comment + - connection_id + - comment title: TrustPingMsg VCRecord: properties: contexts: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Contexts cred_tags: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Cred Tags cred_value: anyOf: - - type: object - - type: "null" + - type: object + - type: 'null' title: Cred Value description: (JSON-serializable) credential value expanded_types: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Expanded Types given_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Given Id description: Credential identifier issuer_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Issuer Id description: Issuer identifier proof_types: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Proof Types credential_id: type: string @@ -6547,17 +6547,17 @@ components: deprecated: true schema_ids: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Schema Ids subject_ids: anyOf: - - items: - type: string - type: array - - type: "null" + - items: + type: string + type: array + - type: 'null' title: Subject Ids record_id: type: string @@ -6565,17 +6565,17 @@ components: description: Credential identifier type: object required: - - credential_id - - record_id + - credential_id + - record_id title: VCRecord VCRecordList: properties: results: anyOf: - - items: - $ref: "#/components/schemas/VCRecord" - type: array - - type: "null" + - items: + $ref: '#/components/schemas/VCRecord' + type: array + - type: 'null' title: Results type: object title: VCRecordList @@ -6584,8 +6584,8 @@ components: loc: items: anyOf: - - type: string - - type: integer + - type: string + - type: integer type: array title: Location msg: @@ -6596,30 +6596,30 @@ components: title: Error Type type: object required: - - loc - - msg - - type + - loc + - msg + - type title: ValidationError app__models__wallet__IndyCredInfo: properties: attrs: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Attrs description: Attribute names and value cred_def_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Def Id description: Credential definition identifier cred_rev_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Rev Id description: Credential revocation identifier credential_id: @@ -6629,14 +6629,14 @@ components: deprecated: true rev_reg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Rev Reg Id description: Revocation registry identifier schema_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Schema Id description: Schema identifier referent: @@ -6645,47 +6645,47 @@ components: description: Credential identifier type: object required: - - credential_id - - referent + - credential_id + - referent title: IndyCredInfo aries_cloudcontroller__models__indy_cred_info__IndyCredInfo: properties: attrs: anyOf: - - additionalProperties: - type: string - type: object - - type: "null" + - additionalProperties: + type: string + type: object + - type: 'null' title: Attrs description: Attribute names and value cred_def_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Def Id description: Credential definition identifier cred_rev_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Cred Rev Id description: Credential revocation identifier referent: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Referent description: Wallet referent rev_reg_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Rev Reg Id description: Revocation registry identifier schema_id: anyOf: - - type: string - - type: "null" + - type: string + - type: 'null' title: Schema Id description: Schema identifier type: object diff --git a/scripts/download_openapi_specs.sh b/scripts/download_openapi_specs.sh new file mode 100644 index 0000000000..5890261893 --- /dev/null +++ b/scripts/download_openapi_specs.sh @@ -0,0 +1,47 @@ +#!/bin/bash + +# Base URLs +BASE_URL="http://cloudapi.127.0.0.1.nip.io" + +# Declare an associative array with endpoints and prefixes +declare -A ENDPOINTS=( + ["tenant-admin/openapi.json"]="tenant-admin-" + ["tenant-admin/openapi.yaml"]="tenant-admin-" + ["tenant/openapi.json"]="tenant-" + ["tenant/openapi.yaml"]="tenant-" +) + +# Directory to store downloaded files +OUTPUT_DIR="docs/openapi" +mkdir -p "$OUTPUT_DIR" + +# Loop through endpoints and download each file +for ENDPOINT in "${!ENDPOINTS[@]}"; do + PREFIX=${ENDPOINTS[$ENDPOINT]} + FILENAME="${PREFIX}$(basename "$ENDPOINT")" + FILEPATH="$OUTPUT_DIR/$FILENAME" + TEMPFILE="${FILEPATH}.tmp" + + echo "Downloading: $BASE_URL/$ENDPOINT -> $FILEPATH" + curl -s -o "$FILEPATH" "$BASE_URL/$ENDPOINT" + + if [[ $? -eq 0 ]]; then + echo "Downloaded successfully: $FILEPATH" + + # Format JSON files + if [[ "$FILENAME" == *.json ]]; then + jq . "$FILEPATH" > "$TEMPFILE" && mv "$TEMPFILE" "$FILEPATH" + echo "Formatted JSON: $FILEPATH" + fi + + # Remove temporary file if it exists + if [[ -f "$TEMPFILE" ]]; then + rm "$TEMPFILE" + fi + + else + echo "Failed to download: $BASE_URL/$ENDPOINT" + fi +done + +echo "All downloads completed!" diff --git a/scripts/k6/README.md b/scripts/k6/README.md index 289dea21ae..27c5325ddc 100644 --- a/scripts/k6/README.md +++ b/scripts/k6/README.md @@ -23,7 +23,7 @@ cp env.local .env.local ### Shipping local k6 metrics to Datadog -``` +```sh DOCKER_CONTENT_TRUST=1 \ docker run -d \ --name datadog \ diff --git a/scripts/k6/scripts/collection_batch.sh b/scripts/k6/scripts/collection_batch.sh index f6568914fa..bd42629293 100644 --- a/scripts/k6/scripts/collection_batch.sh +++ b/scripts/k6/scripts/collection_batch.sh @@ -59,7 +59,7 @@ scenario_create_credentials() { local original_vus=${BASE_VUS} local original_iters=${BASE_ITERATIONS} - calculate_create_creds_load ${original_vus} ${original_iters} + calculate_create_creds_load "${original_vus}" "${original_iters}" run_test ./scenarios/create-credentials.js }