Class: R2OAS::AppConfiguration::Swagger::Editor

Inherits:

Object

• Object
• R2OAS::AppConfiguration::Swagger::Editor

Defined in:

lib/r2-oas/app_configuration/swagger/editor.rb

Constant Summary

DEFAULT_IMAGE =

'swaggerapi/swagger-editor'

DEFAULT_PORT =

'81'

DEFAULT_EXPOSED_PORT =

'8080/tcp'

DEFAULT_STORAGE_KEY =

Fixed

'swagger-editor-content'

DEFAULT_HOST =

Fixed

'http://localhost'

VALID_OPTIONS_KEYS =

%i[
  image
  port
  exposed_port
].freeze

Instance Method Summary

• #configure {|_self| ... } ⇒ Object
• #initialize ⇒ Editor constructor

  A new instance of Editor.

• #storage_key ⇒ Object
• #url ⇒ Object

Constructor Details

#initialize ⇒ Editor

Returns a new instance of Editor.

# File 'lib/r2-oas/app_configuration/swagger/editor.rb', line 21

def initialize
  set_default
end

Instance Method Details

#configure {|_self| ... } ⇒ Object

Yields:

• (_self)

Yield Parameters:

• _self (R2OAS::AppConfiguration::Swagger::Editor) —

  the object that the method was called on

# File 'lib/r2-oas/app_configuration/swagger/editor.rb', line 25

def configure
  yield self
end

#storage_key ⇒ Object

# File 'lib/r2-oas/app_configuration/swagger/editor.rb', line 33

def storage_key
  DEFAULT_STORAGE_KEY
end

#url ⇒ Object

# File 'lib/r2-oas/app_configuration/swagger/editor.rb', line 29

def url
  "#{DEFAULT_HOST}:#{port}"
end