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

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

Open dlongley opened 3 months ago

dlongley commented 3 months ago

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 it should be changed to id:

https://github.com/w3c-ccg/vc-api/blob/494f0a2927a7c6766730a6b4f18c8d28daa15131/exchanges.yml#L210

Similarly, the spec currently says that workflowId will be optionally returned, when the entire config can be optionally returned, which will include the workflow ID in the id property of the configuration object (just like how it can be optionally posted using that property).

msporny commented 2 months ago

The group discussed this on the 2024-07-30 telecon:

There seems to be a typo that needs to be fixed in the specification.

A PR should be raised to fix the typo.