Class: Openapi3Parser::Nodes::Example

Inherits:

Object

• Object
• Openapi3Parser::Nodes::Example

Includes:

Openapi3Parser::Node::Object

Defined in:

lib/openapi3_parser/nodes/example.rb

Overview

See Also:

• https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#exampleObject

Instance Attribute Summary

Attributes included from Openapi3Parser::Node::Object

#node_context, #node_data

Instance Method Summary

• #description ⇒ String^?
• #external_value ⇒ String^?
• #summary ⇒ String^?
• #value ⇒ Object

Methods included from Openapi3Parser::Node::Object

#[], #each, #extension, #initialize

Instance Method Details

#description ⇒ String^?

Returns:

• (String, nil)

# File 'lib/openapi3_parser/nodes/example.rb', line 17

def description
  node_data["description"]
end

#external_value ⇒ String^?

Returns:

• (String, nil)

# File 'lib/openapi3_parser/nodes/example.rb', line 27

def external_value
  node_data["externalValue"]
end

#summary ⇒ String^?

Returns:

• (String, nil)

# File 'lib/openapi3_parser/nodes/example.rb', line 12

def summary
  node_data["summary"]
end

#value ⇒ Object

Returns:

• (Object)

# File 'lib/openapi3_parser/nodes/example.rb', line 22

def value
  node_data["value"]
end