Skip to content

Consider documenting the 429 error response #40

Open

Description

@eric-murray

Problem description
From the API Design Guide:

Error statuses 400, 404, 409, 422, 429: These error statuses SHOULD be documented based on the API design and the functionality involved. Subprojects evaluate the relevance and necessity of including these statuses in API specifications.

Expected action
Consider if implementations of this API may be subject to spike arrest and/or quota policies. If so, consider explicitly documenting the 429 error response code as a possible error for this API.

Additional context
None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions