Skip to content
Last updated

nullable-type-sibling

Ensures that all schemas with nullable field have a type field explicitly set.

OASCompatibility
3.0✅

API design principles

The nullable field is not allowed without the type field explicitly set.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  nullable-type-sibling: error

Examples

Given this configuration:

rules:
  nullable-type-sibling: error

Example of an incorrect usage of nullable field:

components:
  schemas:
    Incorrect:
      nullable: true
    ReferencingATypeButStillIncorrect:
      nullable: true
      allOf:
        - $ref: '#/components/schemas/SomeType'
    SomeType:
      type: string

Example of a correct usage:

components:
  schemas:
    Correct:
      type: string
      nullable: true
    CorrectWithAllOf:
      type: object
      nullable: true
      allOf:
        - type: object
          properties:
            name:
              type: string
        - type: object
          properties:
            age:
              type: number

Resources

 
Next page