redocly-cli/docs/rules/no-required-schema-properties-undefined.md

slug

slug
/docs/cli/rules/no-required-schema-properties-undefined

no-required-schema-properties-undefined

Ensures there are no required schema properties that are undefined.

OAS	Compatibility
2.0	✅
3.0	✅
3.1	✅

flowchart TD

Root ==> Components ==> Schemas

style Schemas fill:#codaf9,stroke:#0044d4,stroke-width:5px

API design principles

If a required schema property is declared but not defined, this rule informs you which of the required schema properties are missing.

Configuration

Option	Type	Description
severity	string	Possible values: off, warn, error. Default off (in recommended configuration).

An example configuration:

rules:
  no-required-schema-properties-undefined: error

Examples

Given this configuration:

rules:
  no-required-schema-properties-undefined: error

Example of incorrect schema properties:

schemas:
  Pet:
    type: object
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64

Expected error message when linting incorrect schema example:

Required property 'name' is undefined.

Example of correct schema properties:

schemas:
  Pet:
    type: object
    required:
      - id
      - name
    properties:
      id:
        type: integer
        format: int64
      name:
        type: string
        example: doggie

The rule is case-sensitive, which means a property name does not match the string Name in the required list:

schemas:
  Pet:
    type: object
    properties:
      name:
        type: string
    required:
      - Name

Related rules

• no-invalid-schema-examples

Resources

• Rule source
• Schema docs