Class: Morpheus::DocInterface

Inherits:
APIClient show all
Defined in:
lib/morpheus/api/doc_interface.rb

Constant Summary

Constants inherited from APIClient

APIClient::CLIENT_ID

Instance Attribute Summary

Attributes inherited from APIClient

#client_id

Instance Method Summary collapse

Methods inherited from APIClient

#account_groups, #accounts, #activity, #appliance_settings, #approvals, #apps, #archive_buckets, #archive_files, #auth, #backup_jobs, #backup_settings, #backups, #billing, #blueprints, #budgets, #catalog, #catalog_item_types, #cloud_datastores, #cloud_folders, #cloud_policies, #cloud_resource_pools, #clouds, #clusters, #common_interface_options, #containers, #custom_instance_types, #cypher, #dashboard, #datastores, #default_content_type, #default_timeout, #deploy, #deployments, #doc, #dry, #dry_run, #environments, #execute, #execute_schedules, #execution_request, #file_copy_request, #forgot, #group_policies, #groups, #guidance, #health, #image_builder, #initialize, #inspect, #instance_types, #instances, #integrations, #invoice_line_items, #invoices, #jobs, #key_pairs, #library_cluster_layouts, #library_container_scripts, #library_container_templates, #library_container_types, #library_container_upgrades, #library_instance_types, #library_layouts, #library_spec_template_types, #library_spec_templates, #license, #load_balancers, #log_settings, #logged_in?, #login, #logout, #logs, #monitoring, #network_domain_records, #network_domains, #network_groups, #network_pool_ips, #network_pool_servers, #network_pools, #network_proxies, #network_routers, #network_security_servers, #network_services, #network_types, #networks, #old_cypher, #option_type_lists, #option_types, #options, #packages, #ping, #policies, #power_schedules, #price_sets, #prices, #processes, #projects, #provision_types, #provisioning_license_types, #provisioning_licenses, #provisioning_settings, #reports, #roles, #search, #security_group_rules, #security_groups, #server_types, #servers, #service_plans, #set_ssl_verification_enabled, #setopts, #setup, #ssl_verification_enabled?, #storage_providers, #subnet_types, #subnets, #task_sets, #tasks, #to_s, #url, #usage, #use_refresh_token, #user_groups, #user_settings, #user_sources, #users, #virtual_images, #whitelabel_settings, #whoami, #wiki, #withopts

Constructor Details

This class inherits a constructor from Morpheus::APIClient

Instance Method Details

#authorization_required? ⇒ Boolean

no Authorization header is required

Returns:

  • (Boolean) 


6
7
8
 
# File 'lib/morpheus/api/doc_interface.rb', line 6

def authorization_required?
  false
end

#download_swagger(outfile, params = {}) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/morpheus/api/doc_interface.rb', line 28

def download_swagger(outfile, params={})
  # note that RestClient.execute still requires the full path with base_url
  url = "#{@base_url}/api/doc/swagger"
  # prefer /swagger.yml instead of /swagger?format=yml
  fmt = params.delete('format')
  if fmt
    url = url + "." + fmt
  end
  headers = {params: params}
  opts = {method: :get, url: url, headers: headers, timeout: 172800, parse_json: false}

  if @dry_run
    return opts
  end

  http_response = nil
  File.open(File.expand_path(outfile), 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  http_response
end

#list(params = {}) ⇒ Object 



10
11
12
13
14
 
# File 'lib/morpheus/api/doc_interface.rb', line 10

def list(params={})
  url = "/api/doc"
  headers = {params: params}
  execute(method: :get, url: url, headers: headers)
end

#swagger(params = {}) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/morpheus/api/doc_interface.rb', line 16

def swagger(params={})
  url = "/api/doc/swagger"
  # prefer /swagger.yml instead of /swagger?format=yml
  fmt = params.delete('format')
  if fmt
    url = url + "." + fmt
  end
  is_yaml = fmt == "yml" || fmt == "yaml"
  headers = {params: params}
  execute(method: :get, url: url, headers: headers, timeout: 172800, parse_json: !is_yaml)
end