Class: Raml::SecurityScheme::Instance

Inherits:
PropertiesNode show all
Includes:
Validation
Defined in:
lib/raml/node/security_scheme.rb

Instance Attribute Summary collapse

Attributes inherited from PropertiesNode

#optional

Attributes inherited from Node

#name, #parent

Method Summary

Methods included from Validation

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

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

#described_by ⇒ Hash<String, Raml::Trait> (readonly)

Returns the trait-like description of the security scheme.

Returns:

  • (Hash<String, Raml::Trait>) —

    the trait-like description of the security scheme.




# File 'lib/raml/node/security_scheme.rb', line 16

#description ⇒ String?

Returns how the description of the security scheme.

Returns:

  • (String, nil) —

    how the description of the security scheme.



10
 
# File 'lib/raml/node/security_scheme.rb', line 10

scalar_property :description

#settings ⇒ Hash<String, Any] the settings for the security scheme (readonly)

Returns Hash<String, Any] the settings for the security scheme.

Returns:

  • (Hash<String, Any] the settings for the security scheme) —

    Hash<String, Any] the settings for the security scheme



23
 
# File 'lib/raml/node/security_scheme.rb', line 23

non_scalar_property :described_by, :settings

#type ⇒ String?

Returns describes the type of the security scheme.

Returns:

  • (String, nil) —

    describes the type of the security scheme.



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

scalar_property :type