opencontainers / opencontainers/distribution-spec
Clarify multiple multiple-error semantics
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 1.1k
- Forks
- 260
- Avg merge
- 3d 23h
- Merged PRs (30d)
- 1
Description
The error-codes section allows for multiple errors to be returned, but doesn't clarify how the client should interpret such a return. For example, there might be several different error codes. What if they conflict?
Do any registries return multiple error codes in the real world, and if so, under what circumstances?
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
Start with the error-codes section in spec.md and review how it currently describes multiple returned errors. Investigate whether registries return multiple error codes and under what circumstances, then define what clients should do when codes conflict. The documentation is done when the multiple-error semantics and conflict handling are unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100