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 workflows and exchange exposition. #416

Merged
merged 11 commits into from
Sep 11, 2024
Merged

Conversation

dlongley
Copy link
Contributor

@dlongley dlongley commented Sep 9, 2024

This PR adds some much needed exposition on workflows and exchanges.


Preview | Diff

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated
Comment on lines 1055 to 1064
If that object is empty, the exchange is complete and nothing is requested nor
offered to the exchange client. If the object includes
`verifiablePresentationRequest`, then the exchange is not yet complete and
some additional information is requested, based on the contents of the
associated verifiable presentation request. If the object includes
`verifiablePresentation`, then some information is offered, such as issued
verifiable credentials or verifiable credentials provided in response to the
exchange client's request. If the object includes `redirectUrl`, the exchange
is complete and the workflow service recommends that the client proceed to
another place to continue the interaction in another form.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a partial rewording. More is needed, especially on the verifiablePresentation case. It's not clear to me what is meant, so I cannot rephrase that sentence. The troublesome bit is such as issued verifiable credentials or verifiable credentials provided in response to the exchange client's request where it's not clear to me what the alternatives are. Maybe such as previously issued verifiable credentials or newly issued verifiable credentials provided in response to the exchange client's request would work here? (It would likely help if things were marked up with [=these=] and related wrappers. Why aren't those liberally sprinkled over this text?)

Suggested change
If that object is empty, the exchange is complete and nothing is requested nor
offered to the exchange client. If the object includes
`verifiablePresentationRequest`, then the exchange is not yet complete and
some additional information is requested, based on the contents of the
associated verifiable presentation request. If the object includes
`verifiablePresentation`, then some information is offered, such as issued
verifiable credentials or verifiable credentials provided in response to the
exchange client's request. If the object includes `redirectUrl`, the exchange
is complete and the workflow service recommends that the client proceed to
another place to continue the interaction in another form.
If that response object is empty, the exchange is complete and nothing is
requested from nor offered to the exchange client. If the object includes
`verifiablePresentationRequest`, then the exchange is not yet complete and
some additional information is requested, as specified by the contents of the
associated verifiable presentation request. If the object includes
`verifiablePresentation`, then some information is offered, such as issued
verifiable credentials or verifiable credentials provided in response to the
exchange client's request. If the object includes `redirectUrl`, the exchange
is complete and the workflow service recommends that the client proceed to
another place to continue the interaction in another form.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding suggestion and will come back to this to resolve the rest of the comment.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, I've tried to clarify this with the latest changes. In short, a VP could include VCs that were issued to the holder that is operating the exchange client OR the VCs could be about whomever is operating the exchange server, i.e., if the holder used their exchange client client to ask a website to provide its own credentials before the holder is willing to continue in the exchange.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regarding [=foo=] ... that pattern doesn't exist at all in the spec at this time (AFAICT). A subsequent PR that adds that sort of thing will need to be done over the whole document, I expect.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
@dlongley
Copy link
Contributor Author

dlongley commented Sep 9, 2024

Thanks @TallTed! I've applied most of your changes, responded to three (I think it was 3) of your suggestions, and asked for a re-review.

index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
index.html Outdated Show resolved Hide resolved
Co-authored-by: Ted Thibodeau Jr <[email protected]>
index.html Outdated Show resolved Hide resolved
index.html Outdated
Comment on lines 1005 to 1006
depends on the workflow service implementation, the complexity of the workflow
the exchange is based on, and the options provided by the coordinator when
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
depends on the workflow service implementation, the complexity of the workflow
the exchange is based on, and the options provided by the coordinator when
the exchange is based on, and the options provided by the coordinator when

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This got a little weird so I applied a separate fix for it.

index.html Outdated Show resolved Hide resolved
@dlongley
Copy link
Contributor Author

@TallTed, everything look good to you now?

index.html Outdated Show resolved Hide resolved
@msporny msporny merged commit 7cd48f1 into main Sep 11, 2024
1 check passed
@msporny msporny deleted the dlongley-update-wf-ex-intro branch September 11, 2024 19:38
VC API exchanges are designed to be executable using other protocols in
addition to the VC API exchange protocol; for example, an exchange could
potentially be executable with any of the OID4VCI, OID4VP, DIDComm, and
VC API exchange protocols. The protocols supported depends on the complexity
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change (delete s) is needed for agreement with the other tweaks by me, @dlongley, and @msporny.

Suggested change
VC API exchange protocols. The protocols supported depends on the complexity
VC API exchange protocols. The protocols supported depend on the complexity

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:( -- your change went in 9 minutes after the PR was merged... can you do this in a new PR (with whatever else you might find)?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants