Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

414 problem details response #418

Merged
merged 15 commits into from
Oct 22, 2024
Merged

414 problem details response #418

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
8845768
add ProblemDetails object, modify verify credential options and response
PatStLouis Sep 10, 2024
3812669
fix typo
PatStLouis Sep 10, 2024
da8e436
fix linting issue bool to boolean
PatStLouis Sep 10, 2024
a109d8e
add ProblemDetails example
PatStLouis Sep 10, 2024
8bf6848
improve validity fields results
PatStLouis Sep 10, 2024
0a321b8
Apply suggestions from code review
PatStLouis Sep 17, 2024
7d0214d
Replace occurences of warnings/errors with `problemDetails`
PatStLouis Sep 24, 2024
6199f52
Apply linting suggestions from code review
PatStLouis Sep 24, 2024
338586d
Add a warning about the ProblemDetails type URL pending VCDM 2.0 beco…
PatStLouis Sep 24, 2024
6f21128
replace occurence of the property details for message in the response…
PatStLouis Sep 24, 2024
7e7c69e
fix linting and add problem detail object reference
PatStLouis Oct 1, 2024
b93933e
Apply suggestion
PatStLouis Oct 1, 2024
1ba3797
fix related object path for ProblemDetails
PatStLouis Oct 8, 2024
609b5da
Merge branch '414-problem-details-response' of github.com:w3c-ccg/vc-…
PatStLouis Oct 8, 2024
d969201
Apply some linting fix to the ProblemDetails schema
PatStLouis Oct 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions components/ProblemDetail.yml → components/ProblemDetails.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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",
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
"code": -64,
"title": "PARSING_ERROR",
"detail": "There was an error while parsing input.",
}
81 changes: 59 additions & 22 deletions components/VerifyCredentialResult.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
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.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
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.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
input:
type: string
description: The validFrom value.
validUntil:
validUntil:
type: object
description: Results from validating the validUntil property if present in the VerifiableCredential.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
properties:
valid:
type: boolean
description: Validation result.
details:
type: string
description: Optional information to provide in the response.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
input:
type: string
description: The validUntil value.
credentialSchema:
Expand All @@ -48,6 +74,9 @@ components:
valid:
type: boolean
description: Results from validating the credentialSchema object.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
details:
type: string
description: Optional information to provide in the response.
input:
type: object
description: The credentialSchema object.
Expand All @@ -58,9 +87,15 @@ components:
type: object
description: Results from validating a credentialStatus object.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
properties:
value:
type: integer
description: Value of the statusEntry Bit.
valid:
type: boolean
description: Results from validating the credentialStatus object.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
details:
type: string
description: Optional information to provide in the response.
input:
type: object
description: The credentialStatus object.
Expand All @@ -74,20 +109,22 @@ components:
valid:
type: boolean
description: Results from validating the proof object.
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
details:
type: string
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
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": [],
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
"results": {
"validFrom": [],
"validUntil": [],
"credentialSchema": [],
"credentialStatus": [],
"proof": []
}
PatStLouis marked this conversation as resolved.
Show resolved Hide resolved
}
Loading