w3c-ccg / vc-api

A specification for an HTTP API used to issue and verify Verifiable Credentials.
https://w3c-ccg.github.io/vc-api
Other
123 stars 47 forks source link

Adding section that details API Endpoints by Component #384

Closed eric-schuh closed 3 months ago

eric-schuh commented 4 months ago

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 in the VC-API, grouping them by the component the endpoint is expected to live on, along with a table for each of these components that lists the API endpoint, as well as the component that is the expected caller of the endpoint.

The workflow/exchanges endpoints are not currently indexed but should be added after the following PR is completed: https://github.com/w3c-ccg/vc-api/pull/382


Preview | Diff

eric-schuh commented 4 months ago

From review on 5/14 call:

eric-schuh commented 3 months ago

Updated to use the new parameter x-expectedCaller in yml files, also added x-expectedCaller to the new exchanges.yml endpoints.