Skip to main content

required-license-name

Overview​

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

The License Object must specify name of the license (used for the API) using the name property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property name in License Object is missing.
CodeOPENAPI3STANDARDS_V020
TypeValidation
Rule SystemSemantic
Broad CategoryLicense
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation name license

Suggested Fixes​

  • Add missing name property in the License Object.
  • Make sure that the name property value is not null or empty.
  • The value should indicate a valid license name e.g. Apache 2.0.

For More Information​