only-schema-properties-can-be-xml-attributes

Overview

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

Only schema properties can be marked as XML attributes while the root schema can only be marked as XML element.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The root schema cannot be marked as an XML attribute.
Code	OPENAPI3APIMATIC_L847
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 properties xml attribute

Suggested Fixes

• Declare root schema as XML element.

For More Information

• https://www.apimatic.io/
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#schema-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#xml-object
• https://docs.apimatic.io/rulesets/overview/