[S2S]: API Symmetry of Verification and Credential Lifecycle
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 125
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Currently, Verification and Credential Lifecycle have a slight asymmetry:
Verification has a purposes-specific 'cancel' life cycle API, and it's Status etc APIs are not bi-directional.
In contrast, Credential's life cycle API is generic with an enum, and all the APIs are bi-directional (to provide support for reconciliation)
Ergonomically these APIs are very conceptually similar:
A Status, notification/fetching state of the status, and modifications to the status. Issue is tracking if there is a nice way to improve the ergonomics of the APIs by make these more symmetric.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Compare the Verification and Credential Lifecycle API definitions and their status, notification or fetching, and modification operations. Determine a symmetric API shape that preserves reconciliation support and the existing cancellation semantics; the issue does not name files or tests, so the relevant entry points must first be located.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, backend-api-design
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100