FAQ

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

    json-schema-dependent-required-defined


    Formats: Severity:

    This rule checks dependentRequired maps.

    When one property requires another property to be present, both names should be meaningful for the object schema.

    Bad example

    {
      "type": "object",
      "properties": {
        "giftWrap": {
          "type": "boolean"
        }
      },
      "dependentRequired": {
        "giftWrap": ["message"]
      }
    }
    

    Good example

    {
      "type": "object",
      "properties": {
        "giftWrap": {
          "type": "boolean"
        },
        "message": {
          "type": "string"
        }
      },
      "dependentRequired": {
        "giftWrap": ["message"]
      }
    }
    

    How do I fix this violation?

    Declare the dependent property, or remove it from dependentRequired.