required-xml-name-in-parameter-schema
Overview
This rule belongs to the openapi-v3-apimatic-linting ruleset and states that:
In OpenAPI specifications, when using XML for the parameter schema, it is required to specify the XML name. However, for array non-wrapped cases, the name does not need to be directly specified in the schema XML. In such cases, it will be present in the inner items schema.
| Property | Value |
|---|---|
| Enabled | Yes |
| Maximum Severity | Error |
| Message | XML name is required for parameter schema. |
| Code | OPENAPI3APIMATIC_L840 |
| Type | Linting |
| Rule System | Semantic |
| Broad Category | OpenAPI XML |
| Products Impacted | API Transformer, Code Generation, Developer Experience Portal |
| Tags | openapi3 openapi apimatic semantic linting parameter schema xml name |
Suggested Fixes
- Check the OpenAPI specification to confirm if any parameter schema is missing an XML name.
- If any parameter schema is missing an XML name, update the specification to include an XML name for the parameter schema.