Skip to main content

required-xml-name-for-arrays

Overview​

This rule belongs to the openapi-v3-standards-linting ruleset and states that:

When using arrays, XML element names are not inferred (for singular/plural forms) and the name property should be used to add that information. For wrapped schemas, the name should be specified outside the items schema for the wrapping element and inside the items schema for the inner elements. For non-wrapped schemas, the name should be specified inside the items schema only.

PropertyValue
EnabledYes
Maximum SeverityWarning
MessageXML element name is missing for the array schema.
CodeOPENAPI3STANDARDS_L260
TypeLinting
Rule SystemSemantic
Broad CategoryXML
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic linting name xml array items wrapping schema

Suggested Fixes​

  • Make sure that there is a non-empty non-null name specified in the items schema definition using the name property.
  • If your array schema has wrapping enabled using the wrapped flag, you will also need to specify a non-empty non-null name outside the items schema using the name property.
  • Make sure that the name value is not null or empty.

For More Information​