Skip to main content

required-external-documentation-url

Overview​

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

The External Documentation Object must specify the URL for the target documentation using the url property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property url in the External Documentation Object is missing.
CodeOPENAPI3STANDARDS_V070
TypeValidation
Rule SystemSemantic
Broad CategoryExternal Documentation
Products ImpactedAPI Transformer, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation url external documentation docs

Suggested Fixes​

  • Add missing url property in the External Documentation Object.
  • Make sure that the url property is not null or empty.

For More Information​