pre-defined-required-schema-property

Overview

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

The properties listed in the required list of a schema must be pre-defined in the schema properties.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The schema required list references an undefined schema property.
Code	OPENAPI3APIMATIC_L684
Type	Linting
Rule System	Semantic
Broad Category	OpenAPI Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	openapi3 openapi apimatic semantic linting required schema properties predefined

Suggested Fixes

• Ensure that all properties listed in the required list of the schema are pre-defined in the schema properties.

For More Information

• 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
• https://docs.apimatic.io/rulesets/overview/