discriminator-property-name-exists-in-schema-required-list

Overview

This rule belongs to the swagger-v2-standards-validation ruleset and states that:

The name specified for the discriminator in the Schema Object must correspond with a required property name defined in the required property of the schema object it is part of.

Property	Value
Enabled	Yes
Maximum Severity	Error
Message	The discriminator property cannot be optional.
Code	SWAGGER20STANDARDS_V316
Type	Validation
Rule System	Semantic
Broad Category	Schemas
Products Impacted	API Transformer, Code Generation, Developer Experience Portal
Tags	swagger2 swagger standards semantic validation discriminator name schema schema object properties property

Suggested Fixes

• Add the missing required property name to the required property of the Schema Object.
• Make sure that the name assigned to the discriminator in the Schema Obect matches exactly with the name of one of the required property names. Names are compared in a case-sensitive manner.

For More Information

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