class Open::Api::Parameter

• Open::Api::Parameter
• Reference
• Object

Overview

https://swagger.io/specification/#parameter-object

Included Modules

• JSON::Serializable
• YAML::Serializable

Defined in:

open-api/parameter.cr

Constructors

• .new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
• .new(name : String, parameter_in : String, schema : SchemaRef | Nil = nil, required : Bool = false, deprecated : Bool = false, example : Open::Api::ExampleValue = nil, examples : Hash(String, Open::Api::ExampleValue) = Hash(String, Open::Api::ExampleValue).new, description : String | Nil = nil, style : String | Nil = nil, allow_reserved : Bool = false)
• .new(name, type, location = "query", description : String = "", required : Bool = false, default_value : String | Int32 | Int64 | Float64 | Bool | Nil = nil, example : Open::Api::ExampleValue = nil) : Open::Api::Parameter
• .new(pull : JSON::PullParser)

Instance Method Summary

• #allow_reserved : Bool
• #allow_reserved=(allow_reserved : Bool)
• #deprecated : Bool
• #deprecated=(deprecated : Bool)
• #description : String | Nil
• #description=(description : String | Nil)
• #example : Open::Api::ExampleValue
• #example=(example : Open::Api::ExampleValue)
• #examples : Hash(String, Open::Api::ExampleValue)
• #examples=(examples : Hash(String, Open::Api::ExampleValue))
• #name : String
• #name=(name : String)
• #parameter_in : String
• #parameter_in=(parameter_in : String)
• #required : Bool
• #required=(required : Bool)
• #schema : Open::Api::SchemaRef | Nil
• #schema=(schema : Open::Api::SchemaRef | Nil)
• #style : String | Nil
• #style=(style : String | Nil)

Constructor Detail

Instance Method Detail