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

Jump to bottom

docs: adds detail to vc-api rfc #91

Merged
merged 1 commit into from
Jun 15, 2023
Merged

docs: adds detail to vc-api rfc #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 29 additions & 2 deletions rfcs/features/0031-vc-api/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@

## Summary

One paragraph explanation of the feature.
Once emerging standard for interactions between verifiable credential agents
is the w3c vc-api. This RFC proposes creating an express router that can be
added to a vckit/veramo agent such that it exposes agent methods via the
vc-api interface.

## Motivation

Why are we doing this? What use cases does it support? What is the expected
outcome?

## Tutorial
- interoperability
- expected outcome is the be able to register for and pass vc-api interop test suite.

## Tutorial
```
Explain the proposal as if it were already implemented and you
were teaching it to another vc-kit contributor or vc-kit consumer. That generally
means:
Expand All @@ -31,6 +37,16 @@ migration guidance.

Some enhancement proposals may be more aimed at contributors (e.g. for
consensus internals); others may be more aimed at consumers.
```
> TODO: elaborate on tutorial dot points below

- overview of vc-api operations
- mapping to agent methods
- request / response structure mappings
- authorization
- testing conformance
- agent configuration
- api-docs and example requests

## Reference

Expand All @@ -47,13 +63,24 @@ Strive to guarantee that:

Why should we *not* do this?

- still draft/experimental spec

## Rationale and alternatives

- Why is this design the best in the space of possible designs?
- What other designs have been considered and what is the rationale for not
choosing them?
- What is the impact of not doing this?

- there are multiple other alternatives for interactions between agents, but
no single standardised approach. a large part of the justification for the
choice of veramo as a foundation for vc-kit is it's modularity. The vc-api
is an easy win to begin demonstrating conformance / interop with other vc
implementations.

- also forms a foundation for extending to implement the traceability interop
api spec.

## Prior art

Discuss prior art, both the good and the bad, in relation to this proposal.
Expand Down