414 problem details response #418
Conversation
Signed-off-by: pstlouis <[email protected]>
Signed-off-by: pstlouis <[email protected]>
PatStLouis
requested review from
msporny,
mavarley and
mkhraisha
as code owners
Signed-off-by: pstlouis <[email protected]>
Signed-off-by: pstlouis <[email protected]>
| description: The verified credential | ||
| example: { "checks": ["proof"], "warnings": [], "errors": [] } | ||
| description: The verified credential used as the verification payload. | ||
| example: { "verified": True, "results": {"credentialSchema": [], "credentialStatus": [], "proof": []}, "warnings": [], "errors": [] } |
There was a problem hiding this comment.
| example: { "verified": True, "results": {"credentialSchema": [], "credentialStatus": [], "proof": []}, "warnings": [], "errors": [] } | |
| example: { "verified": true, "results": {"credentialSchema": [], "credentialStatus": [], "proof": []}, "warnings": [], "errors": [] } |
Signed-off-by: pstlouis <[email protected]>
| type: string | ||
| description: Longer human-readable string for the problem. | ||
| example: { | ||
| "type": "https://www.w3.org/TR/vc-data-model#PARSING_ERROR", |
There was a problem hiding this comment.
I found it a bit confusing that this example was to a type that isn't actually defined in the VC data model as far as I can tell (a GET to https://www.w3.org/TR/vc-data-model#PARSING_ERROR just leads to the spec root for me). Are there actual error types defined for VC verification somewhere? If not, perhaps using example.com for now could be clearer that it is just an example.
There was a problem hiding this comment.
This URL works now, and the one in the spec will work after VCDM v2.0 becomes a global standard: https://www.w3.org/TR/vc-data-model-2.0/#PARSING_ERROR
Suggestion is to add a warning in the spec via class="issue" that warns about the URLs not working today, but will in the future, and how to hack at the URL to get it to work today.
An issue was also mentioned about the error type `https://www.w3.org/TR/vc-data-model#PARSING_ERROR` not resulting in any meaningful destination/description. Co-authored-by: Ted Thibodeau Jr <[email protected]>
| "credentialSchema": [], | ||
| "credentialStatus": [], | ||
| "proof": [] | ||
| } |
There was a problem hiding this comment.
Indentation nit:
| } | |
| } |
| details: | ||
| type: string | ||
| description: Optional information to provide in the response. |
There was a problem hiding this comment.
| details: | |
| type: string | |
| description: Optional information to provide in the response. | |
| details: | |
| type: string | |
| description: Optional information to provide in the response. |
| details: | ||
| type: string | ||
| description: Optional information to provide in the response. |
There was a problem hiding this comment.
| details: | |
| type: string | |
| description: Optional information to provide in the response. | |
| details: | |
| type: string | |
| description: Optional information to provide in the response. |
| type: boolean | ||
| description: Results of validating the proof object. | ||
| details: | ||
| type: string |
There was a problem hiding this comment.
Should this be an object instead everywhere? Is this meant to be a description? If so, it should be "message" probably?
| "warnings": [], | ||
| "errors": [], |
There was a problem hiding this comment.
| "warnings": [], | |
| "errors": [], | |
| "problemDetails": [], |
| valid: | ||
| type: boolean | ||
| description: Results of validating the credentialSchema object. | ||
| details: | ||
| type: string | ||
| description: Optional information to provide in the response. |
There was a problem hiding this comment.
| valid: | |
| type: boolean | |
| description: Results of validating the credentialSchema object. | |
| details: | |
| type: string | |
| description: Optional information to provide in the response. | |
| problemDetails: | |
| type: [ProblemDetails] | |
| description: Array of problem details objects |
ProblemDetailsobject.