Class: Raml::ResourceType::Instance

Inherits:

AbstractResource

• Object
• Node
• PropertiesNode
• AbstractResource
• Raml::ResourceType::Instance

Defined in:

lib/raml/node/resource_type.rb

Instance Attribute Summary

• #usage ⇒ String^?

  How the resource type should be used.

Attributes inherited from AbstractResource

#base_uri_parameters, #methods, #traits, #type, #uri_parameters

Attributes included from Parent

#children

Attributes included from Documentable

#description, #display_name

Attributes inherited from PropertiesNode

#optional

Attributes inherited from Node

#name, #parent

Method Summary

Methods inherited from AbstractResource

#apply_resource_type, #merge, #resource_path, #resource_path_name

Methods included from SecuredBy

#_validate_secured_by, #parse_secured_by

Methods included from Validation

#classes_to_s, #validate_array, #validate_hash, #validate_property, #validate_string

Methods included from Merge

#merge, #merge_properties

Methods included from Global

#default_media_type, #resource_type_declarations, #schema_declarations, #security_scheme_declarations, #trait_declarations

Methods inherited from PropertiesNode

#_regexp_property, #initialize, #non_scalar_properties, #scalar_properties

Methods inherited from Node

#initialize

Constructor Details

This class inherits a constructor from Raml::PropertiesNode

Instance Attribute Details

#usage ⇒ String^?

Returns how the resource type should be used.

Returns:

• (String, nil) —

  how the resource type should be used.

# File 'lib/raml/node/resource_type.rb', line 8

scalar_property :usage