Skip to main content



This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:

If a schema definition references another definition (alias or not), the reference must be resolvable and not form any kind of loop.

Maximum SeverityError
MessageA circular reference found in schema definitions.
Rule SystemSemantic
Broad CategoryOpenAPI Schemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi apimatic semantic linting schema reference $ref circular loop

Suggested Fixes

  • Ensure that your schema definition does not reference itself, either directly or indirectly via another schema definition.
  • If your schema entry is an alias definition, ensure that the alias resolves into a concrete schema definition.
  • If the schema alias definition needs to reference another alias definition, ensure that the aliases are not referencing each other and forming a loop which can't be resolved.

For More Information