FAQ

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

    circular-references


    Formats: Severity:

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

    There are plans to make it configurable before 1.0


    Circular references may or may not be desirable. However, they can cause issues with certain tools and parsers.

    To learn more about how vacuum handles circular references, see the libopenapi documentation.

    What is this rule checking for?

    Circular references in the OpenAPI specification, created either by a self loop, or via a sub schema or a polymorphic schema.

    Why did this violation appear?

    A circular reference was detected in the OpenAPI specification. It may be a problem and you should know about it.