Last updated

response-contains-property

Enforces definition of specific response properties based on HTTP status code or HTTP status code range. A specific status code takes priority over the status code range.

OASCompatibility
2.0✅
3.0✅
3.1✅

API design principles

In some cases, it is important to design an API so that it consistently returns specific properties in responses. Sometimes people want different response properties for collections compared to an individual resource. This rule helps enforce that behavior across all or some responses in an API.

Configuration

OptionTypeDescription
severitystringREQUIRED. Possible values: off, warn, error.
namesMap (HTTP response code or range, [string])REQUIRED. For a given HTTP response code or range, the corresponding list of expected response properties.

An example configuration:

rules:
  response-contains-property:
    severity: error
    names:
      2XX:
        - created_at
        - updated_at
      '400':
        - code

Examples

Given this configuration:

rules:
  response-contains-property:
    severity: error
    names:
      2XX:
        - created_at
        - updated_at
      '400':
        - code

Example of an incorrect response:

paths:
  /customers:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer

Example of a correct response:

paths:
  /customers:
    post:
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                  created_at:
                    type: string
                    format: date-time
                  updated_at:
                    type: string
                    format: date-time

Resources

 
Next page