FAQ

  • GitHub GitHub Repo stars
  • Discord Discord Server
  • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    owasp-define-error-responses-429


    Formats: Severity:

    OWASP API Security recommends defining schemas for all responses. This includes the 429 response error code.

    Bad example

    openapi: "3.1.0"
    info:
      version: "1.0"
    paths:
      /:
        get:
          responses:
            200:
              description: ok
              content:
                "application/problem+json":
    

    Good Example

    openapi: "3.1.0"
    info:
      version: "1.0"
    paths:
      /:
        get:
          responses:
            429:
              description: ok
              content:
                "application/json":
    

    How do I fix this violation?

    Extend the responses of all endpoints to include 429 response error codes.