Class: SwaggerYard::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/swagger_yard/configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Configuration

Returns a new instance of Configuration.



11
12
13
14
15
16
17
18
19
 
# File 'lib/swagger_yard/configuration.rb', line 11

def initialize
  self.swagger_version = "2.0"
  self.api_version = "0.1"
  self.enable = false
  self.reload = true
  self.title = "Configure title with SwaggerYard.config.title"
  self.description = "Configure description with SwaggerYard.config.description"
  self.security_definitions = {}
end

Instance Attribute Details

#api_base_path ⇒ Object

Returns the value of attribute api_base_path.



3
4
5
 
# File 'lib/swagger_yard/configuration.rb', line 3

def api_base_path
  @api_base_path
end

#api_version ⇒ Object

Returns the value of attribute api_version.



3
4
5
 
# File 'lib/swagger_yard/configuration.rb', line 3

def api_version
  @api_version
end

#controller_path ⇒ Object

Returns the value of attribute controller_path.



7
8
9
 
# File 'lib/swagger_yard/configuration.rb', line 7

def controller_path
  @controller_path
end

#description ⇒ Object

Returns the value of attribute description.



5
6
7
 
# File 'lib/swagger_yard/configuration.rb', line 5

def description
  @description
end

#enable ⇒ Object

Returns the value of attribute enable.



6
7
8
 
# File 'lib/swagger_yard/configuration.rb', line 6

def enable
  @enable
end

#model_path ⇒ Object

Returns the value of attribute model_path.



7
8
9
 
# File 'lib/swagger_yard/configuration.rb', line 7

def model_path
  @model_path
end

#path_discovery_function ⇒ Object

Returns the value of attribute path_discovery_function.



8
9
10
 
# File 'lib/swagger_yard/configuration.rb', line 8

def path_discovery_function
  @path_discovery_function
end

#reload ⇒ Object

Returns the value of attribute reload.



6
7
8
 
# File 'lib/swagger_yard/configuration.rb', line 6

def reload
  @reload
end

#security_definitions ⇒ Object

Returns the value of attribute security_definitions.



9
10
11
 
# File 'lib/swagger_yard/configuration.rb', line 9

def security_definitions
  @security_definitions
end

#swagger_version ⇒ Object

Returns the value of attribute swagger_version.



4
5
6
 
# File 'lib/swagger_yard/configuration.rb', line 4

def swagger_version
  @swagger_version
end

#title ⇒ Object

Returns the value of attribute title.



5
6
7
 
# File 'lib/swagger_yard/configuration.rb', line 5

def title
  @title
end

Instance Method Details

#api_path=(ignored) ⇒ Object 



25
26
27
 
# File 'lib/swagger_yard/configuration.rb', line 25

def api_path=(ignored)
  warn "DEPRECATED: api_path is no longer necessary."
end

#swagger_spec_base_path=(ignored) ⇒ Object 



21
22
23
 
# File 'lib/swagger_yard/configuration.rb', line 21

def swagger_spec_base_path=(ignored)
  warn "DEPRECATED: swagger_spec_base_path is no longer necessary."
end