Skip to content

Add /protocols endpoint to specific exchanges. #489

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

msporny
Copy link
Contributor

@msporny msporny commented Jun 21, 2025

This PR is an attempt to address issue #421 by adding the .../protocols endpoint to exchanges.


Preview | Diff

properties:
interact:
type: string
description: A URL that can be used during human-in-the-loop exchange flows.
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 needs a better description, @dlongley. I'm at a loss as to what to write.

Copy link
Contributor

Choose a reason for hiding this comment

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

Now that we've defined the interact URL, we should just point to that section in the spec and / or reuse language from it. The value for interact is an interaction URL: https://w3c-ccg.github.io/vc-api/#interaction-url-format

Copy link
Collaborator

Choose a reason for hiding this comment

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

Not arguing against @dlongley's suggestion, but this would be better than what's here.

Suggested change
description: A URL that can be used during human-in-the-loop exchange flows.
description: A URL that can be used during exchange flows with a human in the loop.

<h4>Get Exchange Protocols</h4>
<p>
</p>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe we need to explain how interact is supposed to work in this section?

Copy link
Contributor

Choose a reason for hiding this comment

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

Or link to the interaction section? This section should say that the returned object lists all of the protocols supported by the exchange -- and that an implementation may implement an interaction URL handler by proxying/internally fetching this endpoint and returning its result to the caller.

We could use a mermaid style flowchart here to show an interaction URL being retrieved from a coordinator that internally looks up the associated exchange and fetches <exchangeId>/protocols and returns it to the caller. We can then explain that this allows the coordinator to delegate to an exchange service whereby the caller (client, e.g., digital wallet) can still use their trust in the coordinator origin -- as it serves (passes through) the protocols object.

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.

3 participants