Class: Openapi3Parser::Node::Example

Inherits:

Object

• Object
• Object
• Openapi3Parser::Node::Example

Defined in:

lib/openapi3_parser/node/example.rb

Overview

See Also:

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

Instance Attribute Summary

Attributes inherited from Object

#node_context, #node_data

Instance Method Summary

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

Methods inherited from Object

#==, #[], #each, #extension, #initialize, #inspect, #node_at, #render_markdown, #values

Constructor Details

This class inherits a constructor from Openapi3Parser::Node::Object

Instance Method Details

#description ⇒ String^?

# File 'lib/openapi3_parser/node/example.rb', line 15

def description
  self["description"]
end

#description_html ⇒ String^?

# File 'lib/openapi3_parser/node/example.rb', line 20

def description_html
  render_markdown(description)
end

#external_value ⇒ String^?

# File 'lib/openapi3_parser/node/example.rb', line 30

def external_value
  self["externalValue"]
end

#summary ⇒ String^?

# File 'lib/openapi3_parser/node/example.rb', line 10

def summary
  self["summary"]
end

#value ⇒ Object

# File 'lib/openapi3_parser/node/example.rb', line 25

def value
  self["value"]
end