Class: CloudsmithApi::VulnerabilitiesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cloudsmith-api/api/vulnerabilities_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VulnerabilitiesApi

Returns a new instance of VulnerabilitiesApi.



19
20
21
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#vulnerabilities_list(owner, opts = {}) ⇒ Array<VulnerabilityScanResultsList>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



30
31
32
33
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 30

def vulnerabilities_list(owner, opts = {})
  data, _status_code, _headers = vulnerabilities_list_with_http_info(owner, opts)
  return data
end

#vulnerabilities_list0(owner, repo, opts = {}) ⇒ Array<VulnerabilityScanResultsList>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



88
89
90
91
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 88

def vulnerabilities_list0(owner, repo, opts = {})
  data, _status_code, _headers = vulnerabilities_list0_with_http_info(owner, repo, opts)
  return data
end

#vulnerabilities_list0_with_http_info(owner, repo, opts = {}) ⇒ Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>) —

    Array<VulnerabilityScanResultsList> data, response status code and response headers



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 101

def vulnerabilities_list0_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VulnerabilitiesApi.vulnerabilities_list0 ..."
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling VulnerabilitiesApi.vulnerabilities_list0"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling VulnerabilitiesApi.vulnerabilities_list0"
  end
  # resource path
  local_var_path = "/vulnerabilities/{owner}/{repo}/".sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<VulnerabilityScanResultsList>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VulnerabilitiesApi#vulnerabilities_list0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#vulnerabilities_list1(owner, repo, package, opts = {}) ⇒ Array<VulnerabilityScanResultsList>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

  • owner
  • repo
  • package
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:



152
153
154
155
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 152

def vulnerabilities_list1(owner, repo, package, opts = {})
  data, _status_code, _headers = vulnerabilities_list1_with_http_info(owner, repo, package, opts)
  return data
end

#vulnerabilities_list1_with_http_info(owner, repo, package, opts = {}) ⇒ Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

  • owner
  • repo
  • package
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>) —

    Array<VulnerabilityScanResultsList> data, response status code and response headers



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 166

def vulnerabilities_list1_with_http_info(owner, repo, package, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VulnerabilitiesApi.vulnerabilities_list1 ..."
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling VulnerabilitiesApi.vulnerabilities_list1"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling VulnerabilitiesApi.vulnerabilities_list1"
  end
  # verify the required parameter 'package' is set
  if @api_client.config.client_side_validation && package.nil?
    fail ArgumentError, "Missing the required parameter 'package' when calling VulnerabilitiesApi.vulnerabilities_list1"
  end
  # resource path
  local_var_path = "/vulnerabilities/{owner}/{repo}/{package}/".sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'package' + '}', package.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<VulnerabilityScanResultsList>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VulnerabilitiesApi#vulnerabilities_list1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#vulnerabilities_list_with_http_info(owner, opts = {}) ⇒ Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>

Checks feature is within plan before listing results. Checks feature is within plan before listing results.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    A page number within the paginated result set.

  • :page_size (Integer) —

    Number of results to return per page.

Returns:

  • (Array<(Array<VulnerabilityScanResultsList>, Fixnum, Hash)>) —

    Array<VulnerabilityScanResultsList> data, response status code and response headers



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
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 42

def vulnerabilities_list_with_http_info(owner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VulnerabilitiesApi.vulnerabilities_list ..."
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling VulnerabilitiesApi.vulnerabilities_list"
  end
  # resource path
  local_var_path = "/vulnerabilities/{owner}/".sub('{' + 'owner' + '}', owner.to_s)

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

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<VulnerabilityScanResultsList>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VulnerabilitiesApi#vulnerabilities_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#vulnerabilities_read(owner, repo, package, scan_id, opts = {}) ⇒ VulnerabilityScanResults

Checks feature is within plan before retrieving results. Checks feature is within plan before retrieving results.

Parameters:

  • owner
  • repo
  • package
  • scan_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



220
221
222
223
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 220

def vulnerabilities_read(owner, repo, package, scan_id, opts = {})
  data, _status_code, _headers = vulnerabilities_read_with_http_info(owner, repo, package, scan_id, opts)
  return data
end

#vulnerabilities_read_with_http_info(owner, repo, package, scan_id, opts = {}) ⇒ Array<(VulnerabilityScanResults, Fixnum, Hash)>

Checks feature is within plan before retrieving results. Checks feature is within plan before retrieving results.

Parameters:

  • owner
  • repo
  • package
  • scan_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VulnerabilityScanResults, Fixnum, Hash)>) —

    VulnerabilityScanResults data, response status code and response headers



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 233

def vulnerabilities_read_with_http_info(owner, repo, package, scan_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VulnerabilitiesApi.vulnerabilities_read ..."
  end
  # verify the required parameter 'owner' is set
  if @api_client.config.client_side_validation && owner.nil?
    fail ArgumentError, "Missing the required parameter 'owner' when calling VulnerabilitiesApi.vulnerabilities_read"
  end
  # verify the required parameter 'repo' is set
  if @api_client.config.client_side_validation && repo.nil?
    fail ArgumentError, "Missing the required parameter 'repo' when calling VulnerabilitiesApi.vulnerabilities_read"
  end
  # verify the required parameter 'package' is set
  if @api_client.config.client_side_validation && package.nil?
    fail ArgumentError, "Missing the required parameter 'package' when calling VulnerabilitiesApi.vulnerabilities_read"
  end
  # verify the required parameter 'scan_id' is set
  if @api_client.config.client_side_validation && scan_id.nil?
    fail ArgumentError, "Missing the required parameter 'scan_id' when calling VulnerabilitiesApi.vulnerabilities_read"
  end
  # resource path
  local_var_path = "/vulnerabilities/{owner}/{repo}/{package}/{scan_id}/".sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'package' + '}', package.to_s).sub('{' + 'scan_id' + '}', scan_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VulnerabilityScanResults')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VulnerabilitiesApi#vulnerabilities_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end