Module: OpenApi

Defined in:
lib/open-api/generator.rb,
lib/open-api.rb,
lib/open-api/tags.rb,
lib/open-api/utils.rb,
lib/open-api/objects.rb,
lib/open-api/endpoints.rb,
lib/open-api/controller.rb

Overview

rubocop:disable Rails/Output

Defined Under Namespace

Modules: Controller, Objects Classes: Endpoints, Generator, Tags, Utils

Class Method Summary collapse

Class Method Details

.configure(metadata = nil, &block) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/open-api.rb', line 10

def configure(metadata = nil, &block)
  return unless metadata.is_a?(Hash) || block_given?
  global_metadata = @open_api_global_metadata || default_global_metadata
  if metadata.is_a?(Hash)
    global_metadata = OpenApi::Utils.merge_hash(global_metadata, metadata)
  end
  if block_given?
    config = OpenStruct.new(global_metadata)
    block.call(config)
    global_metadata = OpenApi::Utils.merge_hash(global_metadata, config.to_h.symbolize_keys)
  end
  @open_api_global_metadata = global_metadata
end

.default_global_metadata ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/open-api.rb', line 28

def default_global_metadata
  {
      swagger: 2.0,
      schemes: [:http]
  }
end

.global_metadata ⇒ Object 



24
25
26
 
# File 'lib/open-api.rb', line 24

def global_metadata
  @open_api_global_metadata || default_global_metadata
end