Skip to main content

required-server-url

Overview​

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

The Server Object must specify a URL for the target API host using the url property.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property url in Server Object is missing.
CodeOPENAPI3STANDARDS_V025
TypeValidation
Rule SystemSemantic
Broad CategoryServers
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsopenapi3 openapi standards semantic validation url server

Suggested Fixes​

  • Add missing url property in the Server Object.
  • Make sure that the url property value is not null or empty.
  • The value should indicate the URL of a target API host or server e.g. https://i-am-a-server.com/v1

For More Information​