Skip to content

Commit ce96780

Browse files
Docs improvements (#2738) * Consistency in naming * replace go (#1529)
Co-authored-by: chiarapaskulin <chiarapaskulin@users.noreply.github.com> Co-authored-by: mewmba <mewmba@users.noreply.github.com>
1 parent 7de8994 commit ce96780

File tree

27 files changed

+424
-360
lines changed

27 files changed

+424
-360
lines changed

dart/lib/src/proto/services/trust-registry/v1/trust-registry.pb.dart

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dart/lib/src/proto/services/verifiable-credentials/v1/verifiable-credentials.pb.dart

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dart/lib/src/proto/services/verifiable-credentials/v1/verifiable-credentials.pbjson.dart

Lines changed: 29 additions & 19 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/_static/proto.json

Lines changed: 32 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6395,7 +6395,7 @@
63956395
"services.trustregistry.v1.GetMemberAuthorizationStatusRequest": {
63966396
"name": "GetMemberAuthorizationStatusRequest",
63976397
"full_name": "services.trustregistry.v1.GetMemberAuthorizationStatusRequest",
6398-
"description": "Request to fetch member status in governance framework for a specific credential schema.",
6398+
"description": "Request to fetch member status in Trust Registry for a specific credential schema.",
63996399
"fields": [
64006400
"services.trustregistry.v1.GetMemberAuthorizationStatusRequest.did_uri",
64016401
"services.trustregistry.v1.GetMemberAuthorizationStatusRequest.schema_uri"
@@ -6416,7 +6416,7 @@
64166416
"services.trustregistry.v1.GetMemberRequest": {
64176417
"name": "GetMemberRequest",
64186418
"full_name": "services.trustregistry.v1.GetMemberRequest",
6419-
"description": "Request to get a member of the governance framework",
6419+
"description": "Request to get a member of the Trust Registry",
64206420
"fields": [
64216421
"services.trustregistry.v1.GetMemberRequest.did_uri",
64226422
"services.trustregistry.v1.GetMemberRequest.wallet_id",
@@ -6484,7 +6484,7 @@
64846484
"services.trustregistry.v1.UnregisterMemberRequest": {
64856485
"name": "UnregisterMemberRequest",
64866486
"full_name": "services.trustregistry.v1.UnregisterMemberRequest",
6487-
"description": "Request to unregister a member as a valid issuer of a specific credential schema.\nOnly one of `did_uri`, `wallet_id`, or `email` may be specified.",
6487+
"description": "Request to unregister a member as a valid issuer of a specific credential schema.\nOnly one of `did_uri`, `wallet_id`, or `email` may be specified.\nThe URI of the credential schema must be specified.",
64886488
"fields": [
64896489
"services.trustregistry.v1.UnregisterMemberRequest.did_uri",
64906490
"services.trustregistry.v1.UnregisterMemberRequest.wallet_id",
@@ -10333,7 +10333,10 @@
1033310333
"label": "LABEL_OPTIONAL",
1033410334
"type": "string",
1033510335
"full_type": "string",
10336-
"description": "The ID of the item in the wallet that contains the credential offer"
10336+
"description": "The ID of the credential offer (Parameter ID inside the JSON document)",
10337+
"options": {
10338+
"services.options.optional": true
10339+
}
1033710340
},
1033810341
"services.verifiablecredentials.v1.AcceptCredentialResponse.document_json": {
1033910342
"name": "document_json",
@@ -10373,31 +10376,43 @@
1037310376
"label": "LABEL_OPTIONAL",
1037410377
"type": "bool",
1037510378
"full_type": "bool",
10376-
"description": "If true, a short URL link will be generated that can be used to share the credential offer with the holder.\nThis link will point to the credential offer in the wallet app."
10379+
"description": "If true, a short URL link will be generated that can be used to share the credential offer with the holder.\nThis link will point to the credential offer in the wallet app.",
10380+
"options": {
10381+
"services.options.optional": true
10382+
}
1037710383
},
1037810384
"services.verifiablecredentials.v1.CreateCredentialOfferRequest.holder_binding": {
1037910385
"name": "holder_binding",
1038010386
"full_name": "services.verifiablecredentials.v1.CreateCredentialOfferRequest.holder_binding",
1038110387
"label": "LABEL_OPTIONAL",
1038210388
"type": "bool",
1038310389
"full_type": "bool",
10384-
"description": "If true, the credential will be issued with holder binding by specifying\nthe holder DID in the credential subject"
10390+
"description": "If true, the credential will be issued with holder binding by specifying\nthe holder DID in the credential subject",
10391+
"options": {
10392+
"services.options.optional": true
10393+
}
1038510394
},
1038610395
"services.verifiablecredentials.v1.CreateCredentialOfferRequest.include_governance": {
1038710396
"name": "include_governance",
1038810397
"full_name": "services.verifiablecredentials.v1.CreateCredentialOfferRequest.include_governance",
1038910398
"label": "LABEL_OPTIONAL",
1039010399
"type": "bool",
1039110400
"full_type": "bool",
10392-
"description": "If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's\ngovernance framework."
10401+
"description": "If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's\nTrust Registry.",
10402+
"options": {
10403+
"services.options.optional": true
10404+
}
1039310405
},
1039410406
"services.verifiablecredentials.v1.CreateCredentialOfferRequest.signature_type": {
1039510407
"name": "signature_type",
1039610408
"full_name": "services.verifiablecredentials.v1.CreateCredentialOfferRequest.signature_type",
1039710409
"label": "LABEL_OPTIONAL",
1039810410
"type": "SignatureType",
1039910411
"full_type": "services.verifiablecredentials.v1.SignatureType",
10400-
"description": "The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`."
10412+
"description": "The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`.",
10413+
"options": {
10414+
"services.options.optional": true
10415+
}
1040110416
},
1040210417
"services.verifiablecredentials.v1.CreateCredentialOfferRequest.template_id": {
1040310418
"name": "template_id",
@@ -10512,7 +10527,7 @@
1051210527
"label": "LABEL_OPTIONAL",
1051310528
"type": "bool",
1051410529
"full_type": "bool",
10515-
"description": "If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's\ngovernance framework."
10530+
"description": "If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's\nTrust Registry."
1051610531
},
1051710532
"services.verifiablecredentials.v1.IssueFromTemplateRequest.save_copy": {
1051810533
"name": "save_copy",
@@ -10568,7 +10583,10 @@
1056810583
"label": "LABEL_OPTIONAL",
1056910584
"type": "string",
1057010585
"full_type": "string",
10571-
"description": "The ID of the item in the wallet that contains the credential offer"
10586+
"description": "The ID of the credential offer (Parameter ID inside the JSON document)",
10587+
"options": {
10588+
"services.options.optional": true
10589+
}
1057210590
},
1057310591
"services.verifiablecredentials.v1.RevealTemplateAttributes.template_attributes": {
1057410592
"name": "template_attributes",
@@ -10616,7 +10634,10 @@
1061610634
"label": "LABEL_OPTIONAL",
1061710635
"type": "bool",
1061810636
"full_type": "bool",
10619-
"description": "Send email notification that credential has been sent to a wallet"
10637+
"description": "Send email notification that credential has been sent to a wallet",
10638+
"options": {
10639+
"services.options.optional": true
10640+
}
1062010641
},
1062110642
"services.verifiablecredentials.v1.SendRequest.wallet_id": {
1062210643
"name": "wallet_id",

docs/reference/proto/index.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,7 +1064,7 @@ The type of verification to perform
10641064
| Field | Type | Description |
10651065
| ----- | ---- | ----------- |
10661066
| document_json | [string](/reference/proto#string) | The JSON document that contains the credential offer |
1067-
| item_id | [string](/reference/proto#string) | The ID of the item in the wallet that contains the credential offer |
1067+
| item_id | [string](/reference/proto#string) | The ID of the credential offer (Parameter ID inside the JSON document) |
10681068

10691069

10701070

@@ -1128,7 +1128,7 @@ Response to `CheckStatusRequest`
11281128
| template_id | [string](/reference/proto#string) | ID of template to use |
11291129
| values_json | [string](/reference/proto#string) | JSON document string with keys corresponding to the fields of the template referenced by `template_id` |
11301130
| holder_binding | [bool](/reference/proto#bool) | If true, the credential will be issued with holder binding by specifying the holder DID in the credential subject |
1131-
| include_governance | [bool](/reference/proto#bool) | If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's governance framework. |
1131+
| include_governance | [bool](/reference/proto#bool) | If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's Trust Registry. |
11321132
| generate_share_url | [bool](/reference/proto#bool) | If true, a short URL link will be generated that can be used to share the credential offer with the holder. This link will point to the credential offer in the wallet app. |
11331133
| signature_type | [SignatureType](/reference/proto#services-verifiablecredentials-v1-SignatureType) | The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`. |
11341134

@@ -1202,7 +1202,7 @@ Request to create and sign a JSON-LD Verifiable Credential from a template using
12021202
| values_json | [string](/reference/proto#string) | JSON document string with keys corresponding to the fields of the template referenced by `template_id` |
12031203
| save_copy | [bool](/reference/proto#bool) | Save a copy of the issued credential to this user's wallet. This copy will only contain the credential data, but not the secret proof value. Issuers may use this data to keep track of the details for revocation status. |
12041204
| expiration_date | [string](/reference/proto#string) | The ISO8601 expiration UTC date of the credential. This is a reserved field in the VC specification. If specified, the issued credential will contain an expiration date. https://www.w3.org/TR/vc-data-model/#expiration |
1205-
| include_governance | [bool](/reference/proto#bool) | If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's governance framework. |
1205+
| include_governance | [bool](/reference/proto#bool) | If true, the issued credential will contain an attestation of the issuer's membership in the ecosystem's Trust Registry. |
12061206
| signature_type | [SignatureType](/reference/proto#services-verifiablecredentials-v1-SignatureType) | The type of signature to use when signing the credential. Defaults to `EXPERIMENTAL`. |
12071207

12081208

@@ -1234,7 +1234,7 @@ Response to `IssueFromTemplateRequest`
12341234
| Field | Type | Description |
12351235
| ----- | ---- | ----------- |
12361236
| document_json | [string](/reference/proto#string) | The JSON document that contains the credential offer |
1237-
| item_id | [string](/reference/proto#string) | The ID of the item in the wallet that contains the credential offer |
1237+
| item_id | [string](/reference/proto#string) | The ID of the credential offer (Parameter ID inside the JSON document) |
12381238

12391239

12401240

@@ -2210,7 +2210,7 @@ How to display a URI value when rendering a credential.
22102210
<a name="services-trustregistry-v1-GetMemberAuthorizationStatusRequest"></a>
22112211

22122212
### GetMemberAuthorizationStatusRequest
2213-
Request to fetch member status in governance framework for a specific credential schema.
2213+
Request to fetch member status in Trust Registry for a specific credential schema.
22142214

22152215

22162216
| Field | Type | Description |
@@ -2241,7 +2241,7 @@ Response to `GetMemberAuthorizationStatusRequest`
22412241
<a name="services-trustregistry-v1-GetMemberRequest"></a>
22422242

22432243
### GetMemberRequest
2244-
Request to get a member of the governance framework
2244+
Request to get a member of the Trust Registry
22452245

22462246

22472247
| Field | Type | Description |
@@ -2339,6 +2339,7 @@ Response to `RegisterMemberRequest`
23392339
### UnregisterMemberRequest
23402340
Request to unregister a member as a valid issuer of a specific credential schema.
23412341
Only one of `did_uri`, `wallet_id`, or `email` may be specified.
2342+
The URI of the credential schema must be specified.
23422343

23432344

23442345
| Field | Type | Description |

0 commit comments

Comments
 (0)