FAQ

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

    requiredFieldsDefined


    requiredFieldsDefined checks schemas that declare required fields and verifies that those field names are also declared in properties or found through composed schemas.

    This function is advisory rather than strict schema validation. It is useful when you want required object fields to be explicit for documentation, code generation, and schema maintenance.

    Example ruleset configuration

    required-fields-defined:
      description: "Required schema fields should be declared in properties"
      type: "validation"
      recommended: false
      severity: "warn"
      given: "$"
      then:
        function: "requiredFieldsDefined"
    

    The function is used by the required-fields-defined Rule


    View Function Source