Class: Openapi3Parser::Node::RequestBody

Inherits:

Object

• Object
• Object
• Openapi3Parser::Node::RequestBody

Defined in:

lib/openapi3_parser/node/request_body.rb

Overview

See Also:

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

Instance Attribute Summary

Attributes inherited from Object

#node_context, #node_data

Instance Method Summary

• #content ⇒ Map<String, MediaType>
• #description ⇒ String^?
• #description_html ⇒ String^?
• #required? ⇒ Boolean

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

#content ⇒ Map<String, MediaType>

Returns:

• (Map<String, MediaType>)

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

def content
  self["content"]
end

#description ⇒ String^?

Returns:

• (String, nil)

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

def description
  self["description"]
end

#description_html ⇒ String^?

Returns:

• (String, nil)

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

def description_html
  render_markdown(description)
end

#required? ⇒ Boolean

Returns:

• (Boolean)

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

def required?
  self["required"]
end