specification-extension-name-being-with-x-dash
Overview
This rule belongs to the swagger-v2-syntax-validation ruleset and states that:
If any additional property needs to be added in the Swagger specification that is otherwise not part of the actual standard, specification extension can be used for this purpose at certain points. The extension name must begin with x- (e.g. x-internal-id).
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Specification extension name is invalid. |
| Code | SWAGGER20SYNTAX_V080 |
| Type | Validation |
| Rule System | Syntax |
| Broad Category | Specification Extensions |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | swagger2 swagger syntax validation name specification extensions vendor extensions extensions |
Suggested Fixes
- Make sure that the name of the extension begins with a lower case 'x' which is then followed by a dash '-'. There must be no spaces between the two.
- There must be no trailing whitespace characters at the start of the extension name.
- Ensure that the current object allows for extensions.