struct Open::Api::Security::Scheme::ApiKeyAuth

Included Modules

Defined in:

open-api/security.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from struct Open::Api::Security::Scheme

auth_type : String auth_type, description : String | Nil description, description=(description : String | Nil) description=

Constructor methods inherited from struct Open::Api::Security::Scheme

new(ctx : YAML::ParseContext, node : YAML::Nodes::Node)
new(pull : JSON::PullParser) new

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

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

[View source]
def self.new(name : String, api_key_in : String = "header", description : String | Nil = nil) #

[View source]

Class Method Detail

def self.jwt_bearer #

[View source]

Instance Method Detail

def api_key_in : String #

REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".


[View source]
def api_key_in=(api_key_in : String) #

REQUIRED. The location of the API key. Valid values are "query", "header" or "cookie".


[View source]
def name : String #

REQUIRED. The name of the header, query or cookie parameter to be used.


[View source]
def name=(name : String) #

REQUIRED. The name of the header, query or cookie parameter to be used.


[View source]