search

w3c-ccg / vc-issuer-http-api

A specification for an HTTP API used to issue Verifiable Credentials.
https://w3c-ccg.github.io/vc-http-api/
Other
7 stars 5 forks source link

Proposal for v0.0.2 #22

Closed OR13 closed 4 years ago

OR13 commented 4 years ago

Due to time considerations mostly impacted DHS SVIP companies, there is a desire to publish a v0.0.2 version of the issuer API with limited functionality while we continue to debate additional functionality.

First, we need to agree to a versioning scheme:

Everyone should expect v1 to contain breaking changes.

Proposal follows:

POST ${apiRoot}/issuer/credentials { payload, options }
POST ${apiRoot}/verifier/credentials { vc, options }

These endpoints to be added to the existing swagger.

ONLY support JSON-LD format and verificationMethod reference as options for issue.
ONLY support JSON-LD format for vc in verify.

Mark all other endpoints optional.

I won't open a PR to implement until I have thumbs up on this ticket from the code owners for this repo:

@peacekeeper @msporny @mavarley

msporny commented 4 years ago

I won't open a PR to implement until I have thumbs up on this ticket from the code owners for this repo

+1

I also want to make it clear that we should (in short order, after we have base consensus) look at JWT, Sovrin, and other representation options to ensure that the APIs work for those communities as well. Digital Bazaar would be -1 to biasing this towards only LD Proofs implementations.

msporny commented 4 years ago

@OR13 I fixed the link from #22 to #25 above... I think you might have copy-pasted the wrong link to the versioning PR?

OR13 commented 4 years ago

I have updated the links, this remains blocked by clear agreement regarding versioning, but I will assume that we will agree to HTTP headers eventually and draft a PR for this proposal.

OR13 commented 4 years ago

There is now a PR up for this proposal: https://github.com/w3c-ccg/vc-issuer-http-api/pull/30

OR13 commented 4 years ago

closing