module OpenApi::ConfigDSL

Public Instance Methods

api_key(scheme_name, field:, in: 'header', **other_info) click to toggle source
# File lib/open_api/config_dsl.rb, line 36
def api_key scheme_name, field:, in: 'header', **other_info
  _in = binding.local_variable_get(:in)
  security_scheme scheme_name, { type: 'apiKey', name: field, in: _in, **other_info }
end
auth_scheme(scheme_name, other_info)
Alias for: security_scheme
base_auth(scheme_name, other_info = { }) click to toggle source
# File lib/open_api/config_dsl.rb, line 28
def base_auth scheme_name, other_info = { }
  security_scheme scheme_name, { type: 'http', scheme: 'basic', **other_info }
end
bearer_auth(scheme_name, format = 'JWT', other_info = { }) click to toggle source
# File lib/open_api/config_dsl.rb, line 32
def bearer_auth scheme_name, format = 'JWT', other_info = { }
  security_scheme scheme_name, { type: 'http', scheme: 'bearer', bearerFormat: format, **other_info }
end
global_auth(scheme_name, scopes: [ ])
global_security(scheme_name, scopes: [ ])
global_security_require(scheme_name, scopes: [ ]) click to toggle source
# File lib/open_api/config_dsl.rb, line 41
def global_security_require scheme_name, scopes: [ ]
  (open_api_docs[@api][:global_security] ||= [ ]) << { scheme_name => scopes }
end
Also aliased as: global_security, global_auth
info(version:, title:, desc: '', **addition) click to toggle source
# File lib/open_api/config_dsl.rb, line 15
def info version:, title:, desc: '', **addition
  open_api_docs[@api][:info] = { version: version, title: title, description: desc, **addition }
end
open_api(name, base_doc_classes: @api = name) click to toggle source
# File lib/open_api/config_dsl.rb, line 10
def open_api name, base_doc_classes:
  @api = name
  open_api_docs[name] = { base_doc_classes: base_doc_classes }
end
security_scheme(scheme_name, other_info) click to toggle source
# File lib/open_api/config_dsl.rb, line 23
def security_scheme scheme_name, other_info# = { }
  other_info[:description] = other_info.delete(:desc) if other_info.key?(:desc)
  (open_api_docs[@api][:securitySchemes] ||= { })[scheme_name] = other_info
end
Also aliased as: auth_scheme
server(url, desc: '') click to toggle source
# File lib/open_api/config_dsl.rb, line 19
def server url, desc: ''
  (open_api_docs[@api][:servers] ||= [ ]) << { url: url, description: desc }
end