Skip to main content

required-resource-path

Overview

This rule belongs to the swagger-v1-validation ruleset and states that:

The Resource Object must specify a non-empty path to the API declaration document using the path property. This path must be relative from the path used to retrieve the Resource Listing document.

PropertyValue
EnabledYes
Maximum SeverityError
MessageRequired property path in Resource Object is empty or missing.
CodeSWAGGER1_V100
TypeValidation
Rule SystemSemantic
Broad CategoryResources
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsswagger1 swagger semantic validation path resource

Suggested Fixes

  • Add missing path property in the Resource Object.
  • Make sure that the path property value is not null or empty.
  • Ensure that the path property value is a relative path which when combined with the Resource Listing's base path points to a publicly accessible API declaration document.

For More Information