This rule belongs to the
openapi-v3-standards-validation ruleset and states that:
required is specified in the Schema Object of an OpenAPI 3.0.x document, it must be a list containing at least one schema property name that needs to be marked as mandatory.
|Message||List of required properties of Schema Object is empty.|
|Products Impacted||API Transformer, Code Generation, Developer Experience Portal|
- If you do not intend to mark any property as required, remove the
requiredproperty from the Schema Object as by default all properties are considered optional.
- If you want to specify the
requiredproperty, it must contain at least one entry.
- The list of items in the
requiredproperty need to be names of the properties defined inside the
propertiesproperty of the Schema Object. The name of the property in the list must match exactly with the name of the schema property. Names are compared in a case-sensitive manner.
For More Information