class Open::Api::OperationItem

• Open::Api::OperationItem
• Reference
• Object

Included Modules

• JSON::Serializable
• YAML::Serializable

Defined in:

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(pull : JSON::PullParser)
• .new(summary : String | Nil = nil, operation_id : String | Nil = nil, description : String | Nil = nil, tags : Array(String) = Array(String).new, parameters : Array(Parameter | Ref) = Array(Parameter | Ref).new, request_body : Open::Api::RequestBody | Open::Api::Ref | Nil = nil, responses : Responses = Responses.new, security : Array(Open::Api::Security::Requirement) | Nil = nil)
• .new(summary : Nil | String)

Instance Method Summary

• #description : String | Nil

  A verbose explanation of the operation behavior.

• #description=(description : String | Nil)

  A verbose explanation of the operation behavior.

• #operation_id : String | Nil
• #operation_id=(operation_id : String | Nil)
• #parameters : Array(Parameter | Ref)
• #parameters=(parameters : Array(Parameter | Ref))
• #request_body : Open::Api::RequestBody | Open::Api::Ref | Nil
• #request_body=(request_body : Open::Api::RequestBody | Open::Api::Ref | Nil)
• #responses : Responses

  REQUIRED.

• #responses=(responses : Responses)

  REQUIRED.

• #security : Array(Open::Api::Security::Requirement) | Nil

  A declaration of which security mechanisms can be used for this operation

• #security=(security : Array(Open::Api::Security::Requirement) | Nil)

  A declaration of which security mechanisms can be used for this operation

• #summary : String | Nil

  A short summary of what the operation does.

• #summary=(summary : String | Nil)

  A short summary of what the operation does.

• #tags : Array(String)

  A list of tags for API documentation control.

• #tags=(tags : Array(String))

  A list of tags for API documentation control.

Constructor Detail

Instance Method Detail