class Openapi3Parser::Node::Operation
@see github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#operationObject
Public Instance Methods
alternative_servers?()
click to toggle source
Whether this object uses it's own defined servers instead of falling back to the path items' ones.
@return [Boolean]
# File lib/openapi3_parser/node/operation.rb, line 78 def alternative_servers? servers != node_context.parent_node.servers end
callbacks()
click to toggle source
@return [Map<String, Callback>]
# File lib/openapi3_parser/node/operation.rb, line 55 def callbacks self["callbacks"] end
deprecated?()
click to toggle source
@return [Boolean]
# File lib/openapi3_parser/node/operation.rb, line 60 def deprecated? self["deprecated"] end
description()
click to toggle source
@return [String, nil]
# File lib/openapi3_parser/node/operation.rb, line 20 def description self["description"] end
description_html()
click to toggle source
@return [String, nil]
# File lib/openapi3_parser/node/operation.rb, line 25 def description_html render_markdown(description) end
external_docs()
click to toggle source
@return [ExternalDocumentation, nil]
# File lib/openapi3_parser/node/operation.rb, line 30 def external_docs self["externalDocs"] end
operation_id()
click to toggle source
@return [String, nil]
# File lib/openapi3_parser/node/operation.rb, line 35 def operation_id self["operationId"] end
parameters()
click to toggle source
@return [Node::Array<Parameter>]
# File lib/openapi3_parser/node/operation.rb, line 40 def parameters self["parameters"] end
request_body()
click to toggle source
@return [RequestBody, nil]
# File lib/openapi3_parser/node/operation.rb, line 45 def request_body self["requestBody"] end
responses()
click to toggle source
@return [Responses]
# File lib/openapi3_parser/node/operation.rb, line 50 def responses self["responses"] end
security()
click to toggle source
@return [Node::Array<SecurityRequirement>]
# File lib/openapi3_parser/node/operation.rb, line 65 def security self["security"] end
servers()
click to toggle source
@return [Node::Array<Server>]
# File lib/openapi3_parser/node/operation.rb, line 70 def servers self["servers"] end
summary()
click to toggle source
@return [String, nil]
# File lib/openapi3_parser/node/operation.rb, line 15 def summary self["summary"] end