struct Swagger::Authorization

• Swagger::Authorization
• Struct
• Value
• Object

Overview

Define a authentication

Avaibled authentication in Type

Defined in:

Constructors

• .new(name : String, description : String | Nil = nil, api_key_name : String | Nil = nil, bearer_format : String | Nil = nil, parameter_location : String | Nil = nil)
• .new(name : Type, description : String | Nil = nil, api_key_name : String | Nil = nil, bearer_format : String | Nil = nil, parameter_location : String | Nil = nil, oauth2_flows : Array(OAuth2Flow) | Nil = nil)

Class Method Summary

• .api_key(*, name : String, location = "header", description : String | Nil = nil)

  Access with api key auth.

• .basic(description : String | Nil = nil)

  Access with basic auth.

• .bearer(*, format : String | Nil = nil, description : String | Nil = nil)

  Access with bearer auth.

• .cookie(*, name : String, description : String | Nil = nil)

  Access with cookie auth.

• .jwt(description : String | Nil = nil)

  Access with jwt auth.

• .none(description : String | Nil = nil)

  Access without any authorization.

• .oauth2(*, grant_type name : String, authorization_url : String | Nil = nil, token_url : String | Nil = nil, refresh_url : String | Nil = nil, scopes : Hash(String, String) | Nil = nil, description : String | Nil = nil)
• .oauth2(*, flows : Array(OAuth2Flow) | Nil = nil, description : String | Nil = nil)

Instance Method Summary

• #api_key_name : String?
• #api_key_name=(api_key_name : Nil | String)
• #bearer_format : String?
• #bearer_format=(bearer_format : Nil | String)
• #description : String?
• #description=(description : Nil | String)
• #key

  Transform name to unique key name

• #name : String

  Transform type to String typed and downcase of value

• #oauth2_flows : Array(Swagger::OAuth2Flow)?
• #oauth2_flows=(oauth2_flows : Nil | Array(Swagger::OAuth2Flow))
• #parameter_location : String?
• #parameter_location=(parameter_location : Nil | String)
• #type : Type

Constructor Detail

Class Method Detail

Instance Method Detail

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"