Class: Jsapi::Meta::SecurityScheme::HTTP::Bearer

Inherits:
Base show all
Includes:
OpenAPI::Extensions
Defined in:
lib/jsapi/meta/security_scheme/http/bearer.rb

Overview

Specifies a security scheme based on bearer authentication.

Note that Bearer authentication was introduced with OpenAPI 3.0. Thus, a security scheme of this class is skipped when generating an OpenAPI 2.0 document.

Constant Summary

Constants included from Base::Attributes

Base::Attributes::DEFAULT_ARRAY, Base::Attributes::DEFAULT_HASH

Instance Method Summary collapse

Methods included from OpenAPI::Extensions

#add_openapi_extension, #openapi_extensions, #openapi_extensions=

Methods inherited from Base

#description

Methods inherited from Base::Model

#initialize, #inspect, #merge!, #reference?, #resolve

Methods included from Base::Attributes

#attribute, #attribute_names

Constructor Details

This class inherits a constructor from Jsapi::Meta::Base::Model

Instance Method Details

#bearer_format ⇒ Object

:attr: bearer_format The format of the bearer token.



17
 
# File 'lib/jsapi/meta/security_scheme/http/bearer.rb', line 17

attribute :bearer_format, String

#to_openapi(version) ⇒ Object

Returns a hash representing the OpenAPI security scheme object, or nil if version.major is 2.



21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/jsapi/meta/security_scheme/http/bearer.rb', line 21

def to_openapi(version, *)
  version = OpenAPI::Version.from(version)
  return if version.major == 2

  with_openapi_extensions(
    type: 'http',
    scheme: 'bearer',
    bearerFormat: bearer_format,
    description: description
  )
end