struct Swagger::Objects::SecurityScheme

• Swagger::Objects::SecurityScheme
• Struct
• Value
• Object

Overview

SecurityScheme Object

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

Included Modules

• JSON::Serializable

Defined in:

Constructors

• .new(pull : JSON::PullParser)
• .new(auth : Authorization)
• .new(type : String | Nil = nil, description : String | Nil = nil, name : String | Nil = nil, parameter_location : String | Nil = nil, scheme : String | Nil = nil, bearer_format : String | Nil = nil, flows : Hash(String, OAuth2Flow) | Nil = nil, open_id_connect_url : String | Nil = nil, ref : String | Nil = nil)

Class Method Summary

• .api_key(name : String, location : String, description : String | Nil = nil)
• .basic(description : String | Nil = nil)
• .bearer(description : String | Nil = nil, format : String | Nil = nil)
• .oauth2(flows : Array(Swagger::OAuth2Flow), description : String | Nil = nil)

Instance Method Summary

• #bearer_format : String | Nil
• #description : String | Nil
• #flows : Hash(String, OAuth2Flow) | Nil
• #name : String | Nil
• #open_id_connect_url : String | Nil
• #parameter_location : String | Nil
• #ref : String | Nil
• #scheme : String | Nil
• #type : String | Nil

Constructor Detail

Class Method Detail

Instance Method Detail