Last updated

operation-2xx-response

Ensures that every operation in your API document has at least one successful (200-299) HTTP response defined.

OASCompatibility
2.0✅
3.0✅
3.1✅

API design principles

One of the main goals of your API description (and your API documentation) is to help consumers understand how your API behaves and what to expect when working with it.

When designing your APIs, every operation should have a successful HTTP response. If it doesn't, what is the purpose of the operation? Even if there is no response content (204), it can still return a successful response with no content. You can greatly improve the developer and user experience of your APIs by making it a standard to provide this information.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default warn (in recommended configuration).
validateWebhooksbooleanDetermines if responses inside webhooks are validated. Default false.

An example configuration:

rules:
  operation-2xx-response: error

The following example enables validation of responses inside webhooks:

rules:
  operation-2xx-response:
    severity: error
    validateWebhooks: true

Examples

Given this configuration:

rules:
  operation-2xx-response: error

Example of incorrect operation response:

post:
  responses:
    '400':
      $ref: ../components/responses/Problem.yaml

Example of correct operation response:

post:
  responses:
    '200':
      $ref: ../components/responses/Success.yaml
    '400':
      $ref: ../components/responses/Problem.yaml

Resources

 
Next page