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.

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

add returnPresentation option to presentations/verify #380

Merged
merged 3 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
6 changes: 5 additions & 1 deletion components/VerifyPresentationOptions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,12 @@ components:
domain:
type: string
description: The intended domain of validity for the proof. For example website.example
returnPresentation:
type: boolean
description: Should the verified presentation be returned in the response? If true, then the verified presentation should be returned in the form in which it was verified. If false or not provided, then the verified presentation should not be returned.
example:
{
"domain": "example.com",
"challenge": "d436f0c8-fbd9-4e48-bbb2-55fc5d0920a8"
"challenge": "d436f0c8-fbd9-4e48-bbb2-55fc5d0920a8",
"returnPresentation": true
}
38 changes: 38 additions & 0 deletions components/VerifyPresentationResult.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
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:
VerificationResult:
type: object
additionalProperties: false
description: Object summarizing a verification
properties:
checks:
type: array
description: The checks performed
items:
type: string
warnings:
type: array
description: Warnings
items:
type: string
errors:
type: array
description: Errors
items:
type: string
verifiedPresentation:
msporny marked this conversation as resolved.
Show resolved Hide resolved
type: object
description: The verified presentation
example: { "checks": ["proof"], "warnings": [], "errors": [] }
4 changes: 2 additions & 2 deletions verifier.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ components:
options:
$ref: "./components/VerifyCredentialOptions.yml#/components/schemas/VerifyCredentialOptions"
VerifyCredentialResponse:
$ref: "./components/VerificationResult.yml#/components/schemas/VerificationResult"
$ref: "./components/VerifyCredentialResult.yml#/components/schemas/VerificationResult"
VerifyPresentationRequest:
type: object
properties:
Expand All @@ -121,6 +121,6 @@ components:
presentation:
$ref: "./components/Presentation.yml#/components/schemas/Presentation"
VerifyPresentationResponse:
$ref: "./components/VerificationResult.yml#/components/schemas/VerificationResult"
$ref: "./components/VerifyPresentationResult.yml#/components/schemas/VerificationResult"
CreateChallengeResponse:
$ref: "./components/Challenge.yml#/components/schemas/CreateChallengeResult"