class

Open::Api::Parameter

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

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

Constructors

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)
Source
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
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

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