Skip to main content

specification-extension-name-begin-with-x-dash

Overview​

This rule belongs to the openapi-v3-syntax-validation ruleset and states that:

If any additional property needs to be added in the OpenAPI specification that is otherwise not part of the actual standard, specification extensions can be used for this purpose at certain points. The extension name must begin with x- (e.g. x-internal-id). An exception to this rule is only for Schema Objects of OpenAPI v3.1.x documents that allows extension names to start even without x-.

PropertyValue
EnabledYes
Maximum SeverityError
MessageSpecification extension name is invalid.
CodeOPENAPI3SYNTAX_V200
TypeValidation
Rule SystemSyntax
Broad CategorySpecification Extensions
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi 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 space 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.

For More Information​