FAQ

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

    post-response-success


    Formats: Severity:

    Every POST operation must have a successful response code (2XX or 3XX).

    Why did this violation appear?

    There is a POST Operation response in your specification that has not defined a success response code.

    What is this rule checking for?

    Every POST Operation response is checked for the inclusion of at least one success response code.

    A bad example

    "/pet":
      post:
        responses:
          '404':
            description: New pet was added, great job.
    

    A good example

    "/pet":
      post:
        operationId: createNewPet
        responses:
          '200':
            description: New pet added, great job. 
    

    How do I fix this violation?

    Every single POST Operation should have at least one success response code.