Class: Openapi3Parser::Node::PathItem

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi3_parser/node/path_item.rb

Overview

Instance Attribute Summary

Attributes inherited from Object

#node_context, #node_data

Instance Method Summary collapse

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

#alternative_servers?Boolean

Whether this object uses it's own defined servers instead of falling back to the root ones.

Returns:

  • (Boolean)

73
74
75
# File 'lib/openapi3_parser/node/path_item.rb', line 73

def alternative_servers?
  servers != node_context.document.root.servers
end

#deleteOperation?

Returns:


40
41
42
# File 'lib/openapi3_parser/node/path_item.rb', line 40

def delete
  self["delete"]
end

#descriptionString?

Returns:

  • (String, nil)

15
16
17
# File 'lib/openapi3_parser/node/path_item.rb', line 15

def description
  self["description"]
end

#description_htmlString?

Returns:

  • (String, nil)

20
21
22
# File 'lib/openapi3_parser/node/path_item.rb', line 20

def description_html
  render_markdown(description)
end

#getOperation?

Returns:


25
26
27
# File 'lib/openapi3_parser/node/path_item.rb', line 25

def get
  self["get"]
end

#headOperation?

Returns:


50
51
52
# File 'lib/openapi3_parser/node/path_item.rb', line 50

def head
  self["head"]
end

#optionsOperation?

Returns:


45
46
47
# File 'lib/openapi3_parser/node/path_item.rb', line 45

def options
  self["options"]
end

#parametersNode::Array<Parameter>

Returns:


78
79
80
# File 'lib/openapi3_parser/node/path_item.rb', line 78

def parameters
  self["parameters"]
end

#patchOperation?

Returns:


55
56
57
# File 'lib/openapi3_parser/node/path_item.rb', line 55

def patch
  self["patch"]
end

#postOperation?

Returns:


35
36
37
# File 'lib/openapi3_parser/node/path_item.rb', line 35

def post
  self["post"]
end

#putOperation?

Returns:


30
31
32
# File 'lib/openapi3_parser/node/path_item.rb', line 30

def put
  self["put"]
end

#serversNode::Array<Server>

Returns:


65
66
67
# File 'lib/openapi3_parser/node/path_item.rb', line 65

def servers
  self["servers"]
end

#summaryString?

Returns:

  • (String, nil)

10
11
12
# File 'lib/openapi3_parser/node/path_item.rb', line 10

def summary
  self["summary"]
end

#traceOperation?

Returns:


60
61
62
# File 'lib/openapi3_parser/node/path_item.rb', line 60

def trace
  self["trace"]
end