search

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

Make naming scheme for path parameters consistent #412

Open msporny opened 1 month ago

msporny commented 1 month ago

There are a number of path parameters that we have in the specification today, such as id, localWorkflowId, and localExchangeId, where the meaning of the word "local" and "id" are not clear from the specification text.

We might want to distinguish between relative/local IDs and global IDs. Also consider that developers arrange databases using relative/local IDs. Maybe put the word path in the name for parameters that are non-global and only used in paths.

msporny commented 1 month ago

The group discussed this on the 2024-08-13 telecon and noted that we might want to distinguish between relative/local IDs and global IDs. Also consider that developers arrange databases using relative/local IDs. Maybe put the word path in the name for parameters that are non-global and only used in paths.

A PR should be raised to rename all identifiers that are a part of the path to the name of the resource they appear on and PathId appended to them, such as: workflowPathId and credentialPathId and exchangePathId. There should also be a meta explanation about what "PathId" means when used in paths in the specification.