Class: Raml::AbstractMethod

Inherits:

PropertiesNode

• Object
• Node
• PropertiesNode
• Raml::AbstractMethod

Includes:

Bodies, Documentable, Global, Headers, Merge, Parent, SecuredBy, Validation

Defined in:

lib/raml/node/abstract_method.rb

Direct Known Subclasses

Method, Trait::Instance

Instance Attribute Summary

• #protocols ⇒ Array<String>^?

  The supported protocols.

• #query_parameters ⇒ Hash<String, Raml::Parameter::QueryParameter> readonly

  The method query parameters, keyed by the parameter name.

• #responses ⇒ Hash<Integer, Raml::Response> readonly

  The method responses, keyed by the HTTP status code.

Attributes included from Headers

#headers

Attributes included from Bodies

#bodies

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 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

#protocols ⇒ Array<String>^?

Returns the supported protocols. Nil or an array of up to two string elements from the set “HTTP” and “HTTPS”.

Returns:

• (Array<String>, nil) —

  the supported protocols. Nil or an array of up to two string elements from the set “HTTP” and “HTTPS”.

# File 'lib/raml/node/abstract_method.rb', line 14

#query_parameters ⇒ Hash<String, Raml::Parameter::QueryParameter> (readonly)

Returns the method query parameters, keyed by the parameter name.

Returns:

• (Hash<String, Raml::Parameter::QueryParameter>) —

  the method query parameters, keyed by the parameter name.

# File 'lib/raml/node/abstract_method.rb', line 18

#responses ⇒ Hash<Integer, Raml::Response> (readonly)

Returns the method responses, keyed by the HTTP status code.

Returns:

• (Hash<Integer, Raml::Response>) —

  the method responses, keyed by the HTTP status code.

# File 'lib/raml/node/abstract_method.rb', line 25

scalar_property     :protocols