Skip to main content

valid-resource-type-name

Overview​

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

A resource may specify the resource type from which it is derived using the optional type property. The value must be the name of a resource type defined within the root-level resourceTypes object or in a library.

PropertyValue
EnabledYes
Maximum SeverityError
MessageResource type with provided name could not be found.
CodeRAML_V500
TypeValidation
Rule SystemSemantic
Broad CategoryResource Types and Traits
Products ImpactedAPI Transformer, Code Generation, Developer Experience Portal
Tagsraml semantic validation name resource type resource

Suggested Fixes​

  • Ensure that the resource name matches name of the pre-defined resource type exactly and has no typos. Names are compared in a case-sensitive manner.
  • Ensure that a resource type with that name is defined in the root object level resourceTypes property in the same RAML file or an external library.
  • If you are trying to reference a library's resource type, ensure that the library is accessible and the library key used in the reference matches with the library declaration. Also ensure that the resource type does indeed exist in the same library.

For More Information​