struct Swagger::Action

• Swagger::Action
• Struct
• Value
• Object

Overview

Define a action

Swagger::Action.new("get", "/users", "List Users", [
  Swagger::Parameter.new("page", "query", "integer", "Current page", default_value: 1, format: "int32"),
  Swagger::Parameter.new("limit", "query", "integer", "How many items to return at one time (max 100)", default_value: 50, format: "int32"),
])

Defined in:

swagger/action.cr

Constructors

• .new(method : String, route : String, summary : String | Nil = nil, parameters : Array(Parameter) | Nil = nil, description : String | Nil = nil, request : Request | Nil = nil, responses : Array(Response) | Nil = nil, authorization : Bool = false, deprecated : Bool = false)

Instance Method Summary

• #authorization : Bool
• #authorization=(authorization : Bool)
• #deprecated : Bool
• #deprecated=(deprecated : Bool)
• #description : String?
• #description=(description : Nil | String)
• #method : String
• #method=(method : String)
• #parameters : Array(Swagger::Parameter)?
• #parameters=(parameters : Nil | Array(Swagger::Parameter))
• #request : Swagger::Request?
• #request=(request : Swagger::Request | Nil)
• #responses : Array(Swagger::Response)?
• #responses=(responses : Nil | Array(Swagger::Response))
• #route : String
• #route=(route : String)
• #summary : String?
• #summary=(summary : Nil | String)

Constructor Detail

Instance Method Detail