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_namespace_list(owner, opts = {}) ⇒ Array<VulnerabilityScanResultsList>

Lists scan results for a specific namespace. Lists scan results for a specific namespace.

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:



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

def vulnerabilities_namespace_list(owner, opts = {})
  data, _status_code, _headers = vulnerabilities_namespace_list_with_http_info(owner, opts)
  data
end

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

Lists scan results for a specific namespace. Lists scan results for a specific namespace.

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



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

def vulnerabilities_namespace_list_with_http_info(owner, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilitiesApi.vulnerabilities_namespace_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_namespace_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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'token']
  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_namespace_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Lists scan results for a specific package. Lists scan results for a specific package.

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:



91
92
93
94
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 91

def vulnerabilities_package_list(owner, repo, package, opts = {})
  data, _status_code, _headers = vulnerabilities_package_list_with_http_info(owner, repo, package, opts)
  data
end

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

Lists scan results for a specific package. Lists scan results for a specific package.

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



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
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 105

def vulnerabilities_package_list_with_http_info(owner, repo, package, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilitiesApi.vulnerabilities_package_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_package_list"
  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_package_list"
  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_package_list"
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'token']
  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_package_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Get a scan result. Get a scan result.

Parameters:

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

    the optional parameters

Returns:



162
163
164
165
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 162

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

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

Get a scan result. Get a scan result.

Parameters:

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

    the optional parameters

Returns:

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

    VulnerabilityScanResults data, response status code and response headers



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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 175

def vulnerabilities_read_with_http_info(owner, repo, package, identifier, 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 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling VulnerabilitiesApi.vulnerabilities_read"
  end
  # resource path
  local_var_path = '/vulnerabilities/{owner}/{repo}/{package}/{identifier}/'.sub('{' + 'owner' + '}', owner.to_s).sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'package' + '}', package.to_s).sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'token']
  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

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

Lists scan results for a specific repository. Lists scan results for a specific repository.

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:



234
235
236
237
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 234

def vulnerabilities_repo_list(owner, repo, opts = {})
  data, _status_code, _headers = vulnerabilities_repo_list_with_http_info(owner, repo, opts)
  data
end

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

Lists scan results for a specific repository. Lists scan results for a specific repository.

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



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
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/cloudsmith-api/api/vulnerabilities_api.rb', line 247

def vulnerabilities_repo_list_with_http_info(owner, repo, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: VulnerabilitiesApi.vulnerabilities_repo_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_repo_list"
  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_repo_list"
  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 = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['apikey', 'basic', 'token']
  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_repo_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end