struct Swagger::Objects::Operation

• Swagger::Objects::Operation
• Struct
• Value
• Object

Overview

Operation Object

See https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#operationObject

Included Modules

• JSON::Serializable

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new(responses : Hash(String, Response), summary : String? = nil, description : String? = nil, tags : Array(String)? = nil, parameters : Array(Parameter)? = nil, request_body : RequestBody? = nil, deprecated : Bool = false, security : Array(Hash(String, Array(String)))? = nil)

Class Method Summary

• .from(action : Action, controller_name : String? = nil, security : Hash(String, Array(String))? = nil)

Instance Method Summary

• #deprecated : Bool
• #description : String?
• #external_docs : Example?
• #operation_id : String?
• #parameters : Array(Parameter)?
• #request_body : RequestBody?
• #responses : Hash(String, Response)

  List of possible responses as they are returned from executing this operation.

• #security : Array(Hash(String, Array(String)))?
• #servers : Array(Server)?

  TODO Add instance vars to initialize

• #summary : String?
• #tags : Array(String)?

Constructor Detail

Class Method Detail

Instance Method Detail