FAQ

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

    jsonSchemaRefValid


    jsonSchemaRefValid is the rule hook used for JSON Schema reference validation results.

    Reference resolution is performed by vacuum’s libopenapi-backed index and rolodex pipeline. The resolver loads local, relative and remote references, tracks circular references and reports failures back through the json-schema-ref-valid rule.

    Example ruleset configuration

    json-schema-ref-valid:
      description: $ref values must resolve successfully.
      type: validation
      severity: error
      given: $
      then:
        function: jsonSchemaRefValid
    

    The function itself acts as a reporting hook; the resolver does the reference work before rules are executed.


    View Function Source