FAQ

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

    resolving-references


    Formats: Severity:

    This rule cannot be disabled or configured. It is built into vacuum and always runs.


    A reference could not be resolved. This means it could not be located in the local document, or via a remote reference to an external file or URL.

    What is this rule checking for?

    All references in the OpenAPI specification must be resolvable. This means that the reference must point to a valid location in the document, or to a valid external resource.

    Why did this violation appear?

    Part of the model is broken and something cannot be resolved. This could be due to a typo, a missing file, or a broken URL.

    All references must resolve, otherwise the specification is invalid.