Skip to main content



This rule belongs to the openapi-v3-standards-validation ruleset and states that:

The Reference Object can only contain the property $ref and any sibling properties are not allowed. If specified, the additional properties will be ignored.

Maximum SeverityWarning
MessageA sibling property of property $ref detected.
Rule SystemSemantic
Broad CategoryReferences
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation sibling reference json pointer ref $ref

Suggested Fixes

  • Remove all other properties from the Reference Object except $ref.
  • If you do not remove the sibling properties, these properties will likely be ignored by the tools you are importing your file into.
  • Use allOf construct to wrap up the $ref object and any sibling data instead.

For More Information