required-xml-name-in-schema-property
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
In OpenAPI specifications, when using XML for schema properties, the XML name is required to be specified. An XML name should be specified for schema properties to ensure that the schema is properly defined and can be used correctly.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | XML name is required for schema property. |
| Code | OPENAPI3APIMATIC_L843 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI XML |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting schema property xml name |
Suggested Fixes
- Check the OpenAPI specification to confirm if any schema property is missing an XML name.
- If any schema property is missing an XML name, update the specification to include an XML name for the schema property.