vc-api

vc-api copied to clipboard

Adding section that details API Endpoints by Component

1

This PR looks to resolve https://github.com/w3c-ccg/vc-api/issues/285 A section has been added to the "The VC API " section of the document called "API Component Overview". This section summarizes all endpoints...

eric-schuh

We need support for custom fields in the OAS, which is only supported in a newer version of OAS.

msporny

proposition to follow rfc9457 for API errors

1

RFC 9457 (https://www.rfc-editor.org/rfc/rfc9457.html) defines a Problem Details response for HTTP APIs. It proposes a standard response object to explicit the error (instead of just returning error status for instance). By...

lemoustachiste

Update `/credentials/{{id}}` endpoint to return `{verifiableCredential}` to be consistent with other APIs

1

Today the VC is directly returned -- instead it should be returned under the `verifiableCredential` property to be consistent with other APIs and to allow for additional meta data to...

dlongley

Should the API define error codes?

2

The API has the capability of returning ProblemDetail errors today but does not define error codes itself (many of the codes come from the VCDM or status list specifications). It...

msporny

Add support for advanced BBS features like pseudonyms

1

Protocols, such as VC API, that support unlinkable disclosure schemes (such as BBS or CL Signatures) with features such as pseudonyms and binding to a secret that a holder possesses,...

msporny

Consider allowing a client to request information about an exchange via non-empty post body

4

When a client is starting an exchange, it should be able to send a signal in a non-empty post body to request information about what action the exchange will perform...

dlongley

`workflowId` should be `id` in posted and returned workflow configuration

1

When creating a workflow, the configuration for that workflow may include, optionally, the ID for that workflow under the property `id`. The bug currently says that property is `workflowId` and...

dlongley

I believe that because the [Workflows and Exchanges](https://w3c-ccg.github.io/vc-api/#workflows-and-exchanges) section has been added, the exchange section from the Presenting could be removed. I propose the following be removed: - [Inititate Exchange](https://w3c-ccg.github.io/vc-api/#initiate-exchange)...

jrhender

Should returning `ProblemDetail` objects be mandatory?

6

The VCDM, DI, BSL all have normative examples of `ProblemDetail` objects in their error handling sections. The verification algorithms have normative statements about exposing errors as well. The VC API...

msporny