Skip to main content

at-least-one-property-in-schema-required-list

Overview​

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

If property 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.

PropertyValue
EnabledYes
Maximum SeverityError
MessageList of required properties of Schema Object is empty.
CodeOPENAPI3STANDARDS_V334
TypeValidation
Rule SystemSemantic
Broad CategorySchemas
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation required properties property name object json schema validation json schema

Suggested Fixes​

  • If you do not intend to mark any property as required, remove the required property from the Schema Object as by default all properties are considered optional.
  • If you want to specify the required property, it must contain at least one entry.
  • The list of items in the required property need to be names of the properties defined inside the properties property 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​