opencontainers / opencontainers/distribution-spec

proposal: add error code QUOTA_EXCEEDED

Open
#77 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Go
Stars
1.1k
Forks
260
Avg merge
3d 23h
Merged PRs (30d)
1

Description

The list of error codes contains some quite broad categories like DENIED, but also a lot of very specific errors. Are you all generally interested in extending this list as new needs arise in alternative implementations of the API? Or should implementations just choose the most appropriate pre-existing error code?

If there is interest, I propose the addition of an error code QUOTA_EXCEEDED which can be returned from any PUT, PATCH or POST operation. Right now, I'm using DENIED for this (example), but only because DENIED is the most generic of the existing error codes.

If there is interest in adding the new error code, I'll prepare a PR after the holidays.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the Errors section of spec.md, especially the existing error-code categories, and review the linked Keppel example showing how DENIED is currently used. Done would require agreement on whether new codes should be added and, if approved, a clearly specified QUOTA_EXCEEDED addition covering the proposed PUT, PATCH, and POST operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.