Modify to support selective disclosure options per specifications.

w3c-ccg · Feb 9, 2024 · 64e655d · 64e655d
1 parent f634b54
commit 64e655d
Show file tree

Hide file tree

Showing 3 changed files with 619 additions and 616 deletions.
diff --git a/components/DeriveCredentialOptions.yml b/components/DeriveCredentialOptions.yml
@@ -1,26 +1,29 @@
-openapi: 3.0.0
-info:
-  version: "0.0.3-unstable"
-  title: VC API
-  description: This is an Experimental Open API Specification for the [VC Data Model](https://www.w3.org/TR/vc-data-model/).
-  license:
-    name: W3C Software and Document License
-    url: http://www.w3.org/Consortium/Legal/copyright-software.
-  contact:
-    name: GitHub Source Code
-    url: https://github.com/w3c-ccg/vc-api
-paths:
-components:
-  schemas:
-    DeriveCredentialOptions:
-      type: object
-      additionalProperties: false
-      description: Options for specifying how the derived credential is created.
-      properties:
-        nonce:
-          type: string
-          description: An encoded nonce provided by the holder of the credential, to be included in the DataIntegrityProof.
-      example:
-        {
-          "nonce": "lEixQKDQvRecCifKl789TQj+Ii6YWDLSwn3AxR0VpPJ1QV5htod/0VCchVf1zVM0y2E=",
-        }
+openapi: 3.0.0
+info:
+  version: "0.0.3-unstable"
+  title: VC API
+  description: This is an Experimental Open API Specification for the [VC Data Model](https://www.w3.org/TR/vc-data-model/).
+  license:
+    name: W3C Software and Document License
+    url: http://www.w3.org/Consortium/Legal/copyright-software.
+  contact:
+    name: GitHub Source Code
+    url: https://github.com/w3c-ccg/vc-api
+paths:
+components:
+  schemas:
+    DeriveCredentialOptions:
+      type: object
+      additionalProperties: false
+      description: Options for specifying how the derived credential is created.
+      properties:
+        nonce:
+          type: string
+          description: An encoded nonce provided by the holder of the credential, to be included in the DataIntegrityProof.
+        selectivePointers:
+          type: array
+          description: An array of JSON pointers specifying the selectively disclosed information.
+      example:
+        {
+          "nonce": "lEixQKDQvRecCifKl789TQj+Ii6YWDLSwn3AxR0VpPJ1QV5htod/0VCchVf1zVM0y2E=",
+        }
diff --git a/components/IssueCredentialOptions.yml b/components/IssueCredentialOptions.yml
@@ -1,40 +1,43 @@
-openapi: 3.0.0
-info:
-  version: "0.0.3-unstable"
-  title: VC API
-  description: This is an Experimental Open API Specification for the [VC Data Model](https://www.w3.org/TR/vc-data-model/).
-  license:
-    name: W3C Software and Document License
-    url: http://www.w3.org/Consortium/Legal/copyright-software.
-  contact:
-    name: GitHub Source Code
-    url: https://github.com/w3c-ccg/vc-api
-paths:
-components:
-  schemas:
-    IssueCredentialOptions:
-      type: object
-      additionalProperties: false
-      description: Options for specifying how the DataIntegrityProof is created.
-      properties:
-        created:
-          type: string
-          description: The date and time of the proof (with a maximum accuracy in seconds). Default current system time.
-        challenge:
-          type: string
-          description: A challenge provided by the requesting party of the proof. For example 6e62f66e-67de-11eb-b490-ef3eeefa55f2
-        domain:
-          type: string
-          description: The intended domain of validity for the proof. For example website.example
-        credentialStatus:
-          type: object
-          description: The method of credential status to issue the credential including. If omitted credential status will be included.
-          properties:
-            type:
-              type: string
-              description: The type of credential status to issue the credential with
-      example:
-        {
-          "created": "2020-04-02T18:48:36Z",
-          "credentialStatus": { "type": "RevocationList2020Status" },
-        }
+openapi: 3.0.0
+info:
+  version: "0.0.3-unstable"
+  title: VC API
+  description: This is an Experimental Open API Specification for the [VC Data Model](https://www.w3.org/TR/vc-data-model/).
+  license:
+    name: W3C Software and Document License
+    url: http://www.w3.org/Consortium/Legal/copyright-software.
+  contact:
+    name: GitHub Source Code
+    url: https://github.com/w3c-ccg/vc-api
+paths:
+components:
+  schemas:
+    IssueCredentialOptions:
+      type: object
+      additionalProperties: false
+      description: Options for specifying how the DataIntegrityProof is created.
+      properties:
+        created:
+          type: string
+          description: The date and time of the proof (with a maximum accuracy in seconds). Default current system time.
+        challenge:
+          type: string
+          description: A challenge provided by the requesting party of the proof. For example 6e62f66e-67de-11eb-b490-ef3eeefa55f2
+        domain:
+          type: string
+          description: The intended domain of validity for the proof. For example website.example
+        credentialStatus:
+          type: object
+          description: The method of credential status to issue the credential including. If omitted credential status will be included.
+          properties:
+            type:
+              type: string
+              description: The type of credential status to issue the credential with
+        mandatoryPointers:
+          type: array
+          description: Used with selective disclosure schemes to specify mandatory reveal statements
+      example:
+        {
+          "created": "2020-04-02T18:48:36Z",
+          "credentialStatus": { "type": "RevocationList2020Status" },
+        }