valid-xml-name
Overview
This rule belongs to the openapi-v3-apimatic-syntax-linting ruleset and states that:
Name assigned to an XML entity must follow W3C Extensible Markup Language recommendations.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | Invalid XML name found. |
| Code | OPENAPI3APIMATICSYNTAX_L841 |
| Type | Linting |
| Rule System | Syntax |
| Broad Category | OpenAPI XML |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi syntax linting apimatic xml name |
Suggested Fixes
- Ensure that XML name is valid.
- Element names are case-sensitive
- Element names must start with a letter or underscore
- Element names cannot start with the letters xml (or XML, or Xml, etc)
- Element names can contain letters, digits, hyphens, underscores, and periods
- Element names cannot contain spaces