reference-object-summary-overrides-referenced-object-summary

Overview

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

If the property summary is specified in the Reference Object as a sibling of property $ref and also specified in the object referenced using $ref, the Reference Object level summary will override the one provided in the referenced object.

Property	Value
Enabled	Yes
Maximum Severity	Information
Message	Summary specified in the Reference Object overrides the summary provided in the referenced object.
Code	OPENAPI3STANDARDS_L141
Type	Linting
Rule System	Semantic
Broad Category	References
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi standards semantic linting summary reference ref $ref

Suggested Fixes

• If you do not want the summary in the referenced object to be overridden this way, remove the summary property from the Reference Object.

For More Information

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#reference-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://docs.apimatic.io/rulesets/overview/