class Dox::Config

Attributes

api_version[RW]
descriptions_location[R]
groups_order[RW]
header_description[RW]
headers_whitelist[RW]
openapi_version[RW]
schema_request_folder_path[R]
schema_response_fail_file_path[R]
schema_response_folder_path[R]
title[RW]

Public Instance Methods

desc_folder_path=(folder_path) click to toggle source
# File lib/dox/config.rb, line 38
def desc_folder_path=(folder_path)
  warn(
    'DEPRECATION WARNING: desc_folder_path will be removed in the next release, please use descriptions_location instead' # rubocop:disable Layout/LineLength
  )

  self.descriptions_location = folder_path
end
descriptions_location=(folder_path) click to toggle source
# File lib/dox/config.rb, line 14
def descriptions_location=(folder_path)
  raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)

  @descriptions_location = folder_path
end
header_file_path=(_file_path) click to toggle source
# File lib/dox/config.rb, line 46
def header_file_path=(_file_path)
  warn('WARNING: header_file_path is no longer used. Move header description to config.header_description.')
end
schema_request_folder_path=(folder_path) click to toggle source
# File lib/dox/config.rb, line 20
def schema_request_folder_path=(folder_path)
  raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)

  @schema_request_folder_path = folder_path
end
schema_response_fail_file_path=(file_path) click to toggle source
# File lib/dox/config.rb, line 32
def schema_response_fail_file_path=(file_path)
  raise(Errors::FileNotFoundError, file_path) unless File.exist?(file_path)

  @schema_response_fail_file_path = file_path
end
schema_response_folder_path=(folder_path) click to toggle source
# File lib/dox/config.rb, line 26
def schema_response_folder_path=(folder_path)
  raise(Errors::FolderNotFoundError, folder_path) unless Dir.exist?(folder_path)

  @schema_response_folder_path = folder_path
end