Skip to content

Commit

Permalink
Update openapi spec
Browse files Browse the repository at this point in the history 
Signed-off-by: ff137 <ff137@proton.me>
  • Loading branch information
@ff137
ff137 committed Apr 17, 2024
1 parent 12ac80a commit 53cdedd
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 56 deletions.
56 changes: 28 additions & 28 deletions open-api/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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" : {
Expand All @@ -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"
}
}, {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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"
},
Expand All @@ -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"
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
},
Expand All @@ -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"
},
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
}
Expand All @@ -12206,7 +12206,7 @@
"RevList" : {
"properties" : {
"currentAccumulator" : {
"description" : "The current accumalator value",
"description" : "The current accumulator value",
"example" : "21 118...1FB",
"type" : "string"
},
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
}
Expand Down Expand Up @@ -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"
},
Expand Down Expand Up @@ -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"
Expand Down Expand Up @@ -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" : {
Expand All @@ -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"
Expand Down
Loading

0 comments on commit 53cdedd

Please sign in to comment.