struct Swagger::Authorization

Overview

Define a authentication

Avaibled authentication in Type

Defined in:

swagger/authorization.cr

Constructors

Class Method Summary

Instance Method Summary

Constructor Detail

def self.new(name : String, description : String? = nil, api_key_name : String? = nil, bearer_format : String? = nil, parameter_location : String? = nil) #

[View source]
def self.new(name : Type, description : String? = nil, api_key_name : String? = nil, bearer_format : String? = nil, parameter_location : String? = nil, oauth2_flows : Array(OAuth2Flow)? = nil) #

[View source]

Class Method Detail

def self.api_key(*, name : String, location = "header", description : String? = nil) #

Access with api key auth.


[View source]
def self.basic(description : String? = nil) #

Access with basic auth.


[View source]
def self.bearer(*, format : String? = nil, description : String? = nil) #

Access with bearer auth.


[View source]
def self.cookie(*, name : String, description : String? = nil) #

Access with cookie auth.


[View source]
def self.jwt(description : String? = nil) #

Access with jwt auth.


[View source]
def self.none(description : String? = nil) #

Access without any authorization.


[View source]
def self.oauth2(*, grant_type name : String, authorization_url : String? = nil, token_url : String? = nil, refresh_url : String? = nil, scopes : Hash(String, String)? = nil, description : String? = nil) #

[View source]
def self.oauth2(*, flows : Array(OAuth2Flow)? = nil, description : String? = nil) #

[View source]

Instance Method Detail

def api_key_name : String? #

[View source]
def api_key_name=(api_key_name) #

[View source]
def bearer_format : String? #

[View source]
def bearer_format=(bearer_format) #

[View source]
def description : String? #

[View source]
def description=(description) #

[View source]
def key #

Transform name to unique key name

Swagger::Authorization.basic.key                        # => "basic_auth"
Swagger::Authorization.bearer.key                       # => "bearer_auth"
Swagger::Authorization.bearer(format: "custom").key     # => "custom_auth"
Swagger::Authorization.jwt.key.˙                        # => "jwt_auth"
Swagger::Authorization.api_key.key.˙                    # => "api_key_auth"
Swagger::Authorization.cookie(name: "JSESSIONID").key.˙ # => "cookie_auth"

[View source]
def name : String #

Transform type to String typed and downcase of value


[View source]
def oauth2_flows : Array(Swagger::OAuth2Flow)? #

[View source]
def oauth2_flows=(oauth2_flows) #

[View source]
def parameter_location : String? #

[View source]
def parameter_location=(parameter_location) #

[View source]
def type : Type #

[View source]