@cheqd/studio 3.9.0-develop.1 → 3.9.0-develop.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -8,7 +8,7 @@ export declare class AccreditationController {
8
8
  *
9
9
  * /trust-registry/accreditation/issue:
10
10
  * post:
11
- * tags: [ Trust Registry ]
11
+ * tags: [ Trust Registries ]
12
12
  * summary: Publish a verifiable accreditation for a DID.
13
13
  * description: Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.
14
14
  * operationId: accredit-issue
@@ -51,7 +51,7 @@ export declare class AccreditationController {
51
51
  *
52
52
  * /trust-registry/accreditation/verify:
53
53
  * post:
54
- * tags: [ Trust Registry ]
54
+ * tags: [ Trust Registries ]
55
55
  * summary: Verify a verifiable accreditation for a DID.
56
56
  * description: Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.
57
57
  * operationId: accredit-verify
@@ -96,7 +96,7 @@ export declare class AccreditationController {
96
96
  *
97
97
  * /trust-registry/accreditation/revoke:
98
98
  * post:
99
- * tags: [ Trust Registry ]
99
+ * tags: [ Trust Registries ]
100
100
  * summary: Revoke a Verifiable Accreditation.
101
101
  * description: This endpoint revokes a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
102
102
  * operationId: accredit-revoke
@@ -136,7 +136,7 @@ export declare class AccreditationController {
136
136
  *
137
137
  * /trust-registry/accreditation/suspend:
138
138
  * post:
139
- * tags: [ Trust Registry ]
139
+ * tags: [ Trust Registries ]
140
140
  * summary: Suspend a Verifiable Accreditation.
141
141
  * description: This endpoint suspends a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
142
142
  * operationId: accredit-suspend
@@ -180,7 +180,7 @@ export declare class AccreditationController {
180
180
  *
181
181
  * /trust-registry/accreditation/reinstate:
182
182
  * post:
183
- * tags: [ Trust Registry ]
183
+ * tags: [ Trust Registries ]
184
184
  * summary: Reinstate a Verifiable Accreditation.
185
185
  * description: This endpoint reinstates a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
186
186
  * operationId: accredit-reinstate
@@ -111,7 +111,7 @@ export class AccreditationController {
111
111
  *
112
112
  * /trust-registry/accreditation/issue:
113
113
  * post:
114
- * tags: [ Trust Registry ]
114
+ * tags: [ Trust Registries ]
115
115
  * summary: Publish a verifiable accreditation for a DID.
116
116
  * description: Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.
117
117
  * operationId: accredit-issue
@@ -281,7 +281,7 @@ export class AccreditationController {
281
281
  *
282
282
  * /trust-registry/accreditation/verify:
283
283
  * post:
284
- * tags: [ Trust Registry ]
284
+ * tags: [ Trust Registries ]
285
285
  * summary: Verify a verifiable accreditation for a DID.
286
286
  * description: Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.
287
287
  * operationId: accredit-verify
@@ -366,7 +366,7 @@ export class AccreditationController {
366
366
  *
367
367
  * /trust-registry/accreditation/revoke:
368
368
  * post:
369
- * tags: [ Trust Registry ]
369
+ * tags: [ Trust Registries ]
370
370
  * summary: Revoke a Verifiable Accreditation.
371
371
  * description: This endpoint revokes a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
372
372
  * operationId: accredit-revoke
@@ -461,7 +461,7 @@ export class AccreditationController {
461
461
  *
462
462
  * /trust-registry/accreditation/suspend:
463
463
  * post:
464
- * tags: [ Trust Registry ]
464
+ * tags: [ Trust Registries ]
465
465
  * summary: Suspend a Verifiable Accreditation.
466
466
  * description: This endpoint suspends a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
467
467
  * operationId: accredit-suspend
@@ -558,7 +558,7 @@ export class AccreditationController {
558
558
  *
559
559
  * /trust-registry/accreditation/reinstate:
560
560
  * post:
561
- * tags: [ Trust Registry ]
561
+ * tags: [ Trust Registries ]
562
562
  * summary: Reinstate a Verifiable Accreditation.
563
563
  * description: This endpoint reinstates a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
564
564
  * operationId: accredit-reinstate
@@ -11,7 +11,7 @@ export declare class CredentialStatusController {
11
11
  *
12
12
  * /credential-status/create/unencrypted:
13
13
  * post:
14
- * tags: [ Credential Status ]
14
+ * tags: [ Status Lists ]
15
15
  * summary: Create an unencrypted StatusList2021 or BitstringStatusList credential status list.
16
16
  * description: This endpoint creates an unencrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
17
17
  * parameters:
@@ -81,7 +81,7 @@ export declare class CredentialStatusController {
81
81
  *
82
82
  * /credential-status/create/encrypted:
83
83
  * post:
84
- * tags: [ Credential Status ]
84
+ * tags: [ Status Lists ]
85
85
  * summary: Create an encrypted StatusList2021 or BitstringStatusList credential status list.
86
86
  * description: This endpoint creates an encrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
87
87
  * parameters:
@@ -151,7 +151,7 @@ export declare class CredentialStatusController {
151
151
  *
152
152
  * /credential-status/update/unencrypted:
153
153
  * post:
154
- * tags: [ Credential Status ]
154
+ * tags: [ Status Lists ]
155
155
  * summary: Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.
156
156
  * parameters:
157
157
  * - in: query
@@ -201,7 +201,7 @@ export declare class CredentialStatusController {
201
201
  *
202
202
  * /credential-status/update/encrypted:
203
203
  * post:
204
- * tags: [ Credential Status ]
204
+ * tags: [ Status Lists ]
205
205
  * summary: Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.
206
206
  * parameters:
207
207
  * - in: query
@@ -251,7 +251,7 @@ export declare class CredentialStatusController {
251
251
  *
252
252
  * /credential-status/check:
253
253
  * post:
254
- * tags: [ Credential Status ]
254
+ * tags: [ Status Lists ]
255
255
  * summary: Check a StatusList2021 index for a given Verifiable Credential.
256
256
  * description: This endpoint checks a StatusList2021 index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.
257
257
  * parameters:
@@ -292,7 +292,7 @@ export declare class CredentialStatusController {
292
292
  *
293
293
  * /credential-status/search:
294
294
  * get:
295
- * tags: [ Credential Status ]
295
+ * tags: [ Status Lists ]
296
296
  * summary: Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.
297
297
  * parameters:
298
298
  * - in: query
@@ -487,7 +487,7 @@ export class CredentialStatusController {
487
487
  *
488
488
  * /credential-status/create/unencrypted:
489
489
  * post:
490
- * tags: [ Credential Status ]
490
+ * tags: [ Status Lists ]
491
491
  * summary: Create an unencrypted StatusList2021 or BitstringStatusList credential status list.
492
492
  * description: This endpoint creates an unencrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
493
493
  * parameters:
@@ -638,7 +638,7 @@ export class CredentialStatusController {
638
638
  *
639
639
  * /credential-status/create/encrypted:
640
640
  * post:
641
- * tags: [ Credential Status ]
641
+ * tags: [ Status Lists ]
642
642
  * summary: Create an encrypted StatusList2021 or BitstringStatusList credential status list.
643
643
  * description: This endpoint creates an encrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.
644
644
  * parameters:
@@ -785,7 +785,7 @@ export class CredentialStatusController {
785
785
  *
786
786
  * /credential-status/update/unencrypted:
787
787
  * post:
788
- * tags: [ Credential Status ]
788
+ * tags: [ Status Lists ]
789
789
  * summary: Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.
790
790
  * parameters:
791
791
  * - in: query
@@ -931,7 +931,7 @@ export class CredentialStatusController {
931
931
  *
932
932
  * /credential-status/update/encrypted:
933
933
  * post:
934
- * tags: [ Credential Status ]
934
+ * tags: [ Status Lists ]
935
935
  * summary: Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.
936
936
  * parameters:
937
937
  * - in: query
@@ -1083,7 +1083,7 @@ export class CredentialStatusController {
1083
1083
  *
1084
1084
  * /credential-status/check:
1085
1085
  * post:
1086
- * tags: [ Credential Status ]
1086
+ * tags: [ Status Lists ]
1087
1087
  * summary: Check a StatusList2021 index for a given Verifiable Credential.
1088
1088
  * description: This endpoint checks a StatusList2021 index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.
1089
1089
  * parameters:
@@ -1239,7 +1239,7 @@ export class CredentialStatusController {
1239
1239
  *
1240
1240
  * /credential-status/search:
1241
1241
  * get:
1242
- * tags: [ Credential Status ]
1242
+ * tags: [ Status Lists ]
1243
1243
  * summary: Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.
1244
1244
  * parameters:
1245
1245
  * - in: query
@@ -8,7 +8,7 @@ export declare class CredentialController {
8
8
  *
9
9
  * /credential/issue:
10
10
  * post:
11
- * tags: [ Credential ]
11
+ * tags: [ Verifiable Credentials ]
12
12
  * summary: Issue a Verifiable Credential
13
13
  * description: This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.
14
14
  * requestBody:
@@ -39,7 +39,7 @@ export declare class CredentialController {
39
39
  *
40
40
  * /credential/verify:
41
41
  * post:
42
- * tags: [ Credential ]
42
+ * tags: [ Verifiable Credentials ]
43
43
  * summary: Verify a Verifiable Credential.
44
44
  * description: This endpoint verifies a Verifiable Credential passed to it. As input, it can take the VC-JWT as a string or the entire credential itself.
45
45
  * operationId: verify
@@ -90,7 +90,7 @@ export declare class CredentialController {
90
90
  *
91
91
  * /credential/revoke:
92
92
  * post:
93
- * tags: [ Credential ]
93
+ * tags: [ Verifiable Credentials ]
94
94
  * summary: Revoke a Verifiable Credential.
95
95
  * description: This endpoint revokes a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
96
96
  * operationId: revoke
@@ -139,7 +139,7 @@ export declare class CredentialController {
139
139
  *
140
140
  * /credential/suspend:
141
141
  * post:
142
- * tags: [ Credential ]
142
+ * tags: [ Verifiable Credentials ]
143
143
  * summary: Suspend a Verifiable Credential.
144
144
  * description: This endpoint suspends a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself.
145
145
  * operationId: suspend
@@ -186,7 +186,7 @@ export declare class CredentialController {
186
186
  *
187
187
  * /credential/reinstate:
188
188
  * post:
189
- * tags: [ Credential ]
189
+ * tags: [ Verifiable Credentials ]
190
190
  * summary: Reinstate a suspended Verifiable Credential.
191
191
  * description: Set whether the StatusList2021 or BitstringStatusList resource should be published to the ledger or not. If set to `false`, the StatusList2021 or BitstringStatusList publisher should manually publish the resource.
192
192
  * operationId: reinstate
@@ -83,7 +83,7 @@ export class CredentialController {
83
83
  *
84
84
  * /credential/issue:
85
85
  * post:
86
- * tags: [ Credential ]
86
+ * tags: [ Verifiable Credentials ]
87
87
  * summary: Issue a Verifiable Credential
88
88
  * description: This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.
89
89
  * requestBody:
@@ -161,7 +161,7 @@ export class CredentialController {
161
161
  *
162
162
  * /credential/verify:
163
163
  * post:
164
- * tags: [ Credential ]
164
+ * tags: [ Verifiable Credentials ]
165
165
  * summary: Verify a Verifiable Credential.
166
166
  * description: This endpoint verifies a Verifiable Credential passed to it. As input, it can take the VC-JWT as a string or the entire credential itself.
167
167
  * operationId: verify
@@ -257,7 +257,7 @@ export class CredentialController {
257
257
  *
258
258
  * /credential/revoke:
259
259
  * post:
260
- * tags: [ Credential ]
260
+ * tags: [ Verifiable Credentials ]
261
261
  * summary: Revoke a Verifiable Credential.
262
262
  * description: This endpoint revokes a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.
263
263
  * operationId: revoke
@@ -350,7 +350,7 @@ export class CredentialController {
350
350
  *
351
351
  * /credential/suspend:
352
352
  * post:
353
- * tags: [ Credential ]
353
+ * tags: [ Verifiable Credentials ]
354
354
  * summary: Suspend a Verifiable Credential.
355
355
  * description: This endpoint suspends a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself.
356
356
  * operationId: suspend
@@ -440,7 +440,7 @@ export class CredentialController {
440
440
  *
441
441
  * /credential/reinstate:
442
442
  * post:
443
- * tags: [ Credential ]
443
+ * tags: [ Verifiable Credentials ]
444
444
  * summary: Reinstate a suspended Verifiable Credential.
445
445
  * description: Set whether the StatusList2021 or BitstringStatusList resource should be published to the ledger or not. If set to `false`, the StatusList2021 or BitstringStatusList publisher should manually publish the resource.
446
446
  * operationId: reinstate
@@ -9,7 +9,7 @@ export declare class DIDController {
9
9
  *
10
10
  * /did/create:
11
11
  * post:
12
- * tags: [ DID ]
12
+ * tags: [ Decentralized Identifiers (DIDs) ]
13
13
  * summary: Create a DID Document.
14
14
  * description: This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.
15
15
  * requestBody:
@@ -52,7 +52,7 @@ export declare class DIDController {
52
52
  *
53
53
  * /did/update:
54
54
  * post:
55
- * tags: [ DID ]
55
+ * tags: [ Decentralized Identifiers (DIDs) ]
56
56
  * summary: Update a DID Document.
57
57
  * description: This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.
58
58
  * requestBody:
@@ -83,7 +83,7 @@ export declare class DIDController {
83
83
  *
84
84
  * /did/import:
85
85
  * post:
86
- * tags: [ DID ]
86
+ * tags: [ Decentralized Identifiers (DIDs) ]
87
87
  * summary: Import a DID Document.
88
88
  * description: This endpoint imports a decentralized identifier associated with the user's account for custodian-mode clients.
89
89
  * requestBody:
@@ -126,7 +126,7 @@ export declare class DIDController {
126
126
  *
127
127
  * /did/deactivate/{did}:
128
128
  * post:
129
- * tags: [ DID ]
129
+ * tags: [ Decentralized Identifiers (DIDs) ]
130
130
  * summary: Deactivate a DID Document.
131
131
  * description: This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.
132
132
  * parameters:
@@ -164,7 +164,7 @@ export declare class DIDController {
164
164
  *
165
165
  * /did/list:
166
166
  * get:
167
- * tags: [ DID ]
167
+ * tags: [ Decentralized Identifiers (DIDs) ]
168
168
  * summary: Fetch DIDs associated with an account.
169
169
  * description: This endpoint returns the list of DIDs controlled by the account.
170
170
  * responses:
@@ -189,7 +189,7 @@ export declare class DIDController {
189
189
  *
190
190
  * /did/search/{did}:
191
191
  * get:
192
- * tags: [ DID ]
192
+ * tags: [ Decentralized Identifiers (DIDs) ]
193
193
  * summary: Resolve a DID Document.
194
194
  * description: Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the <a href="https://w3c-ccg.github.io/did-resolution/">W3C DID Resolution specification</a>.
195
195
  * parameters:
@@ -126,7 +126,7 @@ export class DIDController {
126
126
  *
127
127
  * /did/create:
128
128
  * post:
129
- * tags: [ DID ]
129
+ * tags: [ Decentralized Identifiers (DIDs) ]
130
130
  * summary: Create a DID Document.
131
131
  * description: This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.
132
132
  * requestBody:
@@ -275,7 +275,7 @@ export class DIDController {
275
275
  *
276
276
  * /did/update:
277
277
  * post:
278
- * tags: [ DID ]
278
+ * tags: [ Decentralized Identifiers (DIDs) ]
279
279
  * summary: Update a DID Document.
280
280
  * description: This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.
281
281
  * requestBody:
@@ -383,7 +383,7 @@ export class DIDController {
383
383
  *
384
384
  * /did/import:
385
385
  * post:
386
- * tags: [ DID ]
386
+ * tags: [ Decentralized Identifiers (DIDs) ]
387
387
  * summary: Import a DID Document.
388
388
  * description: This endpoint imports a decentralized identifier associated with the user's account for custodian-mode clients.
389
389
  * requestBody:
@@ -486,7 +486,7 @@ export class DIDController {
486
486
  *
487
487
  * /did/deactivate/{did}:
488
488
  * post:
489
- * tags: [ DID ]
489
+ * tags: [ Decentralized Identifiers (DIDs) ]
490
490
  * summary: Deactivate a DID Document.
491
491
  * description: This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.
492
492
  * parameters:
@@ -561,7 +561,7 @@ export class DIDController {
561
561
  *
562
562
  * /did/list:
563
563
  * get:
564
- * tags: [ DID ]
564
+ * tags: [ Decentralized Identifiers (DIDs) ]
565
565
  * summary: Fetch DIDs associated with an account.
566
566
  * description: This endpoint returns the list of DIDs controlled by the account.
567
567
  * responses:
@@ -606,7 +606,7 @@ export class DIDController {
606
606
  *
607
607
  * /did/search/{did}:
608
608
  * get:
609
- * tags: [ DID ]
609
+ * tags: [ Decentralized Identifiers (DIDs) ]
610
610
  * summary: Resolve a DID Document.
611
611
  * description: Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the <a href="https://w3c-ccg.github.io/did-resolution/">W3C DID Resolution specification</a>.
612
612
  * parameters:
@@ -8,7 +8,7 @@ export declare class KeyController {
8
8
  *
9
9
  * /key/create:
10
10
  * post:
11
- * tags: [ Key ]
11
+ * tags: [ Keys ]
12
12
  * summary: Create an identity key pair.
13
13
  * description: This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.
14
14
  * parameters:
@@ -52,7 +52,7 @@ export declare class KeyController {
52
52
  *
53
53
  * /key/import:
54
54
  * post:
55
- * tags: [ Key ]
55
+ * tags: [ Keys ]
56
56
  * summary: Import an identity key pair.
57
57
  * description: This endpoint imports an identity key pair associated with the user's account for custodian-mode clients.
58
58
  * requestBody:
@@ -95,7 +95,7 @@ export declare class KeyController {
95
95
  *
96
96
  * /key/read/{kid}:
97
97
  * get:
98
- * tags: [ Key ]
98
+ * tags: [ Keys ]
99
99
  * summary: Fetch an identity key pair.
100
100
  * description: This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.
101
101
  * parameters:
@@ -55,7 +55,7 @@ export class KeyController {
55
55
  *
56
56
  * /key/create:
57
57
  * post:
58
- * tags: [ Key ]
58
+ * tags: [ Keys ]
59
59
  * summary: Create an identity key pair.
60
60
  * description: This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.
61
61
  * parameters:
@@ -123,7 +123,7 @@ export class KeyController {
123
123
  *
124
124
  * /key/import:
125
125
  * post:
126
- * tags: [ Key ]
126
+ * tags: [ Keys ]
127
127
  * summary: Import an identity key pair.
128
128
  * description: This endpoint imports an identity key pair associated with the user's account for custodian-mode clients.
129
129
  * requestBody:
@@ -203,7 +203,7 @@ export class KeyController {
203
203
  *
204
204
  * /key/read/{kid}:
205
205
  * get:
206
- * tags: [ Key ]
206
+ * tags: [ Keys ]
207
207
  * summary: Fetch an identity key pair.
208
208
  * description: This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.
209
209
  * parameters:
@@ -7,7 +7,7 @@ export declare class PresentationController {
7
7
  *
8
8
  * /presentation/create:
9
9
  * post:
10
- * tags: [ Presentation ]
10
+ * tags: [ Verifiable Presentations ]
11
11
  * summary: "!!! WARN. Such endpoint is made mostly for testing purposes and it is not supposed to be used in production !!! Create a Verifiable Presentation from credential(s)."
12
12
  * description: "This endpoint creates a Verifiable Presentation from credential(s). As input, it can take the credential(s) as a string or the entire credential(s) itself. \n !!! WARN. Such endpoint is made only for testing purposes !!!"
13
13
  * requestBody:
@@ -38,7 +38,7 @@ export declare class PresentationController {
38
38
  *
39
39
  * /presentation/verify:
40
40
  * post:
41
- * tags: [ Presentation ]
41
+ * tags: [ Verifiable Presentations ]
42
42
  * summary: Verify a Verifiable Presentation generated from credential(s).
43
43
  * description: This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.
44
44
  * parameters:
@@ -63,7 +63,7 @@ export class PresentationController {
63
63
  *
64
64
  * /presentation/create:
65
65
  * post:
66
- * tags: [ Presentation ]
66
+ * tags: [ Verifiable Presentations ]
67
67
  * summary: "!!! WARN. Such endpoint is made mostly for testing purposes and it is not supposed to be used in production !!! Create a Verifiable Presentation from credential(s)."
68
68
  * description: "This endpoint creates a Verifiable Presentation from credential(s). As input, it can take the credential(s) as a string or the entire credential(s) itself. \n !!! WARN. Such endpoint is made only for testing purposes !!!"
69
69
  * requestBody:
@@ -115,7 +115,7 @@ export class PresentationController {
115
115
  *
116
116
  * /presentation/verify:
117
117
  * post:
118
- * tags: [ Presentation ]
118
+ * tags: [ Verifiable Presentations ]
119
119
  * summary: Verify a Verifiable Presentation generated from credential(s).
120
120
  * description: This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.
121
121
  * parameters:
@@ -7,7 +7,7 @@ export declare class ResourceController {
7
7
  *
8
8
  * /resource/create/{did}:
9
9
  * post:
10
- * tags: [ Resource ]
10
+ * tags: [ DID-Linked Resources (DLRs) ]
11
11
  * summary: Create a DID-Linked Resource.
12
12
  * description: This endpoint creates a DID-Linked Resource. As input, it can take the DID identifier and the resource parameters via a form, or the fully-assembled resource itself.
13
13
  * parameters:
@@ -45,7 +45,7 @@ export declare class ResourceController {
45
45
  *
46
46
  * /resource/search/{did}:
47
47
  * get:
48
- * tags: [ Resource ]
48
+ * tags: [ DID-Linked Resources (DLRs) ]
49
49
  * summary: Get a DID-Linked Resource.
50
50
  * description: This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.
51
51
  * parameters:
@@ -102,7 +102,7 @@ export class ResourceController {
102
102
  *
103
103
  * /resource/create/{did}:
104
104
  * post:
105
- * tags: [ Resource ]
105
+ * tags: [ DID-Linked Resources (DLRs) ]
106
106
  * summary: Create a DID-Linked Resource.
107
107
  * description: This endpoint creates a DID-Linked Resource. As input, it can take the DID identifier and the resource parameters via a form, or the fully-assembled resource itself.
108
108
  * parameters:
@@ -207,7 +207,7 @@ export class ResourceController {
207
207
  *
208
208
  * /resource/search/{did}:
209
209
  * get:
210
- * tags: [ Resource ]
210
+ * tags: [ DID-Linked Resources (DLRs) ]
211
211
  * summary: Get a DID-Linked Resource.
212
212
  * description: This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.
213
213
  * parameters:
@@ -14,32 +14,45 @@
14
14
  "url": "https://github.com/cheqd/studio/blob/main/LICENSE"
15
15
  }
16
16
  },
17
+ "servers": [
18
+ {
19
+ "url": "https://studio-api.cheqd.net",
20
+ "description": "Main (production) server"
21
+ },
22
+ {
23
+ "url": "https://studio-api-staging.cheqd.net",
24
+ "description": "Staging server for testing"
25
+ }
26
+ ],
17
27
  "tags": [
18
28
  {
19
29
  "name": "Account"
20
30
  },
21
31
  {
22
- "name": "Key"
32
+ "name": "Keys"
33
+ },
34
+ {
35
+ "name": "Decentralized Identifiers (DIDs)"
23
36
  },
24
37
  {
25
- "name": "DID"
38
+ "name": "DID-Linked Resources (DLRs)"
26
39
  },
27
40
  {
28
- "name": "Resource"
41
+ "name": "Trust Registries"
29
42
  },
30
43
  {
31
- "name": "Credential"
44
+ "name": "Verifiable Credentials"
32
45
  },
33
46
  {
34
- "name": "Presentation"
47
+ "name": "Status Lists"
35
48
  },
36
49
  {
37
- "name": "Credential Status"
50
+ "name": "Verifiable Presentations"
38
51
  }
39
52
  ],
40
53
  "externalDocs": {
41
54
  "description": "cheqd Studio API Documentation",
42
- "url": "https://docs.cheqd.io/identity"
55
+ "url": "https://docs.cheqd.io/product"
43
56
  },
44
57
  "components": {
45
58
  "securitySchemes": {
@@ -2565,7 +2578,7 @@
2565
2578
  "/trust-registry/accreditation/issue": {
2566
2579
  "post": {
2567
2580
  "tags": [
2568
- "Trust Registry"
2581
+ "Trust Registries"
2569
2582
  ],
2570
2583
  "summary": "Publish a verifiable accreditation for a DID.",
2571
2584
  "description": "Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.",
@@ -2626,7 +2639,7 @@
2626
2639
  "/trust-registry/accreditation/verify": {
2627
2640
  "post": {
2628
2641
  "tags": [
2629
- "Trust Registry"
2642
+ "Trust Registries"
2630
2643
  ],
2631
2644
  "summary": "Verify a verifiable accreditation for a DID.",
2632
2645
  "description": "Generate and publish a Verifiable Accreditation for a subject DID as a DID Linked resource.",
@@ -2691,7 +2704,7 @@
2691
2704
  "/trust-registry/accreditation/revoke": {
2692
2705
  "post": {
2693
2706
  "tags": [
2694
- "Trust Registry"
2707
+ "Trust Registries"
2695
2708
  ],
2696
2709
  "summary": "Revoke a Verifiable Accreditation.",
2697
2710
  "description": "This endpoint revokes a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.",
@@ -2748,7 +2761,7 @@
2748
2761
  "/trust-registry/accreditation/suspend": {
2749
2762
  "post": {
2750
2763
  "tags": [
2751
- "Trust Registry"
2764
+ "Trust Registries"
2752
2765
  ],
2753
2766
  "summary": "Suspend a Verifiable Accreditation.",
2754
2767
  "description": "This endpoint suspends a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.",
@@ -2805,7 +2818,7 @@
2805
2818
  "/trust-registry/accreditation/reinstate": {
2806
2819
  "post": {
2807
2820
  "tags": [
2808
- "Trust Registry"
2821
+ "Trust Registries"
2809
2822
  ],
2810
2823
  "summary": "Reinstate a Verifiable Accreditation.",
2811
2824
  "description": "This endpoint reinstates a given Verifiable Accreditation. As input, it can take the didUrl as a string. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.",
@@ -2862,7 +2875,7 @@
2862
2875
  "/credential-status/create/unencrypted": {
2863
2876
  "post": {
2864
2877
  "tags": [
2865
- "Credential Status"
2878
+ "Status Lists"
2866
2879
  ],
2867
2880
  "summary": "Create an unencrypted StatusList2021 or BitstringStatusList credential status list.",
2868
2881
  "description": "This endpoint creates an unencrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.",
@@ -2971,7 +2984,7 @@
2971
2984
  "/credential-status/create/encrypted": {
2972
2985
  "post": {
2973
2986
  "tags": [
2974
- "Credential Status"
2987
+ "Status Lists"
2975
2988
  ],
2976
2989
  "summary": "Create an encrypted StatusList2021 or BitstringStatusList credential status list.",
2977
2990
  "description": "This endpoint creates an encrypted StatusList2021 or BitstringStatusList credential status list. The StatusList is published as a DID-Linked Resource on ledger. As input, it can can take input parameters needed to create the status list via a form, or a pre-assembled status list in JSON format. Status lists can be created as either encrypted or unencrypted.",
@@ -3080,7 +3093,7 @@
3080
3093
  "/credential-status/update/unencrypted": {
3081
3094
  "post": {
3082
3095
  "tags": [
3083
- "Credential Status"
3096
+ "Status Lists"
3084
3097
  ],
3085
3098
  "summary": "Update an existing unencrypted StatusList2021 or BitstringStatusList credential status list.",
3086
3099
  "parameters": [
@@ -3152,7 +3165,7 @@
3152
3165
  "/credential-status/update/encrypted": {
3153
3166
  "post": {
3154
3167
  "tags": [
3155
- "Credential Status"
3168
+ "Status Lists"
3156
3169
  ],
3157
3170
  "summary": "Update an existing encrypted StatusList2021 or BitstringStatusList credential status list.",
3158
3171
  "parameters": [
@@ -3224,7 +3237,7 @@
3224
3237
  "/credential-status/check": {
3225
3238
  "post": {
3226
3239
  "tags": [
3227
- "Credential Status"
3240
+ "Status Lists"
3228
3241
  ],
3229
3242
  "summary": "Check a StatusList2021 index for a given Verifiable Credential.",
3230
3243
  "description": "This endpoint checks a StatusList2021 index for a given Verifiable Credential and reports whether it is revoked or suspended. It offers a standalone method for checking an index without passing the entire Verifiable Credential or Verifiable Presentation.",
@@ -3283,7 +3296,7 @@
3283
3296
  "/credential-status/search": {
3284
3297
  "get": {
3285
3298
  "tags": [
3286
- "Credential Status"
3299
+ "Status Lists"
3287
3300
  ],
3288
3301
  "summary": "Fetch StatusList2021 or BitstringStatusList DID-Linked Resource based on search criteria.",
3289
3302
  "parameters": [
@@ -3358,7 +3371,7 @@
3358
3371
  "/credential/issue": {
3359
3372
  "post": {
3360
3373
  "tags": [
3361
- "Credential"
3374
+ "Verifiable Credentials"
3362
3375
  ],
3363
3376
  "summary": "Issue a Verifiable Credential",
3364
3377
  "description": "This endpoint issues a Verifiable Credential. As input it takes the list of issuerDid, subjectDid, attributes, and other parameters of the credential to be issued.",
@@ -3402,7 +3415,7 @@
3402
3415
  "/credential/verify": {
3403
3416
  "post": {
3404
3417
  "tags": [
3405
- "Credential"
3418
+ "Verifiable Credentials"
3406
3419
  ],
3407
3420
  "summary": "Verify a Verifiable Credential.",
3408
3421
  "description": "This endpoint verifies a Verifiable Credential passed to it. As input, it can take the VC-JWT as a string or the entire credential itself.",
@@ -3476,7 +3489,7 @@
3476
3489
  "/credential/revoke": {
3477
3490
  "post": {
3478
3491
  "tags": [
3479
- "Credential"
3492
+ "Verifiable Credentials"
3480
3493
  ],
3481
3494
  "summary": "Revoke a Verifiable Credential.",
3482
3495
  "description": "This endpoint revokes a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself. The StatusList2021 or BitstringStatusList resource should already be setup in the VC and `credentialStatus` property present in the VC.",
@@ -3546,7 +3559,7 @@
3546
3559
  "/credential/suspend": {
3547
3560
  "post": {
3548
3561
  "tags": [
3549
- "Credential"
3562
+ "Verifiable Credentials"
3550
3563
  ],
3551
3564
  "summary": "Suspend a Verifiable Credential.",
3552
3565
  "description": "This endpoint suspends a given Verifiable Credential. As input, it can take the VC-JWT as a string or the entire credential itself.",
@@ -3614,7 +3627,7 @@
3614
3627
  "/credential/reinstate": {
3615
3628
  "post": {
3616
3629
  "tags": [
3617
- "Credential"
3630
+ "Verifiable Credentials"
3618
3631
  ],
3619
3632
  "summary": "Reinstate a suspended Verifiable Credential.",
3620
3633
  "description": "Set whether the StatusList2021 or BitstringStatusList resource should be published to the ledger or not. If set to `false`, the StatusList2021 or BitstringStatusList publisher should manually publish the resource.",
@@ -3682,7 +3695,7 @@
3682
3695
  "/did/create": {
3683
3696
  "post": {
3684
3697
  "tags": [
3685
- "DID"
3698
+ "Decentralized Identifiers (DIDs)"
3686
3699
  ],
3687
3700
  "summary": "Create a DID Document.",
3688
3701
  "description": "This endpoint creates a DID and associated DID Document. As input, it can take the DID Document parameters via a form, or the fully-assembled DID Document itself.",
@@ -3746,7 +3759,7 @@
3746
3759
  "/did/update": {
3747
3760
  "post": {
3748
3761
  "tags": [
3749
- "DID"
3762
+ "Decentralized Identifiers (DIDs)"
3750
3763
  ],
3751
3764
  "summary": "Update a DID Document.",
3752
3765
  "description": "This endpoint updates a DID Document. As an input, it can take JUST the sections/parameters that need to be updated in the DID Document (in this scenario, it fetches the current DID Document and applies the updated section). Alternatively, it take the fully-assembled DID Document with updated sections as well as unchanged sections.",
@@ -3790,7 +3803,7 @@
3790
3803
  "/did/import": {
3791
3804
  "post": {
3792
3805
  "tags": [
3793
- "DID"
3806
+ "Decentralized Identifiers (DIDs)"
3794
3807
  ],
3795
3808
  "summary": "Import a DID Document.",
3796
3809
  "description": "This endpoint imports a decentralized identifier associated with the user's account for custodian-mode clients.",
@@ -3854,7 +3867,7 @@
3854
3867
  "/did/deactivate/{did}": {
3855
3868
  "post": {
3856
3869
  "tags": [
3857
- "DID"
3870
+ "Decentralized Identifiers (DIDs)"
3858
3871
  ],
3859
3872
  "summary": "Deactivate a DID Document.",
3860
3873
  "description": "This endpoint deactivates a DID Document by taking the DID identifier as input. Must be called and signed by the DID owner.",
@@ -3909,7 +3922,7 @@
3909
3922
  "/did/list": {
3910
3923
  "get": {
3911
3924
  "tags": [
3912
- "DID"
3925
+ "Decentralized Identifiers (DIDs)"
3913
3926
  ],
3914
3927
  "summary": "Fetch DIDs associated with an account.",
3915
3928
  "description": "This endpoint returns the list of DIDs controlled by the account.",
@@ -3942,7 +3955,7 @@
3942
3955
  "/did/search/{did}": {
3943
3956
  "get": {
3944
3957
  "tags": [
3945
- "DID"
3958
+ "Decentralized Identifiers (DIDs)"
3946
3959
  ],
3947
3960
  "summary": "Resolve a DID Document.",
3948
3961
  "description": "Resolve a DID Document by DID identifier. Also supports DID Resolution Queries as defined in the <a href=\"https://w3c-ccg.github.io/did-resolution/\">W3C DID Resolution specification</a>.",
@@ -4043,7 +4056,7 @@
4043
4056
  "/key/create": {
4044
4057
  "post": {
4045
4058
  "tags": [
4046
- "Key"
4059
+ "Keys"
4047
4060
  ],
4048
4061
  "summary": "Create an identity key pair.",
4049
4062
  "description": "This endpoint creates an identity key pair associated with the user's account for custodian-mode clients.",
@@ -4107,7 +4120,7 @@
4107
4120
  "/key/import": {
4108
4121
  "post": {
4109
4122
  "tags": [
4110
- "Key"
4123
+ "Keys"
4111
4124
  ],
4112
4125
  "summary": "Import an identity key pair.",
4113
4126
  "description": "This endpoint imports an identity key pair associated with the user's account for custodian-mode clients.",
@@ -4171,7 +4184,7 @@
4171
4184
  "/key/read/{kid}": {
4172
4185
  "get": {
4173
4186
  "tags": [
4174
- "Key"
4187
+ "Keys"
4175
4188
  ],
4176
4189
  "summary": "Fetch an identity key pair.",
4177
4190
  "description": "This endpoint fetches an identity key pair's details for a given key ID. Only the user account associated with the custodian-mode client can fetch the key pair.",
@@ -4232,7 +4245,7 @@
4232
4245
  "/presentation/create": {
4233
4246
  "post": {
4234
4247
  "tags": [
4235
- "Presentation"
4248
+ "Verifiable Presentations"
4236
4249
  ],
4237
4250
  "summary": "!!! WARN. Such endpoint is made mostly for testing purposes and it is not supposed to be used in production !!! Create a Verifiable Presentation from credential(s).",
4238
4251
  "description": "This endpoint creates a Verifiable Presentation from credential(s). As input, it can take the credential(s) as a string or the entire credential(s) itself. \n !!! WARN. Such endpoint is made only for testing purposes !!!",
@@ -4276,7 +4289,7 @@
4276
4289
  "/presentation/verify": {
4277
4290
  "post": {
4278
4291
  "tags": [
4279
- "Presentation"
4292
+ "Verifiable Presentations"
4280
4293
  ],
4281
4294
  "summary": "Verify a Verifiable Presentation generated from credential(s).",
4282
4295
  "description": "This endpoint verifies the Verifiable Presentation generated from credential(s). As input, it can take the Verifiable Presentation JWT as a string or the entire Verifiable Presentation itself.",
@@ -4349,7 +4362,7 @@
4349
4362
  "/resource/create/{did}": {
4350
4363
  "post": {
4351
4364
  "tags": [
4352
- "Resource"
4365
+ "DID-Linked Resources (DLRs)"
4353
4366
  ],
4354
4367
  "summary": "Create a DID-Linked Resource.",
4355
4368
  "description": "This endpoint creates a DID-Linked Resource. As input, it can take the DID identifier and the resource parameters via a form, or the fully-assembled resource itself.",
@@ -4404,7 +4417,7 @@
4404
4417
  "/resource/search/{did}": {
4405
4418
  "get": {
4406
4419
  "tags": [
4407
- "Resource"
4420
+ "DID-Linked Resources (DLRs)"
4408
4421
  ],
4409
4422
  "summary": "Get a DID-Linked Resource.",
4410
4423
  "description": "This endpoint returns the DID-Linked Resource for a given DID identifier and resource identifier.",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cheqd/studio",
3
- "version": "3.9.0-develop.1",
3
+ "version": "3.9.0-develop.2",
4
4
  "description": "cheqd Studio Backend",
5
5
  "source": "src/index.ts",
6
6
  "main": "dist/index.js",