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 = nil, description : String | Nil = nil, tags : Array(String) | Nil = nil, parameters : Array(Parameter) | Nil = nil, request_body : RequestBody | Nil = nil, deprecated : Bool = false, security : Array(Hash(String, Array(String))) | Nil = nil)

Class Method Summary

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

Instance Method Summary

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

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

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

  TODO Add instance vars to initialize

• #summary : String | Nil
• #tags : Array(String) | Nil

Constructor Detail

Class Method Detail

Instance Method Detail