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.

Property	Value
Enabled	Yes
Severity	Error
Message	Required property url in the External Documentation Object is missing.
Code	OPENAPI3STANDARDS_V070
Type	Validation
Rule System	Semantic
Broad Category	External Documentation
Products Impacted	API Transformer, Developer Experience Portal
Tags	openapi3 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

• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#openapi-specification
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#external-documentation-object
• https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#external-documentation-object
• https://docs.apimatic.io/rulesets/overview/