link-operation-ref-points-to-an-operation-object
Overview
This rule belongs to the openapi-v3-standards-validation
ruleset and states that:
The operationRef
is a relative or absolute URI reference that must point to an OAS Operation Object.
Property | Value |
---|---|
Enabled | Yes |
Maximum Severity | Error |
Message | Operation reference in Link Object using operationRef does not point to an Operation Object. |
Code | OPENAPI3STANDARDS_V237 |
Type | Validation |
Rule System | Semantic |
Broad Category | Links |
Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
Tags | openapi3 openapi standards semantic validation operation ref ref operation link |
Suggested Fixes
- Ensure that the path provided in
operationRef
is a valid resolvable path. - Ensure that the component you are trying to reference using
operationRef
is indeed an Operation Object. - Ensure that the Operation Object being referenced contains required properties for it to be considered a valid Operation Object e.g. responses.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#link-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operationObject
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#link-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#operation-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/