Skip to content

Commit 2ad53b4

Browse files
ff137ff137
committed
update specs to 0.9.0
1 parent 8ee2d89 commit 2ad53b4

File tree

2 files changed

+186
-10
lines changed

2 files changed

+186
-10
lines changed

‎generator/data/openapi.yml‎

Lines changed: 185 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
openapi: 3.0.1
22
info:
33
title: Aries Cloud Agent
4-
version: v0.8.2
4+
version: v0.9.0
55
servers:
66
- url: /
77
security:
@@ -275,14 +275,14 @@ paths:
275275
schema:
276276
type: string
277277
enum:
278-
- invitation
279-
- start
278+
- request
279+
- active
280280
- abandoned
281281
- init
282-
- request
282+
- start
283+
- invitation
283284
- response
284285
- error
285-
- active
286286
- completed
287287
- name: their_did
288288
in: query
@@ -1036,6 +1036,18 @@ paths:
10361036
description: Alias for connection
10371037
schema:
10381038
type: string
1039+
- name: goal
1040+
in: query
1041+
description: A self-attested string that the receiver may want to display
1042+
to the user about the context-specific goal of the out-of-band message
1043+
schema:
1044+
type: string
1045+
- name: goal_code
1046+
in: query
1047+
description: A self-attested code the receiver may want to display to the
1048+
user or use in automatically deciding what to do with the out-of-band message
1049+
schema:
1050+
type: string
10391051
- name: mediation_id
10401052
in: query
10411053
description: Identifier for active mediation record to be used
@@ -3388,6 +3400,26 @@ paths:
33883400
schema:
33893401
$ref: '#/components/schemas/RevRegResult'
33903402
operationId: get_active_registry_for_cred_def
3403+
/revocation/active-registry/{cred_def_id}/rotate:
3404+
post:
3405+
tags:
3406+
- revocation
3407+
summary: Rotate revocation registry
3408+
parameters:
3409+
- name: cred_def_id
3410+
in: path
3411+
description: Credential definition identifier
3412+
required: true
3413+
schema:
3414+
pattern: ^([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}):3:CL:(([1-9][0-9]*)|([123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}:2:.+:[0-9.]+)):(.+)?$
3415+
type: string
3416+
responses:
3417+
200:
3418+
description: ''
3419+
content:
3420+
application/json:
3421+
schema:
3422+
$ref: '#/components/schemas/RevRegsCreated'
33913423
/revocation/clear-pending-revocations:
33923424
post:
33933425
tags:
@@ -3503,6 +3535,7 @@ paths:
35033535
- posted
35043536
- active
35053537
- full
3538+
- decommissioned
35063539
responses:
35073540
200:
35083541
description: ''
@@ -4438,6 +4471,44 @@ paths:
44384471
schema:
44394472
$ref: '#/components/schemas/DIDEndpoint'
44404473
operationId: get_did_endpoint
4474+
/wallet/jwt/sign:
4475+
post:
4476+
tags:
4477+
- wallet
4478+
summary: Create a EdDSA jws using did keys with a given payload
4479+
requestBody:
4480+
content:
4481+
application/json:
4482+
schema:
4483+
$ref: '#/components/schemas/JWSCreate'
4484+
required: false
4485+
responses:
4486+
200:
4487+
description: ''
4488+
content:
4489+
application/json:
4490+
schema:
4491+
$ref: '#/components/schemas/WalletModuleResponse'
4492+
x-codegen-request-body-name: body
4493+
/wallet/jwt/verify:
4494+
post:
4495+
tags:
4496+
- wallet
4497+
summary: Verify a EdDSA jws using did keys with a given JWS
4498+
requestBody:
4499+
content:
4500+
application/json:
4501+
schema:
4502+
$ref: '#/components/schemas/JWSVerify'
4503+
required: false
4504+
responses:
4505+
200:
4506+
description: ''
4507+
content:
4508+
application/json:
4509+
schema:
4510+
$ref: '#/components/schemas/JWSVerifyResponse'
4511+
x-codegen-request-body-name: body
44414512
/wallet/set-did-endpoint:
44424513
post:
44434514
tags:
@@ -4855,10 +4926,10 @@ components:
48554926
readOnly: true
48564927
example: https://didcomm.org/my-family/1.0/my-message-type
48574928
did:
4858-
pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$
4929+
pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$
48594930
type: string
48604931
description: DID for connection invitation
4861-
example: WgWxqztrNooG92RXvxSTWv
4932+
example: did:peer:WgWxqztrNooG92RXvxSTWv
48624933
imageUrl:
48634934
type: string
48644935
description: Optional image URL for connection invitation
@@ -5666,6 +5737,17 @@ components:
56665737
description: As signed attachment, DID Doc associated with DID
56675738
allOf:
56685739
- $ref: '#/components/schemas/AttachDecorator'
5740+
goal:
5741+
type: string
5742+
description: A self-attested string that the receiver may want to display
5743+
to the user about the context-specific goal of the out-of-band message
5744+
example: To issue a Faber College Graduate credential
5745+
goal_code:
5746+
type: string
5747+
description: A self-attested code the receiver may want to display to the
5748+
user or use in automatically deciding what to do with the out-of-band
5749+
message
5750+
example: issue-vc
56695751
label:
56705752
type: string
56715753
description: Label for DID exchange request
@@ -6888,6 +6970,17 @@ components:
68886970
description: Optional invitation attachments
68896971
items:
68906972
$ref: '#/components/schemas/AttachmentDef'
6973+
goal:
6974+
type: string
6975+
description: A self-attested string that the receiver may want to display
6976+
to the user about the context-specific goal of the out-of-band message
6977+
example: To issue a Faber College Graduate credential
6978+
goal_code:
6979+
type: string
6980+
description: A self-attested code the receiver may want to display to the
6981+
user or use in automatically deciding what to do with the out-of-band
6982+
message
6983+
example: issue-vc
68916984
handshake_protocols:
68926985
type: array
68936986
items:
@@ -6935,6 +7028,17 @@ components:
69357028
- didcomm/aip2;env=rfc19
69367029
items:
69377030
type: string
7031+
goal:
7032+
type: string
7033+
description: A self-attested string that the receiver may want to display
7034+
to the user about the context-specific goal of the out-of-band message
7035+
example: To issue a Faber College Graduate credential
7036+
goal_code:
7037+
type: string
7038+
description: A self-attested code the receiver may want to display to the
7039+
user or use in automatically deciding what to do with the out-of-band
7040+
message
7041+
example: issue-vc
69387042
handshake_protocols:
69397043
type: array
69407044
items:
@@ -7153,6 +7257,58 @@ components:
71537257
type: string
71547258
description: Time of last record update
71557259
example: 2021-12-31 23:59:59+00:00
7260+
JWSCreate:
7261+
required:
7262+
- payload
7263+
type: object
7264+
properties:
7265+
did:
7266+
pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$
7267+
type: string
7268+
description: DID of interest
7269+
example: did:peer:WgWxqztrNooG92RXvxSTWv
7270+
headers:
7271+
type: object
7272+
properties: {}
7273+
payload:
7274+
type: object
7275+
properties: {}
7276+
verificationMethod:
7277+
pattern: \w+:(\/?\/?)[^\s]+
7278+
type: string
7279+
description: Information used for proof verification
7280+
example: did:key:z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL#z6Mkgg342Ycpuk263R9d8Aq6MUaxPn1DDeHyGo38EefXmgDL
7281+
JWSVerify:
7282+
type: object
7283+
properties:
7284+
jwt:
7285+
pattern: ^[-_a-zA-Z0-9]*\.[-_a-zA-Z0-9]*\.[-_a-zA-Z0-9]*$
7286+
type: string
7287+
example: eyJhbGciOiJFZERTQSJ9.eyJhIjogIjAifQ.dBjftJeZ4CVP-mB92K27uhbUJU1p1r_wW1gFWFOEjXk
7288+
JWSVerifyResponse:
7289+
required:
7290+
- headers
7291+
- kid
7292+
- payload
7293+
- valid
7294+
type: object
7295+
properties:
7296+
error:
7297+
type: string
7298+
description: Error text
7299+
headers:
7300+
type: object
7301+
properties: {}
7302+
description: Headers from verified JWT.
7303+
kid:
7304+
type: string
7305+
description: kid of signer
7306+
payload:
7307+
type: object
7308+
properties: {}
7309+
description: Payload from verified JWT
7310+
valid:
7311+
type: boolean
71567312
Keylist:
71577313
type: object
71587314
properties:
@@ -7920,10 +8076,10 @@ components:
79208076
readOnly: true
79218077
example: https://didcomm.org/my-family/1.0/my-message-type
79228078
did:
7923-
pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$
8079+
pattern: ^(did:sov:)?[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{21,22}$|^did:([a-zA-Z0-9_]+):([a-zA-Z0-9_.%-]+(:[a-zA-Z0-9_.%-]+)*)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(\/[^#?]*)?([?][^#]*)?(\#.*)?$$
79248080
type: string
79258081
description: DID for connection invitation
7926-
example: WgWxqztrNooG92RXvxSTWv
8082+
example: did:peer:WgWxqztrNooG92RXvxSTWv
79278083
imageUrl:
79288084
type: string
79298085
description: Optional image URL for connection invitation
@@ -9293,6 +9449,11 @@ components:
92939449
description: Credential specification criteria by format
92949450
allOf:
92959451
- $ref: '#/components/schemas/V20CredFilter'
9452+
replacement_id:
9453+
type: string
9454+
description: Optional identifier used to manage credential replacement
9455+
nullable: true
9456+
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
92969457
trace:
92979458
type: boolean
92989459
description: Record trace information, based on agent configuration
@@ -9693,6 +9854,11 @@ components:
96939854
description: Credential specification criteria by format
96949855
allOf:
96959856
- $ref: '#/components/schemas/V20CredFilter'
9857+
replacement_id:
9858+
type: string
9859+
description: Optional identifier used to manage credential replacement
9860+
nullable: true
9861+
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
96969862
trace:
96979863
type: boolean
96989864
description: Record trace information, based on agent configuration
@@ -9726,6 +9892,11 @@ components:
97269892
description: Credential specification criteria by format
97279893
allOf:
97289894
- $ref: '#/components/schemas/V20CredFilter'
9895+
replacement_id:
9896+
type: string
9897+
description: Optional identifier used to manage credential replacement
9898+
nullable: true
9899+
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
97299900
trace:
97309901
type: boolean
97319902
description: Record trace information, based on agent configuration
@@ -9931,6 +10102,11 @@ components:
993110102
description: Credential specification criteria by format
993210103
allOf:
993310104
- $ref: '#/components/schemas/V20CredFilter'
10105+
replacement_id:
10106+
type: string
10107+
description: Optional identifier used to manage credential replacement
10108+
nullable: true
10109+
example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
993410110
trace:
993510111
type: boolean
993610112
description: Record trace information, based on agent configuration

‎generator/data/swagger.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)