Class: Fastly::DiffApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/diff_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DiffApi

Returns a new instance of DiffApi.



17
18
19
 
# File 'lib/fastly/api/diff_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/diff_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#diff_service_versions(opts = {}) ⇒ DiffResponse

Diff two service versions Get diff between two versions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :from_version_id (Integer) —

    The version number of the service to which changes in the generated VCL are being compared. Can either be a positive number from 1 to your maximum version or a negative number from -1 down (-1 is latest version etc). (required)

  • :to_version_id (Integer) —

    The version number of the service from which changes in the generated VCL are being compared. Uses same numbering scheme as `from`. (required)

  • :format (String) —

    Optional method to format the diff field. (default to ‘text’)

Returns:



27
28
29
30
 
# File 'lib/fastly/api/diff_api.rb', line 27

def diff_service_versions(opts = {})
  data, _status_code, _headers = diff_service_versions_with_http_info(opts)
  data
end

#diff_service_versions_with_http_info(opts = {}) ⇒ Array<(DiffResponse, Integer, Hash)>

Diff two service versions Get diff between two versions.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :from_version_id (Integer) —

    The version number of the service to which changes in the generated VCL are being compared. Can either be a positive number from 1 to your maximum version or a negative number from -1 down (-1 is latest version etc). (required)

  • :to_version_id (Integer) —

    The version number of the service from which changes in the generated VCL are being compared. Uses same numbering scheme as &#x60;from&#x60;. (required)

  • :format (String) —

    Optional method to format the diff field. (default to ‘text’)

Returns:

  • (Array<(DiffResponse, Integer, Hash)>) —

    DiffResponse data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/fastly/api/diff_api.rb', line 39

def diff_service_versions_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DiffApi.diff_service_versions ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  from_version_id = opts[:'from_version_id']
  to_version_id = opts[:'to_version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling DiffApi.diff_service_versions"
  end
  # verify the required parameter 'from_version_id' is set
  if @api_client.config.client_side_validation && from_version_id.nil?
    fail ArgumentError, "Missing the required parameter 'from_version_id' when calling DiffApi.diff_service_versions"
  end
  # verify the required parameter 'to_version_id' is set
  if @api_client.config.client_side_validation && to_version_id.nil?
    fail ArgumentError, "Missing the required parameter 'to_version_id' when calling DiffApi.diff_service_versions"
  end
  allowable_values = ["text", "html", "html_simple"]
  if @api_client.config.client_side_validation && opts[:'format'] && !allowable_values.include?(opts[:'format'])
    fail ArgumentError, "invalid value for \"format\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/diff/from/{from_version_id}/to/{to_version_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'from_version_id' + '}', CGI.escape(from_version_id.to_s)).sub('{' + 'to_version_id' + '}', CGI.escape(to_version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'format'] = opts[:'format'] if !opts[:'format'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'DiffResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"DiffApi.diff_service_versions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DiffApi#diff_service_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end