diff --git a/open-api/openapi.json b/open-api/openapi.json index 9f061e4426..afd7acfa1f 100644 --- a/open-api/openapi.json +++ b/open-api/openapi.json @@ -70,7 +70,7 @@ }, "name" : "did-exchange" }, { - "description" : "Rorate a DID", + "description" : "Rotate a DID", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate" @@ -1103,7 +1103,7 @@ "type" : "string" } }, { - "description" : "Identifier of the associated Invitation Mesage", + "description" : "Identifier of the associated Invitation Message", "in" : "query", "name" : "invitation_msg_id", "schema" : { @@ -1122,7 +1122,7 @@ "in" : "query", "name" : "state", "schema" : { - "enum" : [ "abandoned", "init", "active", "start", "invitation", "completed", "request", "response", "error" ], + "enum" : [ "invitation", "active", "completed", "request", "abandoned", "response", "start", "init", "error" ], "type" : "string" } }, { @@ -3945,7 +3945,7 @@ "type" : "string" } }, { - "description" : "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", + "description" : "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", "in" : "query", "name" : "role", "schema" : { @@ -8059,7 +8059,7 @@ "type" : "object" }, "image_url" : { - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example" : "https://aries.ca/images/sample.png", "type" : "string" }, @@ -8070,12 +8070,12 @@ "type" : "string" }, "label" : { - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example" : "Alice", "type" : "string" }, "wallet_dispatch_type" : { - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "description" : "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum" : [ "default", "both", "base" ], "example" : "default", "type" : "string" @@ -8160,7 +8160,7 @@ "CreateWalletTokenRequest" : { "properties" : { "wallet_key" : { - "description" : "Master key used for key derivation. Only required for unamanged wallets.", + "description" : "Master key used for key derivation. Only required for unmanaged wallets.", "example" : "MySecretKey123", "type" : "string" } @@ -8212,7 +8212,7 @@ "type" : "string" }, "tag" : { - "description" : "The tag value passed in by the Issuer to\n an AnonCred's Credential Definition create and store implementation.", + "description" : "The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation.", "example" : "default", "type" : "string" }, @@ -8229,12 +8229,12 @@ "CredDefPostOptions" : { "properties" : { "create_transaction_for_endorser" : { - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign.", + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example" : false, "type" : "boolean" }, "endorser_connection_id" : { - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection.", + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" }, @@ -8866,7 +8866,7 @@ "$ref" : "#/components/schemas/DIDCreate_options" }, "seed" : { - "description" : "Optional seed to use for DID, Must beenabled in configuration before use.", + "description" : "Optional seed to use for DID, Must be enabled in configuration before use.", "example" : "000000000000000000000000Trustee1", "type" : "string" } @@ -11982,12 +11982,12 @@ "PublishRevocationsOptions" : { "properties" : { "create_transaction_for_endorser" : { - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign.", + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example" : false, "type" : "boolean" }, "endorser_connection_id" : { - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection.", + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" } @@ -12180,7 +12180,7 @@ "RemoveWalletRequest" : { "properties" : { "wallet_key" : { - "description" : "Master key used for key derivation. Only required for unmanaged wallets.", + "description" : "Master key used for key derivation. Only required for unmanaged wallets.", "example" : "MySecretKey123", "type" : "string" } @@ -12206,7 +12206,7 @@ "RevList" : { "properties" : { "currentAccumulator" : { - "description" : "The current accumalator value", + "description" : "The current accumulator value", "example" : "21 118...1FB", "type" : "string" }, @@ -12253,12 +12253,12 @@ "RevListOptions" : { "properties" : { "create_transaction_for_endorser" : { - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign.", + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example" : false, "type" : "boolean" }, "endorser_connection_id" : { - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection.", + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" } @@ -12355,12 +12355,12 @@ "RevRegDefOptions" : { "properties" : { "create_transaction_for_endorser" : { - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign.", + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example" : false, "type" : "boolean" }, "endorser_connection_id" : { - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection.", + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" } @@ -12863,12 +12863,12 @@ "SchemaPostOption" : { "properties" : { "create_transaction_for_endorser" : { - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign.", + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign.", "example" : false, "type" : "boolean" }, "endorser_connection_id" : { - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection.", + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection.", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" } @@ -13259,7 +13259,7 @@ "type" : "string" }, "connection_id" : { - "description" : "The connection identifier for thie particular transaction record", + "description" : "The connection identifier for this particular transaction record", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type" : "string" }, @@ -13457,17 +13457,17 @@ "type" : "object" }, "image_url" : { - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection.", "example" : "https://aries.ca/images/sample.png", "type" : "string" }, "label" : { - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection.", "example" : "Alice", "type" : "string" }, "wallet_dispatch_type" : { - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "description" : "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum" : [ "default", "both", "base" ], "example" : "default", "type" : "string" @@ -16490,7 +16490,7 @@ "allOf" : [ { "$ref" : "#/components/schemas/DIFPresSpec" } ], - "description" : "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest", + "description" : "Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest", "type" : "object" }, "V20PresSpecByFormatRequest_indy" : { @@ -16510,7 +16510,7 @@ }, "securitySchemes" : { "AuthorizationHeader" : { - "description" : "Bearer token. Be sure to preprend token with 'Bearer '", + "description" : "Bearer token. Be sure to prepend token with 'Bearer '", "in" : "header", "name" : "Authorization", "type" : "apiKey" diff --git a/open-api/swagger.json b/open-api/swagger.json index 911260e44e..981f533018 100644 --- a/open-api/swagger.json +++ b/open-api/swagger.json @@ -65,7 +65,7 @@ } }, { "name" : "did-rotate", - "description" : "Rorate a DID", + "description" : "Rotate a DID", "externalDocs" : { "description" : "Specification", "url" : "https://github.com/hyperledger/aries-rfcs/tree/main/features/0794-did-rotate" @@ -940,7 +940,7 @@ }, { "name" : "invitation_msg_id", "in" : "query", - "description" : "Identifier of the associated Invitation Mesage", + "description" : "Identifier of the associated Invitation Message", "required" : false, "type" : "string" }, { @@ -956,7 +956,7 @@ "description" : "Connection state", "required" : false, "type" : "string", - "enum" : [ "abandoned", "init", "active", "start", "invitation", "completed", "request", "response", "error" ] + "enum" : [ "invitation", "active", "completed", "request", "abandoned", "response", "start", "init", "error" ] }, { "name" : "their_did", "in" : "query", @@ -3258,7 +3258,7 @@ }, { "name" : "role", "in" : "query", - "description" : "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", + "description" : "Filer on role, 'client' for keys mediated by other agents, 'server' for keys mediated by this agent", "required" : false, "type" : "string", "default" : "server", @@ -6004,7 +6004,7 @@ }, "securityDefinitions" : { "AuthorizationHeader" : { - "description" : "Bearer token. Be sure to preprend token with 'Bearer '", + "description" : "Bearer token. Be sure to prepend token with 'Bearer '", "type" : "apiKey", "name" : "Authorization", "in" : "header" @@ -6753,7 +6753,7 @@ "image_url" : { "type" : "string", "example" : "https://aries.ca/images/sample.png", - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." }, "key_management_mode" : { "type" : "string", @@ -6764,12 +6764,12 @@ "label" : { "type" : "string", "example" : "Alice", - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." }, "wallet_dispatch_type" : { "type" : "string", "example" : "default", - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "description" : "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum" : [ "default", "both", "base" ] }, "wallet_key" : { @@ -6854,7 +6854,7 @@ "wallet_key" : { "type" : "string", "example" : "MySecretKey123", - "description" : "Master key used for key derivation. Only required for unamanged wallets." + "description" : "Master key used for key derivation. Only required for unmanaged wallets." } } }, @@ -6906,7 +6906,7 @@ "tag" : { "type" : "string", "example" : "default", - "description" : "The tag value passed in by the Issuer to\n an AnonCred's Credential Definition create and store implementation." + "description" : "The tag value passed in by the Issuer to an AnonCred's Credential Definition create and store implementation." }, "type" : { "type" : "string", @@ -6923,12 +6923,12 @@ "create_transaction_for_endorser" : { "type" : "boolean", "example" : false, - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign." + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." }, "endorser_connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection." + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." }, "revocation_registry_size" : { "type" : "integer", @@ -7554,7 +7554,7 @@ "seed" : { "type" : "string", "example" : "000000000000000000000000Trustee1", - "description" : "Optional seed to use for DID, Must beenabled in configuration before use." + "description" : "Optional seed to use for DID, Must be enabled in configuration before use." } } }, @@ -10662,12 +10662,12 @@ "create_transaction_for_endorser" : { "type" : "boolean", "example" : false, - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign." + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." }, "endorser_connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection." + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." } } }, @@ -10860,7 +10860,7 @@ "wallet_key" : { "type" : "string", "example" : "MySecretKey123", - "description" : "Master key used for key derivation. Only required for unmanaged wallets." + "description" : "Master key used for key derivation. Only required for unmanaged wallets." } } }, @@ -10886,7 +10886,7 @@ "currentAccumulator" : { "type" : "string", "example" : "21 118...1FB", - "description" : "The current accumalator value" + "description" : "The current accumulator value" }, "issuerId" : { "type" : "string", @@ -10934,12 +10934,12 @@ "create_transaction_for_endorser" : { "type" : "boolean", "example" : false, - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign." + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." }, "endorser_connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection." + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." } } }, @@ -11036,12 +11036,12 @@ "create_transaction_for_endorser" : { "type" : "boolean", "example" : false, - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign." + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." }, "endorser_connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection." + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." } } }, @@ -11542,12 +11542,12 @@ "create_transaction_for_endorser" : { "type" : "boolean", "example" : false, - "description" : "\n Create transaction for endorser (optional, default false). \n Use this for agents who don't specify an author role but want to \n create a transaction for an endorser to sign." + "description" : "Create transaction for endorser (optional, default false). Use this for agents who don't specify an author role but want to create a transaction for an endorser to sign." }, "endorser_connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "\n Connection identifier (optional) (this is an example)\n You can set this is you know the endorsers connection id you want to use.\n If not specified then the agent will attempt to find an endorser connection." + "description" : "Connection identifier (optional) (this is an example). You can set this if you know the endorser's connection id you want to use. If not specified then the agent will attempt to find an endorser connection." } } }, @@ -11938,7 +11938,7 @@ "connection_id" : { "type" : "string", "example" : "3fa85f64-5717-4562-b3fc-2c963f66afa6", - "description" : "The connection identifier for thie particular transaction record" + "description" : "The connection identifier for this particular transaction record" }, "created_at" : { "type" : "string", @@ -12136,17 +12136,17 @@ "image_url" : { "type" : "string", "example" : "https://aries.ca/images/sample.png", - "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." + "description" : "Image url for this wallet. This image url is publicized (self-attested) to other agents as part of forming a connection." }, "label" : { "type" : "string", "example" : "Alice", - "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." + "description" : "Label for this wallet. This label is publicized (self-attested) to other agents as part of forming a connection." }, "wallet_dispatch_type" : { "type" : "string", "example" : "default", - "description" : "Webhook target dispatch type for this wallet. default - Dispatch only to webhooks associated with this wallet. base - Dispatch only to webhooks associated with the base wallet. both - Dispatch to both webhook targets.", + "description" : "Webhook target dispatch type for this wallet. default: Dispatch only to webhooks associated with this wallet. base: Dispatch only to webhooks associated with the base wallet. both: Dispatch to both webhook targets.", "enum" : [ "default", "both", "base" ] }, "wallet_webhook_urls" : { @@ -14822,7 +14822,7 @@ }, "V20PresSpecByFormatRequest_dif" : { "type" : "object", - "description" : "Optional Presentation specification for DIF, overrides the PresentionExchange record's PresRequest" + "description" : "Optional Presentation specification for DIF, overrides the PresentationExchange record's PresRequest" }, "V20PresSpecByFormatRequest_indy" : { "type" : "object",