unique-specification-extension-name
Overview
This rule belongs to the openapi-v3-standards-validation ruleset and states that:
Specification extensions are patterned fields that must have unique values within the object they are extending. The keys represent the names assigned to the vendor extensions that must be prefixed by 'x-'.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Duplicate specification extension entry found. |
| Code | OPENAPI3STANDARDS_V460 |
| Type | Validation |
| Rule System | Semantic |
| Broad Category | Specification Extensions |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi standards semantic validation specification extensions vendor extensions extensions |
Suggested Fixes
- Remove duplicate specification extension entries from the object that these extensions are extending.
- Specification extension keys are compared in a case-sensitive manner.
For More Information
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#specification-extensions
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#format
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#specification-extensions
- https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#format
- https://docs.apimatic.io/rulesets/overview/