unique-operation-callback-key
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
The key of the Operation Object level callbacks map must be a unique identifier for the Callback Object.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Duplicate operation callback identifier found. |
| Code | OPENAPI3STANDARDS_V056 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Operations |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation key callback operation |
Suggested Fixes
- Remove duplicate entries from the Operation Object callbacks map.
- Callback keys/identifiers are compared in a case-sensitive manner.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#operation-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#callback-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#callback-object
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://docs.apimatic.io/rulesets/overview/