forked from openwallet-foundation/owl-agent-test-harness
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-spec.yml
3121 lines (3090 loc) · 112 KB
/
openapi-spec.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
servers:
- description: Agent Backchannel
url: http://localhost:{port}
variables:
port:
description: >
The port to use for the backchannel
* Acme: 9020
* Bob: 9030
* Faber: 9040
* Mallory: 9050
enum:
- "9020"
- "9030"
- "9040"
- "9050"
default: "9020"
info:
description: |
This page documents the backchannel API the test harness uses to communicate with agents under tests.
For more information checkout the [Aries Interoperability Information](http://aries-interop.info) page.
version: "1.0.0"
title: Aries Agent Test Harness Backchannel API
contact:
name: Province of British Columbia
url: https://github.com/hyperledger/aries-agent-test-harness
license:
name: Apache 2.0
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
x-logo:
url: https://raw.githubusercontent.com/hyperledger/aries-agent-test-harness/master/docs/assets/aries-logo.png
altText: Hyperledger Aries logo
tags:
- name: Status
description: Agent commands to get agent status
- name: Agent
description: Agent commands to manage an agent
- name: Connection
description: Agent commands related to `connection` topic
- name: DID
description: Agent commands related to `did` topic
- name: Schema
description: Agent commands related to `schema` topic
- name: Credential Definition
description: Agent commands related to `credential-definition` topic
- name: Issue Credential
description: Agent commands related to `issue-credential` topic
- name: Issue Credential V2
description: Agent commands related to `issue-credential-v2` topic
- name: Credential
description: Agent commands related to `credential` topic
- name: Present Proof
description: Agent commands related to `proof` topic
- name: Present Proof V2
description: Agent commands related to `proof-v2` topic
- name: Present Proof V3
description: Agent commands related to `proof-v3` topic
- name: Revocation
description: Agent commands related to `revocation` topic
- name: DID Exchange
description: Agent commands related to `did-exchange` topic
- name: Out of Band
description: Agent commands related to `out-of-band` topic
- name: Coordinate Mediation
description: Agent commands related to `mediation` topic
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/blob/main/features/0211-route-coordination/README.md
- name: Out of Band V2
description: Agent commands related to `oob-v2` topic
paths:
/agent/command/status:
get:
summary: Get agent/backchannel status
operationId: StatusGet
tags:
- Status
responses:
200:
description: Agent is active
content:
application/json:
schema:
properties:
status:
type: string
enum: [active]
418:
description: Agent is not active
content:
application/json:
schema:
required:
- status
properties:
status:
type: string
enum: [inactive]
/agent/command/version:
get:
summary: Get agent/backchannel version
operationId: VersionGet
tags:
- Status
responses:
200:
description: Agent version
content:
text/plain:
schema:
type: string
example: 0.6.0
/agent/command/agent/start:
post:
summary: (re)start the agent
operationId: AgentStart
tags:
- Agent
requestBody:
required: true
description: >
Start the agent with specified parameters. If values are emitted, agent default values should be used.
For the `inbound_transports` and `outbound_transports` properties the following applies:
- If the property is left out the agent should use default configuration. For most agent this means only using HTTP inbound/outbound transport
- If the property is an empty array no inbound or outbound transport should be used. This is useful for testing cases where the agent doesn't have an inbound endpoint. An error should be thrown in if the transport requirements can't be met.
- If the property contains transports, the specified transports should be used.
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- parameters
properties:
parameters:
type: object
properties:
mime-type:
type: string
example: "didcomm/v2"
inbound_transports:
type: array
items:
type: string
enum: [ws, http]
example: [ws, http]
outbound_transports:
type: array
items:
type: string
enum: [ws, http]
example: [ws, http]
responses:
200:
description: OK
500:
description: Failed
/agent/command/connection:
get:
tags:
- Connection
summary: Get all connections
operationId: ConnectionGetAll
responses:
200:
description: Connections
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/ConnectionResponse"
/agent/command/connection/{connectionId}:
get:
tags:
- Connection
summary: Get connection by id
operationId: ConnectionGetById
parameters:
- in: path
name: connectionId
required: true
schema:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Connection
content:
application/json:
schema:
$ref: "#/components/schemas/ConnectionResponse"
404:
description: Connection not found
/agent/command/connection/create-invitation:
post:
tags:
- Connection
summary: Create a new connection invitation
operationId: ConnectionCreateInvitation
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
properties:
mediator_connection_id:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Invitation created
content:
application/json:
schema:
required:
- connection_id
- invitation
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
invitation:
$ref: "#/components/schemas/ConnectionInvitation"
/agent/command/connection/receive-invitation:
post:
tags:
- Connection
summary: Receive an invitation
operationId: ConnectionReceiveInvitation
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
allOf:
- $ref: "#/components/schemas/ConnectionInvitation"
- properties:
mediator_connection_id:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Invitation received
content:
application/json:
schema:
type: object
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
state:
$ref: "#/components/schemas/ConnectionState"
/agent/command/connection/accept-invitation:
post:
tags:
- Connection
summary: Accept an invitation
operationId: ConnectionAcceptInvitation
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Invitation accepted
content:
application/json:
schema:
type: object
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
state:
# With allOf we can overwrite properties of the $ref
allOf:
- $ref: "#/components/schemas/ConnectionState"
- example: request
/agent/command/connection/accept-request:
post:
tags:
- Connection
summary: Accept a connection request
operationId: ConnectionAcceptRequest
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
properties:
id:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Request accepted
content:
application/json:
schema:
type: object
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
state:
# With allOf we can overwrite properties of the $ref
allOf:
- $ref: "#/components/schemas/ConnectionState"
- example: response
/agent/command/connection/send-ping:
post:
tags:
- Connection
summary: Send trust ping
operationId: ConnectionSendPing
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- id
- data
properties:
id:
$ref: "#/components/schemas/ConnectionId"
data:
type: object
required:
- comment
properties:
comment:
$ref: "#/components/schemas/Comment"
responses:
200:
description: Trust ping sent
content:
application/json:
schema:
type: object
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
state:
# With allOf we can overwrite properties of the $ref
allOf:
- $ref: "#/components/schemas/ConnectionState"
- example: response
/agent/command/did:
get:
tags:
- DID
summary: Get public DID
operationId: DIDGetPublic
responses:
200:
description: Public DID information
content:
application/json:
schema:
type: object
properties:
did:
$ref: "#/components/schemas/Did"
verkey:
$ref: "#/components/schemas/Verkey"
/agent/command/schema/{schemaId}:
get:
tags:
- Schema
summary: Get schema by id
operationId: SchemaGetById
parameters:
- in: path
name: schemaId
required: true
schema:
$ref: "#/components/schemas/SchemaId"
responses:
200:
description: Schema
content:
application/json:
schema:
$ref: "#/components/schemas/Schema"
404:
description: Schema not found
/agent/command/schema:
post:
tags:
- Schema
summary: Create a new schema
operationId: SchemaCreate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- schema_name
- schema_version
- attributes
properties:
schema_name:
$ref: "#/components/schemas/SchemaName"
schema_version:
$ref: "#/components/schemas/SchemaVersion"
attributes:
$ref: "#/components/schemas/SchemaAttributes"
responses:
200:
description: Schema created
content:
application/json:
schema:
type: object
properties:
schema_id:
$ref: "#/components/schemas/SchemaId"
schema:
$ref: "#/components/schemas/Schema"
/agent/command/credential-definition/{credentialDefinitionId}:
get:
tags:
- Credential Definition
summary: Get credential definition by id
operationId: CredentialDefinitionGetById
parameters:
- in: path
name: credentialDefinitionId
required: true
schema:
$ref: "#/components/schemas/CredentialDefinitionId"
responses:
200:
description: Credential Definition
content:
application/json:
schema:
$ref: "#/components/schemas/CredentialDefinition"
404:
description: Credential Definition not found
/agent/command/credential-definition:
post:
tags:
- Credential Definition
summary: Create a new credential definition
operationId: CredentialDefinitionCreate
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- support_revocation
- schema_id
- tag
properties:
support_revocation:
type: boolean
example: false
schema_id:
$ref: "#/components/schemas/SchemaId"
tag:
type: string
example: default
responses:
200:
description: Credential definition created
content:
application/json:
schema:
properties:
credential_definition_id:
$ref: "#/components/schemas/CredentialDefinitionId"
/agent/command/issue-credential/{credentialExchangeThreadId}:
get:
tags:
- Issue Credential
summary: Get credential exchange record by thread id
operationId: IssueCredentialGetByThreadId
parameters:
- in: path
name: credentialExchangeThreadId
required: true
schema:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential Exchange
content:
application/json:
schema:
$ref: "#/components/schemas/IssueCredentialOperationResponse"
404:
description: Credential exchange record not found
/agent/command/issue-credential/send-proposal:
post:
tags:
- Issue Credential
summary: Send credential proposal
description: >
Send a `propose-credential` message to connection with `connection_id` in body.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0036-issue-credential#propose-credential
operationId: IssueCredentialSendProposal
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- connection_id
properties:
comment:
$ref: "#/components/schemas/Comment"
credential_proposal:
$ref: "#/components/schemas/CredentialPreview"
schema_issuer_did:
$ref: "#/components/schemas/Did"
schema_id:
$ref: "#/components/schemas/SchemaId"
schema_name:
$ref: "#/components/schemas/SchemaName"
schema_version:
$ref: "#/components/schemas/SchemaVersion"
cred_def_id:
$ref: "#/components/schemas/CredentialDefinitionId"
issuer_did:
$ref: "#/components/schemas/Did"
connection_id:
$ref: "#/components/schemas/ConnectionId"
responses:
200:
description: Credential proposal sent
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: proposal-sent
/agent/command/issue-credential/create-offer:
post:
tags:
- Issue Credential
summary: Create credential offer.
description: >
Create an `offer-credential` message. The message can be used in a connection(less) out-of-band invitation.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0036-issue-credential#offer-credential
operationId: IssueCredentialCreateOffer
requestBody:
required: true
content:
application/json:
schema:
type: object
anyOf:
- title: Create Offer to start credential issuance flow
required:
- data
properties:
data:
type: object
required:
- credential_preview
- cred_def_id
properties:
comment:
$ref: "#/components/schemas/Comment"
credential_preview:
$ref: "#/components/schemas/CredentialPreview"
cred_def_id:
$ref: "#/components/schemas/CredentialDefinitionId"
responses:
200:
description: Credential offer created
content:
application/json:
schema:
properties:
message:
type: object
example:
{
"@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/issue-credential/1.0/offer-credential",
"@id": "be02fa0b-3177-4202-ba40-76f29e992541",
"~thread": {},
"offers~attach":
[
{
"@id": "libindy-cred-offer-0",
"mime-type": "application/json",
"data":
{
"base64": "eyJzY2hlbWFfaWQiOiAiV1ZxcHBVdjlYM1d5V0dyYm5zNVVpYToyOkV4YW1wbGU6MS4wIiwgImNyZWRfZGVmX2lkIjogIkVoeDNSWlNWMzhwbjNNWXZ4dEhoYlE6MzpDTDoyMTM3ODE6ZGVmYXVsdCIsICJrZXlfY29ycmVjdG5lc3NfcHJvb2YiOiB7ImMiOiAiMzQzMzE3Njc5MzU5MTI2MTAyNDU5Mzg4OTM5MzU4OTY1MzIzNzMxNTA1NDcyMjAyOTAzMjYzNjQzMjMwNzkwODUxMDY5MjI5MDMyMjEiLCAieHpfY2FwIjogIjY1ODkyMjE5MDg3Njc2NTIzMTI2NjY2MTExMTc5Njg2OTE4MDQ2NjI2MjAzNzcyNTU0NDYwOTYzMTI4NzYxMjU4OTI3MTYwNjI0MTY3NzE4ODgyMjYxMzEwNDA5NTc3OTAwMDU4OTc5NTk5NzcyODU5NTk2NzY0NTMwNjE3MzAxNzYzMDc1MDk1NTg1MjQ1MjQwMzI1MTIzNTE5ODUyNjU1Mjg4MDQ2MDQ0ODIwMzIwMjc5MjY4OTA4NTczMTc1ODAwODM2ODU3MTUzMjA0NjYyMDM5NTQwNTc5NjY4Nzk5MzY1OTczOTQ0MjYxOTg4NjY3OTM0MDQyODkzOTYyMDQyOTgyOTUwMjE3MTUxNTU0MDEzNTg3MjcwMzg4MTE3NDE1MDM5NzY4Mjk2NTYwNDU0NTk1MDc5NDEyNTg5MzY5NzAzNDIzNDE3NDE3OTEwMDI5MDM2MjE0MzA5OTMxODU2NjMwMzcxNTQzNzg2NTc5Njg3NTE4NTU0MDU2ODYwMjUxMTkxMjgyMjI1MDQ1NzU4MjQwNjIwMDMxMTAyMDI1NDc0MzE0MzY3NjUzOTI5ODg0Njk2MDQwMzQ0NTEyMDA4NzE1MzIxODYyMDc2NjIyMTYxNDM3Mzk1MDI4ODI4MzMxMzUwMDkxNDA5MTAyMDQ0ODg2ODcxMzE1NzkwNzYwOTMyMjE1OTg3MTg2MzMyNjg2MzcwNTU3MDgwOTk1MjU2NTgwMjA3NDE4MzgzNDcxMjI3ODE3MjkwNjE2MjUzOTA4ODA0NzIzODA2MDIxMjQ0Nzc0MTg1MzEwNzQzMjk4NDQ5MjAyNTIyMTczMDk5MDk5NDAxMDkzNTU1NzEyNDEzNDYwNDA2MzAzMjY2MDc0NDg3NTU0ODA5NzQ5NTg0MzMyMTQyNDM2NTUzMTE3MDI5NTA2MiIsICJ4cl9jYXAiOiBbWyJleGFtcGxlIiwgIjQ3OTQzOTIzNTUxMzk1Mjk0MDExOTEwNjExMDYxODM3OTEzNzU4MjAwODk2MzU0OTk3NDYxMjUzNjQxNDc3NjQzOTczNTcwNjY2OTgzMTkyNzg1Nzg5MzYzODEyMjk3NDY2MjA1ODE4NDQ0MTAzNzM3MjcwMzA0NjY3NjU3MTYxMjA2MzczODk2NDQ1OTUwMDcwMzcxNjQ3MjQ5MDIxNjk3NDA4MDkxNTc0MTQzODI1ODY2NzYyMzI5MDU4MDM2MzQ3Mjc1NjY1OTE1NjEwMTIxNDYxMDc2NTg3MDE4NTcwMTg5MTUzNzg4NTQ0NTM5NjY5NjY0NjAzODA5MTYzODYzNzMzODEwODI5NTQ0Njc1ODk1MDc2MTgyODA1NDc4MTMxMTMzMDg5NDEzMDU2MDgyNTUwMjE3Njk2ODMyNTg5Nzk2NzI1NzM0MTQ0OTg2MTI3OTc4NzEyMTQ5NDM4ODE1NzA2MDM0NzY4NTg2NzQ3MzM2MjMwMzk4NDAxMTU5NTA4NzgzMTQ5MDMyMDY5NTUzODQxMDE1NzE5NDk4MjE2OTEyNDAzMDcyMTMxNzgyMjg2MDE2MzIzMDY1ODMxMDUxMDU0MTIyNzMwODU0Njk1NzMyMzAyNzc0ODgwMTcyNTI0OTk3NTk0MjE1MjE1NzI2MTU1MjY5Mzk3MTUxMDg5NzE2MTc1MjQxMzg0NTEwMTI3MjI5NDI5OTcyNzU2NzMzMzIyODg5MjgxODUxNjMxNzcxNTAwOTA5ODkzNTgxNDA2MzQ4MTgxODc2NDk3NjQ2OTE5MTIzNDI1NzIwNTQ5MjE1MDE4NzE4Mzg1NjAxNTcwMzE5NzQ4MjAwMDgyMDk2MzQzMTIzMTE2NjU3NTU4ODMxODU1NjQ2NjU1NTQ2ODI5Mjk5NjQzMjM0OTYxODAwMTg4MiJdLCBbIm1hc3Rlcl9zZWNyZXQiLCAiMzg0NzYyNzI1ODkxMDM5MDIzNjUyNjUzMDU0MzAxNDUzOTk1MDk2NTAwMTQxNzQxNDQ5OTIyODY5OTEwNTc5NDU3OTE1MTAxNTU4NzgwODQ3MzU1NTMxMjgyOTI1MTQ5NTA1NzA3NDM4OTQyMDAyODk1NjQ4ODA5MTgyODAxOTc2ODgyMDMxMTcxNTMwNTYwODc5NDQ2ODczMjg3NzA2MTY5OTEzODA0MTY1Nzg4Njc2OTY4MDI3MTI4NTE4MDcyMjU2NTAxMjUxMzQ4Nzc4NzM3MzE4NzAyMTAxODE1NTU0NzE0ODQ4NjQ1NTA5MTczMjQ1NDYzOTE0NTM3MjYzODA5NzAwNDc2NjM2NzE2OTQ1NjgxNTMzMTA2MTM3MjY5MDc1MzY5MjEwOTExNTc5NDY5MTc3NjI5MjA0NDA0MjQ4MTA2MzExNzI5MjE1MTQ4ODM4MTc1NDcwMDg1ODE5OTk2MTk5MjQ0MDA5MTQ5ODg3NzMzMjQ0NjU1NzMxODYyNjYwODAwNzU1MTUxNTkwNDI0MDY0NjIwMTE5OTk5NjM3NjUyNTkxMTgwMDA3MDA2ODcyMTkzMTUzODM2OTg3MDQ5MjQyNzYyNDMwMjE3NTc2NDI2ODM1MzIyODQxNzIyMTE3ODY1Njg2MzMzOTE1NjYzMDgwODI5NTQ3MTY1NTYwMTY2ODMyODgzODgxNjc1MDY2MjUxOTM3NDA5Njk4NTE0NzkyMDYyNDgwMzQxMTUxMTkwMTk5MjcwOTkyMDgzOTgyNTIzMzI0MzU5OTUyNjUyMzQ5MDY5ODE5NTEyOTQwMzUwMzM2NDMwOTE4OTMwODQ2MjA4MTMxNzEzNDI0NTczNzY4NDQ0ODE2Njc4MTM4OTM2MTUyNzY1MzQwOTA4ODM5MTA2MjkyOTcyNTM2MjIzMjEyIl1dfSwgIm5vbmNlIjogIjE5MDU3NTc5MDc0ODIyODA1NTkzODA4MSJ9",
},
},
],
"credential_preview":
{
"@type": "did:sov:BzCbsNYhMrjHiqZDTUASHg;spec/issue-credential/1.0/credential-preview",
"attributes":
[
{
"name": "example",
"mime-type": "image/jpeg",
"value": "martini",
},
],
},
}
record:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: offer-sent
/agent/command/issue-credential/send-offer:
post:
tags:
- Issue Credential
summary: Send credential offer
description: >
Send an `offer-credential` message.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0036-issue-credential#offer-credential
operationId: IssueCredentialSendOffer
requestBody:
required: true
content:
application/json:
schema:
type: object
anyOf:
- title: Send Offer to start credential issuance flow
required:
- data
properties:
data:
type: object
required:
- connection_id
- credential_preview
properties:
comment:
$ref: "#/components/schemas/Comment"
credential_preview:
$ref: "#/components/schemas/CredentialPreview"
cred_def_id:
$ref: "#/components/schemas/CredentialDefinitionId"
connection_id:
$ref: "#/components/schemas/ConnectionId"
- title: Send Offer in response to Proposal
required:
- id
properties:
id:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential offer sent
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: offer-sent
/agent/command/issue-credential/send-request:
post:
tags:
- Issue Credential
summary: Send credential request
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0036-issue-credential#request-credential
operationId: IssueCredentialSendRequest
requestBody:
required: true
content:
application/json:
schema:
anyOf:
- title: Send Request to start credential issuance flow
required:
- id
properties:
id:
$ref: "#/components/schemas/ConnectionId"
- title: Send Request in response to Offer
required:
- id
properties:
id:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential request sent
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: request-sent
/agent/command/issue-credential/issue:
post:
tags:
- Issue Credential
summary: Issue Credential
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0036-issue-credential#issue-credential
operationId: IssueCredentialIssue
requestBody:
required: true
content:
application/json:
schema:
required:
- id
properties:
id:
$ref: "#/components/schemas/ThreadId"
data:
type: object
properties:
comment:
$ref: "#/components/schemas/Comment"
responses:
200:
description: Credential issued
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: credential-issued
/agent/command/issue-credential/store:
post:
tags:
- Issue Credential
summary: Store Credential
operationId: IssueCredentialStore
requestBody:
required: true
content:
application/json:
schema:
required:
- id
properties:
id:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential stored
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- required:
- credential_id
properties:
state:
example: done
/agent/command/issue-credential-v2/{credentialExchangeThreadId}:
get:
tags:
- Issue Credential V2
summary: Get credential exchange v2 record by thread id
operationId: IssueCredentialV2GetByThreadId
parameters:
- in: path
name: credentialExchangeThreadId
required: true
schema:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential Exchange v2
content:
application/json:
schema:
$ref: "#/components/schemas/IssueCredentialOperationResponse"
404:
description: Credential exchange record not found
/agent/command/issue-credential-v2/prepare-json-ld:
post:
tags:
- Issue Credential V2
summary: Prepare for issuing a JSON-LD credential (RFC0593)
operationId: IssueCredentialV2PrepareJsonLD
requestBody:
required: true
content:
application/json:
schema:
required:
- did_method
- proof_type
properties:
did_method:
$ref: "#/components/schemas/DidMethod"
proof_type:
$ref: "#/components/schemas/ProofType"
responses:
200:
description: Ready to issue a JSON-LD credential
content:
application/json:
schema:
required:
- did
properties:
did:
$ref: "#/components/schemas/FullDid"
/agent/command/issue-credential-v2/send-proposal:
post:
tags:
- Issue Credential V2
summary: Send credential proposal
description: >
Send a `propose-credential` message to connection with `connection_id` in body.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0453-issue-credential-v2#propose-credential
operationId: IssueCredentialV2SendProposal
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: object
required:
- connection_id
- filter
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
credential_preview:
allOf:
- $ref: "#/components/schemas/CredentialPreview"
- properties:
"@type":
example: "issue-credential/2.0/credential-preview"
filter:
$ref: "#/components/schemas/IssueCredentialV2CredentialProposalFilter"
responses:
200:
description: Credential proposal sent
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: proposal-sent
/agent/command/issue-credential-v2/send-offer:
post:
tags:
- Issue Credential V2
summary: Send credential offer
description: >
Send an `offer-credential` message.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0453-issue-credential-v2#offer-credential
operationId: IssueCredentialV2SendOffer
requestBody:
required: true
content:
application/json:
schema:
type: object
anyOf:
- title: Send Offer to start credential issuance flow
required:
- data
properties:
data:
type: object
required:
- connection_id
- filter
properties:
connection_id:
$ref: "#/components/schemas/ConnectionId"
credential_preview:
allOf:
- $ref: "#/components/schemas/CredentialPreview"
- properties:
"@type":
example: "issue-credential/2.0/credential-preview"
filter:
$ref: "#/components/schemas/IssueCredentialV2CredentialProposalFilter"
- title: Send Offer in response to Proposal
required:
- id
properties:
id:
$ref: "#/components/schemas/ThreadId"
responses:
200:
description: Credential offer sent
content:
application/json:
schema:
allOf:
- $ref: "#/components/schemas/IssueCredentialOperationResponse"
- properties:
state:
example: offer-sent
/agent/command/issue-credential-v2/create-offer:
post:
tags:
- Issue Credential V2
summary: Create credential offer
description: >
Create an `offer-credential` message. The message can be used in a connection(less) out-of-band invitation.
externalDocs:
url: https://github.com/hyperledger/aries-rfcs/tree/master/features/0453-issue-credential-v2#offer-credential
operationId: IssueCredentialV2CreateOffer
requestBody:
required: true
content:
application/json:
schema:
title: Create Offer to start credential issuance flow
required:
- data
properties:
data:
type: object
required:
- filter
properties:
credential_preview:
allOf:
- $ref: "#/components/schemas/CredentialPreview"