FAQ

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

    json-schema-required-properties-defined


    Formats: Severity:

    This rule checks required arrays on object schemas.

    Required field names should be unique and should refer to fields declared in properties.

    Bad example

    {
      "type": "object",
      "required": ["size"],
      "properties": {
        "color": {
          "type": "string"
        }
      }
    }
    

    Good example

    {
      "type": "object",
      "required": ["size"],
      "properties": {
        "size": {
          "type": "string"
        }
      }
    }
    

    How do I fix this violation?

    Declare the required property, or remove the field name from required.