class

Open::Api::OperationItem

Inherits YAML::Serializable < JSON::Serializable < Reference < Object

Constructors

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
Source
new(pull : JSON::PullParser)
Source
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)
Source
new(summary : Nil | String)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source
new(*, __context_for_yaml_serializable ctx : YAML::ParseContext, __node_for_yaml_serializable node : YAML::Nodes::Node)
Source

Instance methods

description

A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.

Source
description=(description : String | Nil)

A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.

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

REQUIRED. The list of possible responses as they are returned from executing this operation.

Source
responses=(responses : Responses)

REQUIRED. The list of possible responses as they are returned from executing this operation.

Source
security

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

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

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

Source
summary

A short summary of what the operation does.

Source
summary=(summary : String | Nil)

A short summary of what the operation does.

Source
tags

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Source
tags=(tags : Array(String))

A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Source

Nested types