improve validity fields results

Signed-off-by: pstlouis <[email protected]>

components/ProblemDetail.yml → components/ProblemDetails.yml

@@ -16,9 +16,6 @@ components:
       type:
         type: string
         description: URL identifying the type of problem.
-      code:
-        type: integer
-        description: Integer that identifies the type of the problem.
       title:
         type: string
         description: Short but specific human-readable string for the problem.
@@ -27,7 +24,6 @@ components:
         description: Longer human-readable string for the problem.
       example: { 
         "type": "https://www.w3.org/TR/vc-data-model#PARSING_ERROR", 
-        "code": -64, 
         "title": "PARSING_ERROR", 
         "detail": "There was an error while parsing input.", 
       }

components/VerifyCredentialResult.yml

@@ -15,27 +15,53 @@ components:
     VerificationResult:
       type: object
       additionalProperties: false
-      description: Object summarizing a verification
+      description: Object to report the result of a verification process on a VerifiableCredential.
       properties:
         verified:
           type: boolean
-          description: Overall verification assertion of the payload. This is set to True if no errors were detected during the verification process, otherwise False. See error handling section for more guidance around errors, warnings, validation and verification.
+          description: Overall verification assertion of the VerifiableCredential. This is set to True if no errors were detected during the verification process, otherwise False. See error handling section for more guidance around errors, warnings, validation and verification steps.
+        credential:
+          type: object
+          description: The VerifiableCredential used as the verification input.
+        warnings:
+          type: array
+          description: Array consisting of ProblemDetails warning objects.
+          items:
+            type: object
+        errors:
+          type: array
+          description: Array consisting of ProblemDetails error objects.
+          items:
+            type: object
         results:
           type: object
           additionalProperties: false
-          description: Verification results to be included as a more verbose output.
+          description: Verification results to be included as a more verbose output. Keys are mapped to properties from the Verifiable Credential Data Model which are subject to validations.
           properties:
-            validityPeriod:
+            validFrom:
               type: object
-              description: Results from validating the validFrom and validUntil values if present in the VerifiableCredential.
+              description: Results from validating the validFrom property if present in the VerifiableCredential.
               properties:
                 valid:
                   type: boolean
-                  description: Results from validating the validFrom and validUntil values. 
-                validFrom:
+                  description: Validation result.
+                  details:
+                    type: string
+                    description: Optional information to provide in the response.
+                input:
                   type: string
                   description: The validFrom value.
-                validUntil:
+            validUntil:
+              type: object
+              description: Results from validating the validUntil property if present in the VerifiableCredential.
+              properties:
+                valid:
+                  type: boolean
+                  description: Validation result.
+                  details:
+                    type: string
+                    description: Optional information to provide in the response.
+                input:
                   type: string
                   description: The validUntil value.
             credentialSchema:
@@ -48,6 +74,9 @@ components:
                   valid:
                     type: boolean
                     description: Results from validating the credentialSchema object.
+                  details:
+                    type: string
+                    description: Optional information to provide in the response.
                   input:
                     type: object
                     description: The credentialSchema object.
@@ -58,9 +87,15 @@ components:
                 type: object
                 description: Results from validating a credentialStatus object.
                 properties:
+                  value:
+                    type: integer
+                    description: Value of the statusEntry Bit.
                   valid:
                     type: boolean
                     description: Results from validating the credentialStatus object.
+                  details:
+                    type: string
+                    description: Optional information to provide in the response.
                   input:
                     type: object
                     description: The credentialStatus object.
@@ -74,20 +109,22 @@ components:
                   valid:
                     type: boolean
                     description: Results from validating the proof object.
+                  details:
+                    type: string
+                    description: Optional information to provide in the response.
                   input:
                     type: object
                     description: The proof object.
-        warnings:
-          type: array
-          description: Array consisting of ProblemDetails warning objects.
-          items:
-            type: object
-        errors:
-          type: array
-          description: Array consisting of ProblemDetails error objects.
-          items:
-            type: object
-        credential:
-          type: object
-          description: The verified credential used as the verification payload.
-      example: { "verified": True, "results": {"credentialSchema": [], "credentialStatus": [], "proof": []}, "warnings": [], "errors": [] }
+      example: { 
+        "verified": True, 
+        "credential": {},
+        "warnings": [], 
+        "errors": [],
+        "results": {
+          "validFrom": [], 
+          "validUntil": [], 
+          "credentialSchema": [], 
+          "credentialStatus": [], 
+          "proof": []
+          }
+      }