struct Swagger::Objects::Parameter

Overview

Parameter Object

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

Included Modules

Defined in:

swagger/objects/parameter.cr

Constant Summary

LOCATIOINS = ["path", "query", "header", "cookie"] of ::String

Constructors

Instance Method Summary

Constructor Detail

def self.new(name : String, parameter_location : String, schema : Schema, description : String | Nil = nil, required : Bool = false, allow_empty_value : Bool = false, deprecated : Bool = false, ref : String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def allow_empty_value : Bool #

[View source]
def deprecated : Bool #

[View source]
def description : String | Nil #

[View source]
def name : String #

[View source]
def parameter_location : String #

[View source]
def ref : String | Nil #

[View source]
def required : Bool #

[View source]
def schema : Schema #

[View source]