Class: Harbor2LegacyClient::ProductsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_legacy_client/api/products_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ProductsApi

Returns a new instance of ProductsApi.



19
20
21
 
# File 'lib/harbor2_legacy_client/api/products_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/harbor2_legacy_client/api/products_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#chartrepo_repo_charts_name_version_labels_get(repo, name, version, opts = {}) ⇒ nil

Return the attahced labels of chart. Return the attahced labels of the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 29

def chartrepo_repo_charts_name_version_labels_get(repo, name, version, opts = {})
  chartrepo_repo_charts_name_version_labels_get_with_http_info(repo, name, version, opts)
  nil
end

#chartrepo_repo_charts_name_version_labels_get_with_http_info(repo, name, version, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Return the attahced labels of chart. Return the attahced labels of the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

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

    the optional parameters

Returns:

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

    nil, 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
82
83
84
85
86
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 41

def chartrepo_repo_charts_name_version_labels_get_with_http_info(repo, name, version, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.chartrepo_repo_charts_name_version_labels_get ...'
  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 ProductsApi.chartrepo_repo_charts_name_version_labels_get"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_get"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_get"
  end
  # resource path
  local_var_path = '/chartrepo/{repo}/charts/{name}/{version}/labels'.sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'version' + '}', version.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', 'text/plain'])
  # 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 = ['basicAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#chartrepo_repo_charts_name_version_labels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#chartrepo_repo_charts_name_version_labels_id_delete(repo, name, version, id, opts = {}) ⇒ nil

Remove label from chart. Remove label from the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

  • id —

    The label ID

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

    the optional parameters

Returns:

  • (nil) 


95
96
97
98
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 95

def chartrepo_repo_charts_name_version_labels_id_delete(repo, name, version, id, opts = {})
  chartrepo_repo_charts_name_version_labels_id_delete_with_http_info(repo, name, version, id, opts)
  nil
end

#chartrepo_repo_charts_name_version_labels_id_delete_with_http_info(repo, name, version, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove label from chart. Remove label from the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

  • id —

    The label ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
154
155
156
157
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 108

def chartrepo_repo_charts_name_version_labels_id_delete_with_http_info(repo, name, version, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.chartrepo_repo_charts_name_version_labels_id_delete ...'
  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 ProductsApi.chartrepo_repo_charts_name_version_labels_id_delete"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_id_delete"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_id_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_id_delete"
  end
  # resource path
  local_var_path = '/chartrepo/{repo}/charts/{name}/{version}/labels/{id}'.sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'version' + '}', version.to_s).sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#chartrepo_repo_charts_name_version_labels_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#chartrepo_repo_charts_name_version_labels_post(repo, name, version, label, opts = {}) ⇒ nil

Mark label to chart. Mark label to the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

  • label —

    The label being marked to the chart version

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

    the optional parameters

Returns:

  • (nil) 


166
167
168
169
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 166

def chartrepo_repo_charts_name_version_labels_post(repo, name, version, label, opts = {})
  chartrepo_repo_charts_name_version_labels_post_with_http_info(repo, name, version, label, opts)
  nil
end

#chartrepo_repo_charts_name_version_labels_post_with_http_info(repo, name, version, label, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Mark label to chart. Mark label to the specified chart version.

Parameters:

  • repo —

    The project name

  • name —

    The chart name

  • version —

    The chart version

  • label —

    The label being marked to the chart version

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
226
227
228
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 179

def chartrepo_repo_charts_name_version_labels_post_with_http_info(repo, name, version, label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.chartrepo_repo_charts_name_version_labels_post ...'
  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 ProductsApi.chartrepo_repo_charts_name_version_labels_post"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_post"
  end
  # verify the required parameter 'version' is set
  if @api_client.config.client_side_validation && version.nil?
    fail ArgumentError, "Missing the required parameter 'version' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_post"
  end
  # verify the required parameter 'label' is set
  if @api_client.config.client_side_validation && label.nil?
    fail ArgumentError, "Missing the required parameter 'label' when calling ProductsApi.chartrepo_repo_charts_name_version_labels_post"
  end
  # resource path
  local_var_path = '/chartrepo/{repo}/charts/{name}/{version}/labels'.sub('{' + 'repo' + '}', repo.to_s).sub('{' + 'name' + '}', name.to_s).sub('{' + 'version' + '}', version.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(label)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#chartrepo_repo_charts_name_version_labels_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configurations_get(opts = {}) ⇒ ConfigurationsResponse

Get system configurations. This endpoint is for retrieving system configurations that only provides for admin user.

Parameters:

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

    the optional parameters

Returns:



233
234
235
236
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 233

def configurations_get(opts = {})
  data, _status_code, _headers = configurations_get_with_http_info(opts)
  data
end

#configurations_get_with_http_info(opts = {}) ⇒ Array<(ConfigurationsResponse, Fixnum, Hash)>

Get system configurations. This endpoint is for retrieving system configurations that only provides for admin user.

Parameters:

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

    the optional parameters

Returns:

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

    ConfigurationsResponse data, response status code and response headers



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
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 242

def configurations_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.configurations_get ...'
  end
  # resource path
  local_var_path = '/configurations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ConfigurationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#configurations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#configurations_put(configurations, opts = {}) ⇒ nil

Modify system configurations. This endpoint is for modifying system configurations that only provides for admin user.

Parameters:

  • configurations —

    The configuration map can contain a subset of the attributes of the schema, which are to be updated.

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

    the optional parameters

Returns:

  • (nil) 


282
283
284
285
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 282

def configurations_put(configurations, opts = {})
  configurations_put_with_http_info(configurations, opts)
  nil
end

#configurations_put_with_http_info(configurations, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Modify system configurations. This endpoint is for modifying system configurations that only provides for admin user.

Parameters:

  • configurations —

    The configuration map can contain a subset of the attributes of the schema, which are to be updated.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 292

def configurations_put_with_http_info(configurations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.configurations_put ...'
  end
  # verify the required parameter 'configurations' is set
  if @api_client.config.client_side_validation && configurations.nil?
    fail ArgumentError, "Missing the required parameter 'configurations' when calling ProductsApi.configurations_put"
  end
  # resource path
  local_var_path = '/configurations'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(configurations)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#configurations_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#email_ping_post(opts = {}) ⇒ nil

Test connection and authentication with email server. Test connection and authentication with email server.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :settings (EmailServerSetting) —

    Email server settings, if some of the settings are not assigned, they will be read from system configuration.

Returns:

  • (nil) 


335
336
337
338
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 335

def email_ping_post(opts = {})
  email_ping_post_with_http_info(opts)
  nil
end

#email_ping_post_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test connection and authentication with email server. Test connection and authentication with email server.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :settings (EmailServerSetting) —

    Email server settings, if some of the settings are not assigned, they will be read from system configuration.

Returns:

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

    nil, response status code and response headers



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 345

def email_ping_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.email_ping_post ...'
  end
  # resource path
  local_var_path = '/email/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'settings'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#email_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#health_get(opts = {}) ⇒ OverallHealthStatus

Health check API The endpoint returns the health stauts of the system.

Parameters:

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

    the optional parameters

Returns:



383
384
385
386
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 383

def health_get(opts = {})
  data, _status_code, _headers = health_get_with_http_info(opts)
  data
end

#health_get_with_http_info(opts = {}) ⇒ Array<(OverallHealthStatus, Fixnum, Hash)>

Health check API The endpoint returns the health stauts of the system.

Parameters:

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

    the optional parameters

Returns:

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

    OverallHealthStatus data, response status code and response headers



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 392

def health_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.health_get ...'
  end
  # resource path
  local_var_path = '/health'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'OverallHealthStatus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#health_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#labels_get(scope, opts = {}) ⇒ Array<Label>

List labels according to the query strings. This endpoint let user list labels by name, scope and project_id

Parameters:

  • scope —

    The label scope. Valid values are g and p. g for global labels and p for project labels.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The label name.

  • :project_id (Integer) —

    Relevant project ID, required when scope is p.

  • :page (Integer) —

    The page nubmer.

  • :page_size (Integer) —

    The size of per page.

Returns:



436
437
438
439
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 436

def labels_get(scope, opts = {})
  data, _status_code, _headers = labels_get_with_http_info(scope, opts)
  data
end

#labels_get_with_http_info(scope, opts = {}) ⇒ Array<(Array<Label>, Fixnum, Hash)>

List labels according to the query strings. This endpoint let user list labels by name, scope and project_id

Parameters:

  • scope —

    The label scope. Valid values are g and p. g for global labels and p for project labels.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The label name.

  • :project_id (Integer) —

    Relevant project ID, required when scope is p.

  • :page (Integer) —

    The page nubmer.

  • :page_size (Integer) —

    The size of per page.

Returns:

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

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



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 450

def labels_get_with_http_info(scope, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.labels_get ...'
  end
  # verify the required parameter 'scope' is set
  if @api_client.config.client_side_validation && scope.nil?
    fail ArgumentError, "Missing the required parameter 'scope' when calling ProductsApi.labels_get"
  end
  # resource path
  local_var_path = '/labels'

  # query parameters
  query_params = {}
  query_params[:'scope'] = scope
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'project_id'] = opts[:'project_id'] if !opts[:'project_id'].nil?
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<Label>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#labels_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#labels_id_delete(id, opts = {}) ⇒ nil

Delete the label specified by ID. Delete the label specified by ID.

Parameters:

  • id —

    Label ID

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

    the optional parameters

Returns:

  • (nil) 


499
500
501
502
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 499

def labels_id_delete(id, opts = {})
  labels_id_delete_with_http_info(id, opts)
  nil
end

#labels_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the label specified by ID. Delete the label specified by ID.

Parameters:

  • id —

    Label ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 509

def labels_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.labels_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.labels_id_delete"
  end
  # resource path
  local_var_path = '/labels/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#labels_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#labels_id_get(id, opts = {}) ⇒ Label

Get the label specified by ID. This endpoint let user get the label by specific ID.

Parameters:

  • id —

    Label ID

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

    the optional parameters

Returns:



552
553
554
555
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 552

def labels_id_get(id, opts = {})
  data, _status_code, _headers = labels_id_get_with_http_info(id, opts)
  data
end

#labels_id_get_with_http_info(id, opts = {}) ⇒ Array<(Label, Fixnum, Hash)>

Get the label specified by ID. This endpoint let user get the label by specific ID.

Parameters:

  • id —

    Label ID

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

    the optional parameters

Returns:

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

    Label data, response status code and response headers



562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 562

def labels_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.labels_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.labels_id_get"
  end
  # resource path
  local_var_path = '/labels/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'Label')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#labels_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#labels_id_put(id, label, opts = {}) ⇒ nil

Update the label properties. This endpoint let user update label properties.

Parameters:

  • id —

    Label ID

  • label —

    The updated label json object.

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

    the optional parameters

Returns:

  • (nil) 


607
608
609
610
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 607

def labels_id_put(id, label, opts = {})
  labels_id_put_with_http_info(id, label, opts)
  nil
end

#labels_id_put_with_http_info(id, label, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the label properties. This endpoint let user update label properties.

Parameters:

  • id —

    Label ID

  • label —

    The updated label json object.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 618

def labels_id_put_with_http_info(id, label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.labels_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.labels_id_put"
  end
  # verify the required parameter 'label' is set
  if @api_client.config.client_side_validation && label.nil?
    fail ArgumentError, "Missing the required parameter 'label' when calling ProductsApi.labels_id_put"
  end
  # resource path
  local_var_path = '/labels/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(label)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#labels_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#labels_post(label, opts = {}) ⇒ nil

Post creates a label This endpoint let user creates a label.

Parameters:

  • label —

    The json object of label.

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

    the optional parameters

Returns:

  • (nil) 


665
666
667
668
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 665

def labels_post(label, opts = {})
  labels_post_with_http_info(label, opts)
  nil
end

#labels_post_with_http_info(label, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Post creates a label This endpoint let user creates a label.

Parameters:

  • label —

    The json object of label.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 675

def labels_post_with_http_info(label, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.labels_post ...'
  end
  # verify the required parameter 'label' is set
  if @api_client.config.client_side_validation && label.nil?
    fail ArgumentError, "Missing the required parameter 'label' when calling ProductsApi.labels_post"
  end
  # resource path
  local_var_path = '/labels'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(label)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#labels_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ldap_groups_search_get(opts = {}) ⇒ Array<UserGroup>

Search available ldap groups. This endpoint searches the available ldap groups based on related configuration parameters. support to search by groupname or groupdn.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :groupname (String) —

    Ldap group name

  • :groupdn (String) —

    The LDAP group DN

Returns:



719
720
721
722
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 719

def ldap_groups_search_get(opts = {})
  data, _status_code, _headers = ldap_groups_search_get_with_http_info(opts)
  data
end

#ldap_groups_search_get_with_http_info(opts = {}) ⇒ Array<(Array<UserGroup>, Fixnum, Hash)>

Search available ldap groups. This endpoint searches the available ldap groups based on related configuration parameters. support to search by groupname or groupdn.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :groupname (String) —

    Ldap group name

  • :groupdn (String) —

    The LDAP group DN

Returns:

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

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



730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 730

def ldap_groups_search_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.ldap_groups_search_get ...'
  end
  # resource path
  local_var_path = '/ldap/groups/search'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<UserGroup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#ldap_groups_search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ldap_ping_post(opts = {}) ⇒ nil

Ping available ldap service. This endpoint ping the available ldap service for test related configuration parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ldapconf (LdapConf) —

    ldap configuration. support input ldap service configuration. If it&#39;s a empty request, will load current configuration from the system.

Returns:

  • (nil) 


772
773
774
775
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 772

def ldap_ping_post(opts = {})
  ldap_ping_post_with_http_info(opts)
  nil
end

#ldap_ping_post_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Ping available ldap service. This endpoint ping the available ldap service for test related configuration parameters.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :ldapconf (LdapConf) —

    ldap configuration. support input ldap service configuration. If it&#39;s a empty request, will load current configuration from the system.

Returns:

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

    nil, response status code and response headers



782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 782

def ldap_ping_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.ldap_ping_post ...'
  end
  # resource path
  local_var_path = '/ldap/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'ldapconf'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#ldap_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ldap_users_import_post(uid_list, opts = {}) ⇒ nil

Import selected available ldap users. This endpoint adds the selected available ldap users to harbor based on related configuration parameters from the system. System will try to guess the user email address and realname, add to harbor user information. If have errors when import user, will return the list of importing failed uid and the failed reason.

Parameters:

  • uid_list —

    The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.

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

    the optional parameters

Returns:

  • (nil) 


821
822
823
824
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 821

def ldap_users_import_post(uid_list, opts = {})
  ldap_users_import_post_with_http_info(uid_list, opts)
  nil
end

#ldap_users_import_post_with_http_info(uid_list, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Import selected available ldap users. This endpoint adds the selected available ldap users to harbor based on related configuration parameters from the system. System will try to guess the user email address and realname, add to harbor user information. If have errors when import user, will return the list of importing failed uid and the failed reason.

Parameters:

  • uid_list —

    The uid listed for importing. This list will check users validity of ldap service based on configuration from the system.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 831

def ldap_users_import_post_with_http_info(uid_list, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.ldap_users_import_post ...'
  end
  # verify the required parameter 'uid_list' is set
  if @api_client.config.client_side_validation && uid_list.nil?
    fail ArgumentError, "Missing the required parameter 'uid_list' when calling ProductsApi.ldap_users_import_post"
  end
  # resource path
  local_var_path = '/ldap/users/import'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(uid_list)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#ldap_users_import_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#ldap_users_search_get(opts = {}) ⇒ Array<LdapUsers>

Search available ldap users. This endpoint searches the available ldap users based on related configuration parameters. Support searched by input ladp configuration, load configuration from the system and specific filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :username (String) —

    Registered user ID

Returns:



874
875
876
877
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 874

def ldap_users_search_get(opts = {})
  data, _status_code, _headers = ldap_users_search_get_with_http_info(opts)
  data
end

#ldap_users_search_get_with_http_info(opts = {}) ⇒ Array<(Array<LdapUsers>, Fixnum, Hash)>

Search available ldap users. This endpoint searches the available ldap users based on related configuration parameters. Support searched by input ladp configuration, load configuration from the system and specific filter.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :username (String) —

    Registered user ID

Returns:

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

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



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 884

def ldap_users_search_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.ldap_users_search_get ...'
  end
  # resource path
  local_var_path = '/ldap/users/search'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<LdapUsers>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#ldap_users_search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_immutabletagrules_get(project_id, opts = {}) ⇒ Array<RetentionRule>

List all immutable tag rules of current project This endpoint returns the immutable tag rules of a project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



925
926
927
928
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 925

def projects_project_id_immutabletagrules_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_immutabletagrules_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_immutabletagrules_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<RetentionRule>, Fixnum, Hash)>

List all immutable tag rules of current project This endpoint returns the immutable tag rules of a project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

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



935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 935

def projects_project_id_immutabletagrules_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_immutabletagrules_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_immutabletagrules_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/immutabletagrules'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<RetentionRule>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_immutabletagrules_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_immutabletagrules_id_delete(project_id, id, opts = {}) ⇒ nil

Delete the immutable tag rule.

Parameters:

  • project_id —

    Relevant project ID.

  • id —

    Immutable tag rule ID.

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

    the optional parameters

Returns:

  • (nil) 


979
980
981
982
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 979

def projects_project_id_immutabletagrules_id_delete(project_id, id, opts = {})
  projects_project_id_immutabletagrules_id_delete_with_http_info(project_id, id, opts)
  nil
end

#projects_project_id_immutabletagrules_id_delete_with_http_info(project_id, id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the immutable tag rule.

Parameters:

  • project_id —

    Relevant project ID.

  • id —

    Immutable tag rule ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 989

def projects_project_id_immutabletagrules_id_delete_with_http_info(project_id, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_immutabletagrules_id_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_immutabletagrules_id_delete"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.projects_project_id_immutabletagrules_id_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/immutabletagrules/{id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_immutabletagrules_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_immutabletagrules_id_put(project_id, id, retention_rule, opts = {}) ⇒ nil

Update the immutable tag rule or enable or disable the rule

Parameters:

  • project_id —

    Relevant project ID.

  • id —

    Immutable tag rule ID.

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

    the optional parameters

Returns:

  • (nil) 


1037
1038
1039
1040
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1037

def projects_project_id_immutabletagrules_id_put(project_id, id, retention_rule, opts = {})
  projects_project_id_immutabletagrules_id_put_with_http_info(project_id, id, retention_rule, opts)
  nil
end

#projects_project_id_immutabletagrules_id_put_with_http_info(project_id, id, retention_rule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the immutable tag rule or enable or disable the rule

Parameters:

  • project_id —

    Relevant project ID.

  • id —

    Immutable tag rule ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1048

def projects_project_id_immutabletagrules_id_put_with_http_info(project_id, id, retention_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_immutabletagrules_id_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_immutabletagrules_id_put"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.projects_project_id_immutabletagrules_id_put"
  end
  # verify the required parameter 'retention_rule' is set
  if @api_client.config.client_side_validation && retention_rule.nil?
    fail ArgumentError, "Missing the required parameter 'retention_rule' when calling ProductsApi.projects_project_id_immutabletagrules_id_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/immutabletagrules/{id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(retention_rule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_immutabletagrules_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_immutabletagrules_post(project_id, retention_rule, opts = {}) ⇒ nil

Add an immutable tag rule to current project This endpoint add an immutable tag rule to the project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

  • (nil) 


1100
1101
1102
1103
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1100

def projects_project_id_immutabletagrules_post(project_id, retention_rule, opts = {})
  projects_project_id_immutabletagrules_post_with_http_info(project_id, retention_rule, opts)
  nil
end

#projects_project_id_immutabletagrules_post_with_http_info(project_id, retention_rule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add an immutable tag rule to current project This endpoint add an immutable tag rule to the project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1111

def projects_project_id_immutabletagrules_post_with_http_info(project_id, retention_rule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_immutabletagrules_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_immutabletagrules_post"
  end
  # verify the required parameter 'retention_rule' is set
  if @api_client.config.client_side_validation && retention_rule.nil?
    fail ArgumentError, "Missing the required parameter 'retention_rule' when calling ProductsApi.projects_project_id_immutabletagrules_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/immutabletagrules'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(retention_rule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_immutabletagrules_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_members_get(project_id, opts = {}) ⇒ Array<ProjectMemberEntity>

Get all project member information Get all project member information

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Options Hash (opts):

  • :entityname (String) —

    The entity name to search.

Returns:



1159
1160
1161
1162
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1159

def projects_project_id_members_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_members_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_members_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<ProjectMemberEntity>, Fixnum, Hash)>

Get all project member information Get all project member information

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Options Hash (opts):

  • :entityname (String) —

    The entity name to search.

Returns:

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

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



1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1170

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

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<ProjectMemberEntity>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_members_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_members_mid_delete(project_id, mid, opts = {}) ⇒ nil

Delete project member

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    Member ID.

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

    the optional parameters

Returns:

  • (nil) 


1215
1216
1217
1218
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1215

def projects_project_id_members_mid_delete(project_id, mid, opts = {})
  projects_project_id_members_mid_delete_with_http_info(project_id, mid, opts)
  nil
end

#projects_project_id_members_mid_delete_with_http_info(project_id, mid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete project member

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    Member ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1225

def projects_project_id_members_mid_delete_with_http_info(project_id, mid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_members_mid_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_members_mid_delete"
  end
  # verify the required parameter 'mid' is set
  if @api_client.config.client_side_validation && mid.nil?
    fail ArgumentError, "Missing the required parameter 'mid' when calling ProductsApi.projects_project_id_members_mid_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/members/{mid}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'mid' + '}', mid.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_members_mid_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_members_mid_get(project_id, mid, opts = {}) ⇒ ProjectMemberEntity

Get the project member information Get the project member information

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    The member ID

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

    the optional parameters

Returns:



1273
1274
1275
1276
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1273

def projects_project_id_members_mid_get(project_id, mid, opts = {})
  data, _status_code, _headers = projects_project_id_members_mid_get_with_http_info(project_id, mid, opts)
  data
end

#projects_project_id_members_mid_get_with_http_info(project_id, mid, opts = {}) ⇒ Array<(ProjectMemberEntity, Fixnum, Hash)>

Get the project member information Get the project member information

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    The member ID

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

    the optional parameters

Returns:

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

    ProjectMemberEntity data, response status code and response headers



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1284

def projects_project_id_members_mid_get_with_http_info(project_id, mid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_members_mid_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_members_mid_get"
  end
  # verify the required parameter 'mid' is set
  if @api_client.config.client_side_validation && mid.nil?
    fail ArgumentError, "Missing the required parameter 'mid' when calling ProductsApi.projects_project_id_members_mid_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/members/{mid}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'mid' + '}', mid.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ProjectMemberEntity')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_members_mid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_members_mid_put(project_id, mid, opts = {}) ⇒ nil

Update project member Update project member relationship

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    Member ID.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1334
1335
1336
1337
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1334

def projects_project_id_members_mid_put(project_id, mid, opts = {})
  projects_project_id_members_mid_put_with_http_info(project_id, mid, opts)
  nil
end

#projects_project_id_members_mid_put_with_http_info(project_id, mid, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update project member Update project member relationship

Parameters:

  • project_id —

    Relevant project ID.

  • mid —

    Member ID.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1346

def projects_project_id_members_mid_put_with_http_info(project_id, mid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_members_mid_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_members_mid_put"
  end
  # verify the required parameter 'mid' is set
  if @api_client.config.client_side_validation && mid.nil?
    fail ArgumentError, "Missing the required parameter 'mid' when calling ProductsApi.projects_project_id_members_mid_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/members/{mid}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'mid' + '}', mid.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'role'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_members_mid_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_members_post(project_id, opts = {}) ⇒ nil

Create project member Create project member relationship, the member can be one of the user_member and group_member, The user_member need to specify user_id or username. If the user already exist in harbor DB, specify the user_id, If does not exist in harbor DB, it will SearchAndOnBoard the user. The group_member need to specify id or ldap_group_dn. If the group already exist in harbor DB. specify the user group’s id, If does not exist, it will SearchAndOnBoard the group.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


1394
1395
1396
1397
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1394

def projects_project_id_members_post(project_id, opts = {})
  projects_project_id_members_post_with_http_info(project_id, opts)
  nil
end

#projects_project_id_members_post_with_http_info(project_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create project member Create project member relationship, the member can be one of the user_member and group_member, The user_member need to specify user_id or username. If the user already exist in harbor DB, specify the user_id, If does not exist in harbor DB, it will SearchAndOnBoard the user. The group_member need to specify id or ldap_group_dn. If the group already exist in harbor DB. specify the user group&#39;s id, If does not exist, it will SearchAndOnBoard the group.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1405

def projects_project_id_members_post_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_members_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_members_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/members'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'project_member'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_members_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_metadatas_get(project_id, opts = {}) ⇒ ProjectMetadata

Get project metadata. This endpoint returns metadata of the project specified by project ID.

Parameters:

  • project_id —

    The ID of project.

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

    the optional parameters

Returns:



1448
1449
1450
1451
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1448

def projects_project_id_metadatas_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_metadatas_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_metadatas_get_with_http_info(project_id, opts = {}) ⇒ Array<(ProjectMetadata, Fixnum, Hash)>

Get project metadata. This endpoint returns metadata of the project specified by project ID.

Parameters:

  • project_id —

    The ID of project.

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

    the optional parameters

Returns:

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

    ProjectMetadata data, response status code and response headers



1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1458

def projects_project_id_metadatas_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_metadatas_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_metadatas_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/metadatas'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ProjectMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_metadatas_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_metadatas_meta_name_delete(project_id, meta_name, opts = {}) ⇒ nil

Delete metadata of a project This endpoint is aimed to delete metadata of a project.

Parameters:

  • project_id —

    The ID of project.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:

  • (nil) 


1503
1504
1505
1506
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1503

def projects_project_id_metadatas_meta_name_delete(project_id, meta_name, opts = {})
  projects_project_id_metadatas_meta_name_delete_with_http_info(project_id, meta_name, opts)
  nil
end

#projects_project_id_metadatas_meta_name_delete_with_http_info(project_id, meta_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete metadata of a project This endpoint is aimed to delete metadata of a project.

Parameters:

  • project_id —

    The ID of project.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1514

def projects_project_id_metadatas_meta_name_delete_with_http_info(project_id, meta_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_metadatas_meta_name_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_metadatas_meta_name_delete"
  end
  # verify the required parameter 'meta_name' is set
  if @api_client.config.client_side_validation && meta_name.nil?
    fail ArgumentError, "Missing the required parameter 'meta_name' when calling ProductsApi.projects_project_id_metadatas_meta_name_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/metadatas/{meta_name}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'meta_name' + '}', meta_name.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_metadatas_meta_name_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_metadatas_meta_name_get(project_id, meta_name, opts = {}) ⇒ ProjectMetadata

Get project metadata This endpoint returns specified metadata of a project.

Parameters:

  • project_id —

    Project ID for filtering results.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:



1562
1563
1564
1565
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1562

def projects_project_id_metadatas_meta_name_get(project_id, meta_name, opts = {})
  data, _status_code, _headers = projects_project_id_metadatas_meta_name_get_with_http_info(project_id, meta_name, opts)
  data
end

#projects_project_id_metadatas_meta_name_get_with_http_info(project_id, meta_name, opts = {}) ⇒ Array<(ProjectMetadata, Fixnum, Hash)>

Get project metadata This endpoint returns specified metadata of a project.

Parameters:

  • project_id —

    Project ID for filtering results.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:

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

    ProjectMetadata data, response status code and response headers



1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1573

def projects_project_id_metadatas_meta_name_get_with_http_info(project_id, meta_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_metadatas_meta_name_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_metadatas_meta_name_get"
  end
  # verify the required parameter 'meta_name' is set
  if @api_client.config.client_side_validation && meta_name.nil?
    fail ArgumentError, "Missing the required parameter 'meta_name' when calling ProductsApi.projects_project_id_metadatas_meta_name_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/metadatas/{meta_name}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'meta_name' + '}', meta_name.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ProjectMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_metadatas_meta_name_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_metadatas_meta_name_put(project_id, meta_name, opts = {}) ⇒ nil

Update metadata of a project. This endpoint is aimed to update the metadata of a project.

Parameters:

  • project_id —

    The ID of project.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:

  • (nil) 


1622
1623
1624
1625
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1622

def projects_project_id_metadatas_meta_name_put(project_id, meta_name, opts = {})
  projects_project_id_metadatas_meta_name_put_with_http_info(project_id, meta_name, opts)
  nil
end

#projects_project_id_metadatas_meta_name_put_with_http_info(project_id, meta_name, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update metadata of a project. This endpoint is aimed to update the metadata of a project.

Parameters:

  • project_id —

    The ID of project.

  • meta_name —

    The name of metadat.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1633

def projects_project_id_metadatas_meta_name_put_with_http_info(project_id, meta_name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_metadatas_meta_name_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_metadatas_meta_name_put"
  end
  # verify the required parameter 'meta_name' is set
  if @api_client.config.client_side_validation && meta_name.nil?
    fail ArgumentError, "Missing the required parameter 'meta_name' when calling ProductsApi.projects_project_id_metadatas_meta_name_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/metadatas/{meta_name}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'meta_name' + '}', meta_name.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_metadatas_meta_name_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_metadatas_post(project_id, metadata, opts = {}) ⇒ nil

Add metadata for the project. This endpoint is aimed to add metadata of a project.

Parameters:

  • project_id —

    Selected project ID.

  • metadata —

    The metadata of project.

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

    the optional parameters

Returns:

  • (nil) 


1681
1682
1683
1684
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1681

def projects_project_id_metadatas_post(project_id, metadata, opts = {})
  projects_project_id_metadatas_post_with_http_info(project_id, metadata, opts)
  nil
end

#projects_project_id_metadatas_post_with_http_info(project_id, metadata, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Add metadata for the project. This endpoint is aimed to add metadata of a project.

Parameters:

  • project_id —

    Selected project ID.

  • metadata —

    The metadata of project.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1692

def projects_project_id_metadatas_post_with_http_info(project_id, metadata, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_metadatas_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_metadatas_post"
  end
  # verify the required parameter 'metadata' is set
  if @api_client.config.client_side_validation && metadata.nil?
    fail ArgumentError, "Missing the required parameter 'metadata' when calling ProductsApi.projects_project_id_metadatas_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/metadatas'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(metadata)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_metadatas_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_get(project_id, opts = {}) ⇒ Array<RobotAccount>

Get all robot accounts of specified project Get all robot accounts of specified project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



1739
1740
1741
1742
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1739

def projects_project_id_robots_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_robots_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_robots_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<RobotAccount>, Fixnum, Hash)>

Get all robot accounts of specified project Get all robot accounts of specified project

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

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



1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1749

def projects_project_id_robots_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_robots_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_robots_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<RobotAccount>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_robots_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_post(project_id, robot, opts = {}) ⇒ RobotAccountPostRep

Create a robot account for project Create a robot account for project

Parameters:

  • project_id —

    Relevant project ID.

  • robot —

    Request body of creating a robot account.

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

    the optional parameters

Returns:



1794
1795
1796
1797
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1794

def projects_project_id_robots_post(project_id, robot, opts = {})
  data, _status_code, _headers = projects_project_id_robots_post_with_http_info(project_id, robot, opts)
  data
end

#projects_project_id_robots_post_with_http_info(project_id, robot, opts = {}) ⇒ Array<(RobotAccountPostRep, Fixnum, Hash)>

Create a robot account for project Create a robot account for project

Parameters:

  • project_id —

    Relevant project ID.

  • robot —

    Request body of creating a robot account.

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

    the optional parameters

Returns:

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

    RobotAccountPostRep data, response status code and response headers



1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1805

def projects_project_id_robots_post_with_http_info(project_id, robot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_robots_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_robots_post"
  end
  # verify the required parameter 'robot' is set
  if @api_client.config.client_side_validation && robot.nil?
    fail ArgumentError, "Missing the required parameter 'robot' when calling ProductsApi.projects_project_id_robots_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(robot)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RobotAccountPostRep')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_robots_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_delete(project_id, robot_id, opts = {}) ⇒ nil

Delete the specified robot account Delete the specified robot account

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

  • (nil) 


1854
1855
1856
1857
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1854

def projects_project_id_robots_robot_id_delete(project_id, robot_id, opts = {})
  projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts)
  nil
end

#projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the specified robot account Delete the specified robot account

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1865

def projects_project_id_robots_robot_id_delete_with_http_info(project_id, robot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_robots_robot_id_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_robots_robot_id_delete"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling ProductsApi.projects_project_id_robots_robot_id_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_robots_robot_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_get(project_id, robot_id, opts = {}) ⇒ RobotAccount

Return the infor of the specified robot account. Return the infor of the specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:



1913
1914
1915
1916
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1913

def projects_project_id_robots_robot_id_get(project_id, robot_id, opts = {})
  data, _status_code, _headers = projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts)
  data
end

#projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts = {}) ⇒ Array<(RobotAccount, Fixnum, Hash)>

Return the infor of the specified robot account. Return the infor of the specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

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

    the optional parameters

Returns:

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

    RobotAccount data, response status code and response headers



1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1924

def projects_project_id_robots_robot_id_get_with_http_info(project_id, robot_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_robots_robot_id_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_robots_robot_id_get"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling ProductsApi.projects_project_id_robots_robot_id_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'RobotAccount')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_robots_robot_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_robots_robot_id_put(project_id, robot_id, robot, opts = {}) ⇒ nil

Update status of robot account. Used to disable/enable a specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

  • robot —

    Request body of enable/disable a robot account.

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

    the optional parameters

Returns:

  • (nil) 


1974
1975
1976
1977
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1974

def projects_project_id_robots_robot_id_put(project_id, robot_id, robot, opts = {})
  projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts)
  nil
end

#projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update status of robot account. Used to disable/enable a specified robot account.

Parameters:

  • project_id —

    Relevant project ID.

  • robot_id —

    The ID of robot account.

  • robot —

    Request body of enable/disable a robot account.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 1986

def projects_project_id_robots_robot_id_put_with_http_info(project_id, robot_id, robot, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_robots_robot_id_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_robots_robot_id_put"
  end
  # verify the required parameter 'robot_id' is set
  if @api_client.config.client_side_validation && robot_id.nil?
    fail ArgumentError, "Missing the required parameter 'robot_id' when calling ProductsApi.projects_project_id_robots_robot_id_put"
  end
  # verify the required parameter 'robot' is set
  if @api_client.config.client_side_validation && robot.nil?
    fail ArgumentError, "Missing the required parameter 'robot' when calling ProductsApi.projects_project_id_robots_robot_id_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/robots/{robot_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'robot_id' + '}', robot_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(robot)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_robots_robot_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_scanner_candidates_get(project_id, opts = {}) ⇒ Array<ScannerRegistration>

Get scanner registration candidates for configurating project level scanner Retrieve the system configured scanner registrations as candidates of setting project level scanner.

Parameters:

  • project_id —

    The project identifier.

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

    the optional parameters

Returns:



2037
2038
2039
2040
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2037

def projects_project_id_scanner_candidates_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_scanner_candidates_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_scanner_candidates_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<ScannerRegistration>, Fixnum, Hash)>

Get scanner registration candidates for configurating project level scanner Retrieve the system configured scanner registrations as candidates of setting project level scanner.

Parameters:

  • project_id —

    The project identifier.

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

    the optional parameters

Returns:

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

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



2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2047

def projects_project_id_scanner_candidates_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_scanner_candidates_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_scanner_candidates_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/scanner/candidates'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<ScannerRegistration>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_scanner_candidates_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_scanner_get(project_id, opts = {}) ⇒ ScannerRegistration

Get project level scanner Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.

Parameters:

  • project_id —

    The project identifier.

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

    the optional parameters

Returns:



2091
2092
2093
2094
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2091

def projects_project_id_scanner_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_scanner_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_scanner_get_with_http_info(project_id, opts = {}) ⇒ Array<(ScannerRegistration, Fixnum, Hash)>

Get project level scanner Get the scanner registration of the specified project. If no scanner registration is configured for the specified project, the system default scanner registration will be returned.

Parameters:

  • project_id —

    The project identifier.

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

    the optional parameters

Returns:

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

    ScannerRegistration data, response status code and response headers



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2101

def projects_project_id_scanner_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_scanner_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_scanner_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/scanner'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ScannerRegistration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_scanner_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_events_get(project_id, opts = {}) ⇒ SupportedWebhookEventTypes

Get supported event types and notify types. Get supportted event types and notify types.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



2145
2146
2147
2148
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2145

def projects_project_id_webhook_events_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_webhook_events_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_webhook_events_get_with_http_info(project_id, opts = {}) ⇒ Array<(SupportedWebhookEventTypes, Fixnum, Hash)>

Get supported event types and notify types. Get supportted event types and notify types.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

    SupportedWebhookEventTypes data, response status code and response headers



2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2155

def projects_project_id_webhook_events_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_events_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_events_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/events'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'SupportedWebhookEventTypes')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_jobs_get(project_id, policy_id, opts = {}) ⇒ Array<WebhookJob>

List project webhook jobs This endpoint returns webhook jobs of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The policy ID.

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

    the optional parameters

Returns:



2200
2201
2202
2203
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2200

def projects_project_id_webhook_jobs_get(project_id, policy_id, opts = {})
  data, _status_code, _headers = projects_project_id_webhook_jobs_get_with_http_info(project_id, policy_id, opts)
  data
end

#projects_project_id_webhook_jobs_get_with_http_info(project_id, policy_id, opts = {}) ⇒ Array<(Array<WebhookJob>, Fixnum, Hash)>

List project webhook jobs This endpoint returns webhook jobs of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The policy ID.

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

    the optional parameters

Returns:

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

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



2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2211

def projects_project_id_webhook_jobs_get_with_http_info(project_id, policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_jobs_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_jobs_get"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling ProductsApi.projects_project_id_webhook_jobs_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/jobs'.sub('{' + 'project_id' + '}', project_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'policy_id'] = policy_id

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<WebhookJob>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_jobs_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_lasttrigger_get(project_id, opts = {}) ⇒ Array<WebhookLastTrigger>

Get project webhook policy last trigger info This endpoint returns last trigger information of project webhook policy.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



2260
2261
2262
2263
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2260

def projects_project_id_webhook_lasttrigger_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_webhook_lasttrigger_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_webhook_lasttrigger_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<WebhookLastTrigger>, Fixnum, Hash)>

Get project webhook policy last trigger info This endpoint returns last trigger information of project webhook policy.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

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



2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2270

def projects_project_id_webhook_lasttrigger_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_lasttrigger_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_lasttrigger_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/lasttrigger'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<WebhookLastTrigger>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_lasttrigger_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_get(project_id, opts = {}) ⇒ Array<WebhookPolicy>

List project webhook policies. This endpoint returns webhook policies of a project.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:



2314
2315
2316
2317
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2314

def projects_project_id_webhook_policies_get(project_id, opts = {})
  data, _status_code, _headers = projects_project_id_webhook_policies_get_with_http_info(project_id, opts)
  data
end

#projects_project_id_webhook_policies_get_with_http_info(project_id, opts = {}) ⇒ Array<(Array<WebhookPolicy>, Fixnum, Hash)>

List project webhook policies. This endpoint returns webhook policies of a project.

Parameters:

  • project_id —

    Relevant project ID.

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

    the optional parameters

Returns:

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

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



2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2324

def projects_project_id_webhook_policies_get_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<WebhookPolicy>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_policy_id_delete(project_id, policy_id, opts = {}) ⇒ nil

Delete webhook policy of a project This endpoint is aimed to delete webhookpolicy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

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

    the optional parameters

Returns:

  • (nil) 


2369
2370
2371
2372
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2369

def projects_project_id_webhook_policies_policy_id_delete(project_id, policy_id, opts = {})
  projects_project_id_webhook_policies_policy_id_delete_with_http_info(project_id, policy_id, opts)
  nil
end

#projects_project_id_webhook_policies_policy_id_delete_with_http_info(project_id, policy_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete webhook policy of a project This endpoint is aimed to delete webhookpolicy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2380

def projects_project_id_webhook_policies_policy_id_delete_with_http_info(project_id, policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_policy_id_delete ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_delete"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_delete"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies/{policy_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'policy_id' + '}', policy_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_policy_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_policy_id_get(project_id, policy_id, opts = {}) ⇒ WebhookPolicy

Get project webhook policy This endpoint returns specified webhook policy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

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

    the optional parameters

Returns:



2428
2429
2430
2431
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2428

def projects_project_id_webhook_policies_policy_id_get(project_id, policy_id, opts = {})
  data, _status_code, _headers = projects_project_id_webhook_policies_policy_id_get_with_http_info(project_id, policy_id, opts)
  data
end

#projects_project_id_webhook_policies_policy_id_get_with_http_info(project_id, policy_id, opts = {}) ⇒ Array<(WebhookPolicy, Fixnum, Hash)>

Get project webhook policy This endpoint returns specified webhook policy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

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

    the optional parameters

Returns:

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

    WebhookPolicy data, response status code and response headers



2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2439

def projects_project_id_webhook_policies_policy_id_get_with_http_info(project_id, policy_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_policy_id_get ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_get"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_get"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies/{policy_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'policy_id' + '}', policy_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'WebhookPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_policy_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_policy_id_put(project_id, policy_id, policy, opts = {}) ⇒ nil

Update webhook policy of a project. This endpoint is aimed to update the webhook policy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

  • policy —

    All properties needed except &quot;id&quot;, &quot;project_id&quot;, &quot;creation_time&quot;, &quot;update_time&quot;.

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

    the optional parameters

Returns:

  • (nil) 


2489
2490
2491
2492
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2489

def projects_project_id_webhook_policies_policy_id_put(project_id, policy_id, policy, opts = {})
  projects_project_id_webhook_policies_policy_id_put_with_http_info(project_id, policy_id, policy, opts)
  nil
end

#projects_project_id_webhook_policies_policy_id_put_with_http_info(project_id, policy_id, policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update webhook policy of a project. This endpoint is aimed to update the webhook policy of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy_id —

    The id of webhook policy.

  • policy —

    All properties needed except &quot;id&quot;, &quot;project_id&quot;, &quot;creation_time&quot;, &quot;update_time&quot;.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2501

def projects_project_id_webhook_policies_policy_id_put_with_http_info(project_id, policy_id, policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_policy_id_put ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_put"
  end
  # verify the required parameter 'policy_id' is set
  if @api_client.config.client_side_validation && policy_id.nil?
    fail ArgumentError, "Missing the required parameter 'policy_id' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_put"
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.projects_project_id_webhook_policies_policy_id_put"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies/{policy_id}'.sub('{' + 'project_id' + '}', project_id.to_s).sub('{' + 'policy_id' + '}', policy_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_policy_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_post(project_id, policy, opts = {}) ⇒ nil

Create project webhook policy. This endpoint create a webhook policy if the project does not have one.

Parameters:

  • project_id —

    Relevant project ID

  • policy —

    Properties &quot;targets&quot; and &quot;event_types&quot; needed.

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

    the optional parameters

Returns:

  • (nil) 


2553
2554
2555
2556
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2553

def projects_project_id_webhook_policies_post(project_id, policy, opts = {})
  projects_project_id_webhook_policies_post_with_http_info(project_id, policy, opts)
  nil
end

#projects_project_id_webhook_policies_post_with_http_info(project_id, policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create project webhook policy. This endpoint create a webhook policy if the project does not have one.

Parameters:

  • project_id —

    Relevant project ID

  • policy —

    Properties &quot;targets&quot; and &quot;event_types&quot; needed.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2564

def projects_project_id_webhook_policies_post_with_http_info(project_id, policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_post"
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.projects_project_id_webhook_policies_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#projects_project_id_webhook_policies_test_post(project_id, policy, opts = {}) ⇒ nil

Test project webhook connection This endpoint tests webhook connection of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy —

    Only property &quot;targets&quot; needed.

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

    the optional parameters

Returns:

  • (nil) 


2612
2613
2614
2615
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2612

def projects_project_id_webhook_policies_test_post(project_id, policy, opts = {})
  projects_project_id_webhook_policies_test_post_with_http_info(project_id, policy, opts)
  nil
end

#projects_project_id_webhook_policies_test_post_with_http_info(project_id, policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test project webhook connection This endpoint tests webhook connection of a project.

Parameters:

  • project_id —

    Relevant project ID.

  • policy —

    Only property &quot;targets&quot; needed.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2623

def projects_project_id_webhook_policies_test_post_with_http_info(project_id, policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.projects_project_id_webhook_policies_test_post ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling ProductsApi.projects_project_id_webhook_policies_test_post"
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.projects_project_id_webhook_policies_test_post"
  end
  # resource path
  local_var_path = '/projects/{project_id}/webhook/policies/test'.sub('{' + 'project_id' + '}', project_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#projects_project_id_webhook_policies_test_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_get(opts = {}) ⇒ Array<Quota>

List quotas List quotas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reference (String) —

    The reference type of quota.

  • :reference_id (String) —

    The reference id of quota.

  • :sort (String) —

    Sort method, valid values include: &#39;hard.resource_name&#39;, &#39;-hard.resource_name&#39;, &#39;used.resource_name&#39;, &#39;-used.resource_name&#39;. Here &#39;-&#39; stands for descending order, resource_name should be the real resource name of the quota.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page, default is 10, maximum is 100.

Returns:



2674
2675
2676
2677
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2674

def quotas_get(opts = {})
  data, _status_code, _headers = quotas_get_with_http_info(opts)
  data
end

#quotas_get_with_http_info(opts = {}) ⇒ Array<(Array<Quota>, Fixnum, Hash)>

List quotas List quotas

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reference (String) —

    The reference type of quota.

  • :reference_id (String) —

    The reference id of quota.

  • :sort (String) —

    Sort method, valid values include: &#39;hard.resource_name&#39;, &#39;-hard.resource_name&#39;, &#39;used.resource_name&#39;, &#39;-used.resource_name&#39;. Here &#39;-&#39; stands for descending order, resource_name should be the real resource name of the quota.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page, default is 10, maximum is 100.

Returns:

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

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



2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2688

def quotas_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.quotas_get ...'
  end
  # resource path
  local_var_path = '/quotas'

  # query parameters
  query_params = {}
  query_params[:'reference'] = opts[:'reference'] if !opts[:'reference'].nil?
  query_params[:'reference_id'] = opts[:'reference_id'] if !opts[:'reference_id'].nil?
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<Quota>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#quotas_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_id_get(id, opts = {}) ⇒ Quota

Get the specified quota Get the specified quota

Parameters:

  • id —

    Quota ID

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

    the optional parameters

Returns:



2733
2734
2735
2736
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2733

def quotas_id_get(id, opts = {})
  data, _status_code, _headers = quotas_id_get_with_http_info(id, opts)
  data
end

#quotas_id_get_with_http_info(id, opts = {}) ⇒ Array<(Quota, Fixnum, Hash)>

Get the specified quota Get the specified quota

Parameters:

  • id —

    Quota ID

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

    the optional parameters

Returns:

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

    Quota data, response status code and response headers



2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2743

def quotas_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.quotas_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.quotas_id_get"
  end
  # resource path
  local_var_path = '/quotas/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'Quota')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#quotas_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#quotas_id_put(id, hard, opts = {}) ⇒ nil

Update the specified quota Update hard limits of the specified quota

Parameters:

  • id —

    Quota ID

  • hard —

    The new hard limits for the quota

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

    the optional parameters

Returns:

  • (nil) 


2788
2789
2790
2791
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2788

def quotas_id_put(id, hard, opts = {})
  quotas_id_put_with_http_info(id, hard, opts)
  nil
end

#quotas_id_put_with_http_info(id, hard, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the specified quota Update hard limits of the specified quota

Parameters:

  • id —

    Quota ID

  • hard —

    The new hard limits for the quota

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2799

def quotas_id_put_with_http_info(id, hard, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.quotas_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.quotas_id_put"
  end
  # verify the required parameter 'hard' is set
  if @api_client.config.client_side_validation && hard.nil?
    fail ArgumentError, "Missing the required parameter 'hard' when calling ProductsApi.quotas_id_put"
  end
  # resource path
  local_var_path = '/quotas/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(hard)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#quotas_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_get(opts = {}) ⇒ Array<Registry>

List registries. List registries according to the query.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Deprecated, use &#x60;q&#x60; instead.

  • :q (String) —

    Query string to query resources. Supported query patterns are &quot;exact match(k&#x3D;v)&quot;, &quot;fuzzy match(k&#x3D;~v)&quot;, &quot;range(k&#x3D;)&quot;, &quot;list with union releationship(k&#x3D;v2 v3)&quot; and &quot;list with intersetion relationship(k&#x3D;(v1 v2 v3))&quot;. The value of range and list can be string(enclosed by &quot; or &#39;), integer or time(in format &quot;2020-04-09 02:36:00&quot;). All of these query patterns should be put in the query string &quot;q&#x3D;xxx&quot; and splitted by &quot;,&quot;. e.g. q&#x3D;k1&#x3D;v1,k2&#x3D;~v2,k3&#x3D;

Returns:



2847
2848
2849
2850
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2847

def registries_get(opts = {})
  data, _status_code, _headers = registries_get_with_http_info(opts)
  data
end

#registries_get_with_http_info(opts = {}) ⇒ Array<(Array<Registry>, Fixnum, Hash)>

List registries. List registries according to the query.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    Deprecated, use &#x60;q&#x60; instead.

  • :q (String) —

    Query string to query resources. Supported query patterns are &quot;exact match(k&#x3D;v)&quot;, &quot;fuzzy match(k&#x3D;~v)&quot;, &quot;range(k&#x3D;)&quot;, &quot;list with union releationship(k&#x3D;v2 v3)&quot; and &quot;list with intersetion relationship(k&#x3D;(v1 v2 v3))&quot;. The value of range and list can be string(enclosed by &quot; or &#39;), integer or time(in format &quot;2020-04-09 02:36:00&quot;). All of these query patterns should be put in the query string &quot;q&#x3D;xxx&quot; and splitted by &quot;,&quot;. e.g. q&#x3D;k1&#x3D;v1,k2&#x3D;~v2,k3&#x3D;

Returns:

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

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



2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2858

def registries_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_get ...'
  end
  # resource path
  local_var_path = '/registries'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<Registry>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_id_delete(id, opts = {}) ⇒ nil

Delete specific registry. This endpoint is for to delete specific registry.

Parameters:

  • id —

    The registry&#39;s ID.

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

    the optional parameters

Returns:

  • (nil) 


2900
2901
2902
2903
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2900

def registries_id_delete(id, opts = {})
  registries_id_delete_with_http_info(id, opts)
  nil
end

#registries_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete specific registry. This endpoint is for to delete specific registry.

Parameters:

  • id —

    The registry&#39;s ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2910

def registries_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.registries_id_delete"
  end
  # resource path
  local_var_path = '/registries/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_id_get(id, opts = {}) ⇒ Registry

Get registry. This endpoint is for get specific registry.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Returns:



2953
2954
2955
2956
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2953

def registries_id_get(id, opts = {})
  data, _status_code, _headers = registries_id_get_with_http_info(id, opts)
  data
end

#registries_id_get_with_http_info(id, opts = {}) ⇒ Array<(Registry, Fixnum, Hash)>

Get registry. This endpoint is for get specific registry.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Returns:

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

    Registry data, response status code and response headers



2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 2963

def registries_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.registries_id_get"
  end
  # resource path
  local_var_path = '/registries/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'Registry')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_id_info_get(id, opts = {}) ⇒ RegistryInfo

Get registry info. Get the info of one specific registry.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Returns:



3007
3008
3009
3010
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3007

def registries_id_info_get(id, opts = {})
  data, _status_code, _headers = registries_id_info_get_with_http_info(id, opts)
  data
end

#registries_id_info_get_with_http_info(id, opts = {}) ⇒ Array<(RegistryInfo, Fixnum, Hash)>

Get registry info. Get the info of one specific registry.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Returns:

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

    RegistryInfo data, response status code and response headers



3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3017

def registries_id_info_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_id_info_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.registries_id_info_get"
  end
  # resource path
  local_var_path = '/registries/{id}/info'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'RegistryInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_id_info_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_id_namespace_get(id, opts = {}) ⇒ Array<Namespace>

List namespaces of registry This endpoint let user list namespaces of registry according to query.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The name of namespace.

Returns:



3062
3063
3064
3065
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3062

def registries_id_namespace_get(id, opts = {})
  data, _status_code, _headers = registries_id_namespace_get_with_http_info(id, opts)
  data
end

#registries_id_namespace_get_with_http_info(id, opts = {}) ⇒ Array<(Array<Namespace>, Fixnum, Hash)>

List namespaces of registry This endpoint let user list namespaces of registry according to query.

Parameters:

  • id —

    The registry ID.

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The name of namespace.

Returns:

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

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



3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3073

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

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<Namespace>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_id_namespace_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_id_put(id, repo_target, opts = {}) ⇒ nil

Update a given registry. This endpoint is for update a given registry.

Parameters:

  • id —

    The registry&#39;s ID.

  • repo_target —

    Updates registry.

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

    the optional parameters

Returns:

  • (nil) 


3119
3120
3121
3122
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3119

def registries_id_put(id, repo_target, opts = {})
  registries_id_put_with_http_info(id, repo_target, opts)
  nil
end

#registries_id_put_with_http_info(id, repo_target, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a given registry. This endpoint is for update a given registry.

Parameters:

  • id —

    The registry&#39;s ID.

  • repo_target —

    Updates registry.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3130

def registries_id_put_with_http_info(id, repo_target, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.registries_id_put"
  end
  # verify the required parameter 'repo_target' is set
  if @api_client.config.client_side_validation && repo_target.nil?
    fail ArgumentError, "Missing the required parameter 'repo_target' when calling ProductsApi.registries_id_put"
  end
  # resource path
  local_var_path = '/registries/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(repo_target)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_ping_post(registry, opts = {}) ⇒ nil

Ping status of a registry. This endpoint checks status of a registry, the registry can be given by ID or URL (together with credential)

Parameters:

  • registry —

    Registry to ping.

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

    the optional parameters

Returns:

  • (nil) 


3177
3178
3179
3180
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3177

def registries_ping_post(registry, opts = {})
  registries_ping_post_with_http_info(registry, opts)
  nil
end

#registries_ping_post_with_http_info(registry, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Ping status of a registry. This endpoint checks status of a registry, the registry can be given by ID or URL (together with credential)

Parameters:

  • registry —

    Registry to ping.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3187

def registries_ping_post_with_http_info(registry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_ping_post ...'
  end
  # verify the required parameter 'registry' is set
  if @api_client.config.client_side_validation && registry.nil?
    fail ArgumentError, "Missing the required parameter 'registry' when calling ProductsApi.registries_ping_post"
  end
  # resource path
  local_var_path = '/registries/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(registry)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#registries_post(registry, opts = {}) ⇒ nil

Create a new registry. This endpoint is for user to create a new registry.

Parameters:

  • registry —

    New created registry.

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

    the optional parameters

Returns:

  • (nil) 


3230
3231
3232
3233
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3230

def registries_post(registry, opts = {})
  registries_post_with_http_info(registry, opts)
  nil
end

#registries_post_with_http_info(registry, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a new registry. This endpoint is for user to create a new registry.

Parameters:

  • registry —

    New created registry.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3240

def registries_post_with_http_info(registry, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.registries_post ...'
  end
  # verify the required parameter 'registry' is set
  if @api_client.config.client_side_validation && registry.nil?
    fail ArgumentError, "Missing the required parameter 'registry' when calling ProductsApi.registries_post"
  end
  # resource path
  local_var_path = '/registries'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(registry)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#registries_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_adapters_get(opts = {}) ⇒ Array<String>

List supported adapters. This endpoint let user list supported adapters.

Parameters:

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

    the optional parameters

Returns:

  • (Array<String>) 


3282
3283
3284
3285
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3282

def replication_adapters_get(opts = {})
  data, _status_code, _headers = replication_adapters_get_with_http_info(opts)
  data
end

#replication_adapters_get_with_http_info(opts = {}) ⇒ Array<(Array<String>, Fixnum, Hash)>

List supported adapters. This endpoint let user list supported adapters.

Parameters:

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

    the optional parameters

Returns:

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

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



3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3291

def replication_adapters_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_adapters_get ...'
  end
  # resource path
  local_var_path = '/replication/adapters'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<String>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_adapters_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_get(opts = {}) ⇒ Array<ReplicationExecution>

List replication executions. This endpoint let user list replication executions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :policy_id (Integer) —

    The policy ID.

  • :status (String) —

    The execution status.

  • :trigger (String) —

    The trigger mode.

  • :page (Integer) —

    The page.

  • :page_size (Integer) —

    The page size.

Returns:



3335
3336
3337
3338
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3335

def replication_executions_get(opts = {})
  data, _status_code, _headers = replication_executions_get_with_http_info(opts)
  data
end

#replication_executions_get_with_http_info(opts = {}) ⇒ Array<(Array<ReplicationExecution>, Fixnum, Hash)>

List replication executions. This endpoint let user list replication executions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :policy_id (Integer) —

    The policy ID.

  • :status (String) —

    The execution status.

  • :trigger (String) —

    The trigger mode.

  • :page (Integer) —

    The page.

  • :page_size (Integer) —

    The page size.

Returns:

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

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



3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3349

def replication_executions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_get ...'
  end
  # resource path
  local_var_path = '/replication/executions'

  # query parameters
  query_params = {}
  query_params[:'policy_id'] = opts[:'policy_id'] if !opts[:'policy_id'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'trigger'] = opts[:'trigger'] if !opts[:'trigger'].nil?
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<ReplicationExecution>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_id_get(id, opts = {}) ⇒ ReplicationExecution

Get the execution of the replication. This endpoint is for user to get one execution of the replication.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:



3394
3395
3396
3397
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3394

def replication_executions_id_get(id, opts = {})
  data, _status_code, _headers = replication_executions_id_get_with_http_info(id, opts)
  data
end

#replication_executions_id_get_with_http_info(id, opts = {}) ⇒ Array<(ReplicationExecution, Fixnum, Hash)>

Get the execution of the replication. This endpoint is for user to get one execution of the replication.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:

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

    ReplicationExecution data, response status code and response headers



3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3404

def replication_executions_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_executions_id_get"
  end
  # resource path
  local_var_path = '/replication/executions/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ReplicationExecution')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_id_put(id, opts = {}) ⇒ nil

Stop the execution of the replication. This endpoint is for user to stop one execution of the replication.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:

  • (nil) 


3448
3449
3450
3451
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3448

def replication_executions_id_put(id, opts = {})
  replication_executions_id_put_with_http_info(id, opts)
  nil
end

#replication_executions_id_put_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Stop the execution of the replication. This endpoint is for user to stop one execution of the replication.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3458

def replication_executions_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_executions_id_put"
  end
  # resource path
  local_var_path = '/replication/executions/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_id_tasks_get(id, opts = {}) ⇒ Array<ReplicationTask>

Get the task list of one execution. This endpoint is for user to get the task list of one execution.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:



3501
3502
3503
3504
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3501

def replication_executions_id_tasks_get(id, opts = {})
  data, _status_code, _headers = replication_executions_id_tasks_get_with_http_info(id, opts)
  data
end

#replication_executions_id_tasks_get_with_http_info(id, opts = {}) ⇒ Array<(Array<ReplicationTask>, Fixnum, Hash)>

Get the task list of one execution. This endpoint is for user to get the task list of one execution.

Parameters:

  • id —

    The execution ID.

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

    the optional parameters

Returns:

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

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



3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3511

def replication_executions_id_tasks_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_id_tasks_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_executions_id_tasks_get"
  end
  # resource path
  local_var_path = '/replication/executions/{id}/tasks'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<ReplicationTask>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_id_tasks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_id_tasks_task_id_log_get(id, task_id, opts = {}) ⇒ nil

Get the log of one task. This endpoint is for user to get the log of one task.

Parameters:

  • id —

    The execution ID.

  • task_id —

    The task ID.

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

    the optional parameters

Returns:

  • (nil) 


3556
3557
3558
3559
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3556

def replication_executions_id_tasks_task_id_log_get(id, task_id, opts = {})
  replication_executions_id_tasks_task_id_log_get_with_http_info(id, task_id, opts)
  nil
end

#replication_executions_id_tasks_task_id_log_get_with_http_info(id, task_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get the log of one task. This endpoint is for user to get the log of one task.

Parameters:

  • id —

    The execution ID.

  • task_id —

    The task ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3567

def replication_executions_id_tasks_task_id_log_get_with_http_info(id, task_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_id_tasks_task_id_log_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_executions_id_tasks_task_id_log_get"
  end
  # verify the required parameter 'task_id' is set
  if @api_client.config.client_side_validation && task_id.nil?
    fail ArgumentError, "Missing the required parameter 'task_id' when calling ProductsApi.replication_executions_id_tasks_task_id_log_get"
  end
  # resource path
  local_var_path = '/replication/executions/{id}/tasks/{task_id}/log'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'task_id' + '}', task_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_id_tasks_task_id_log_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_executions_post(execution, opts = {}) ⇒ nil

Start one execution of the replication. This endpoint is for user to start one execution of the replication.

Parameters:

  • execution —

    The execution that needs to be started, only the property &quot;policy_id&quot; is needed.

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

    the optional parameters

Returns:

  • (nil) 


3614
3615
3616
3617
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3614

def replication_executions_post(execution, opts = {})
  replication_executions_post_with_http_info(execution, opts)
  nil
end

#replication_executions_post_with_http_info(execution, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Start one execution of the replication. This endpoint is for user to start one execution of the replication.

Parameters:

  • execution —

    The execution that needs to be started, only the property &quot;policy_id&quot; is needed.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3624

def replication_executions_post_with_http_info(execution, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_executions_post ...'
  end
  # verify the required parameter 'execution' is set
  if @api_client.config.client_side_validation && execution.nil?
    fail ArgumentError, "Missing the required parameter 'execution' when calling ProductsApi.replication_executions_post"
  end
  # resource path
  local_var_path = '/replication/executions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(execution)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_executions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_policies_get(opts = {}) ⇒ Array<ReplicationPolicy>

List replication policies This endpoint let user list replication policies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The replication policy name.

  • :page (Integer) —

    The page nubmer.

  • :page_size (Integer) —

    The size of per page.

Returns:



3669
3670
3671
3672
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3669

def replication_policies_get(opts = {})
  data, _status_code, _headers = replication_policies_get_with_http_info(opts)
  data
end

#replication_policies_get_with_http_info(opts = {}) ⇒ Array<(Array<ReplicationPolicy>, Fixnum, Hash)>

List replication policies This endpoint let user list replication policies

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :name (String) —

    The replication policy name.

  • :page (Integer) —

    The page nubmer.

  • :page_size (Integer) —

    The size of per page.

Returns:

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

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



3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3681

def replication_policies_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_policies_get ...'
  end
  # resource path
  local_var_path = '/replication/policies'

  # query parameters
  query_params = {}
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<ReplicationPolicy>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_policies_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_policies_id_delete(id, opts = {}) ⇒ nil

Delete the replication policy specified by ID. Delete the replication policy specified by ID.

Parameters:

  • id —

    Replication policy ID

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

    the optional parameters

Returns:

  • (nil) 


3724
3725
3726
3727
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3724

def replication_policies_id_delete(id, opts = {})
  replication_policies_id_delete_with_http_info(id, opts)
  nil
end

#replication_policies_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete the replication policy specified by ID. Delete the replication policy specified by ID.

Parameters:

  • id —

    Replication policy ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3734

def replication_policies_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_policies_id_delete ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_policies_id_delete"
  end
  # resource path
  local_var_path = '/replication/policies/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_policies_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_policies_id_get(id, opts = {}) ⇒ ReplicationPolicy

Get replication policy. This endpoint let user get replication policy by specific ID.

Parameters:

  • id —

    policy ID

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

    the optional parameters

Returns:



3777
3778
3779
3780
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3777

def replication_policies_id_get(id, opts = {})
  data, _status_code, _headers = replication_policies_id_get_with_http_info(id, opts)
  data
end

#replication_policies_id_get_with_http_info(id, opts = {}) ⇒ Array<(ReplicationPolicy, Fixnum, Hash)>

Get replication policy. This endpoint let user get replication policy by specific ID.

Parameters:

  • id —

    policy ID

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

    the optional parameters

Returns:

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

    ReplicationPolicy data, response status code and response headers



3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3787

def replication_policies_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_policies_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_policies_id_get"
  end
  # resource path
  local_var_path = '/replication/policies/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ReplicationPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_policies_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_policies_id_put(id, policy, opts = {}) ⇒ nil

Update the replication policy This endpoint let user update policy.

Parameters:

  • id —

    policy ID

  • policy —

    The replication policy model.

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

    the optional parameters

Returns:

  • (nil) 


3832
3833
3834
3835
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3832

def replication_policies_id_put(id, policy, opts = {})
  replication_policies_id_put_with_http_info(id, policy, opts)
  nil
end

#replication_policies_id_put_with_http_info(id, policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the replication policy This endpoint let user update policy.

Parameters:

  • id —

    policy ID

  • policy —

    The replication policy model.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3843

def replication_policies_id_put_with_http_info(id, policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_policies_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.replication_policies_id_put"
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.replication_policies_id_put"
  end
  # resource path
  local_var_path = '/replication/policies/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_policies_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#replication_policies_post(policy, opts = {}) ⇒ nil

Create a replication policy This endpoint let user create a replication policy

Parameters:

  • policy —

    The policy model.

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

    the optional parameters

Returns:

  • (nil) 


3890
3891
3892
3893
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3890

def replication_policies_post(policy, opts = {})
  replication_policies_post_with_http_info(policy, opts)
  nil
end

#replication_policies_post_with_http_info(policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a replication policy This endpoint let user create a replication policy

Parameters:

  • policy —

    The policy model.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3900

def replication_policies_post_with_http_info(policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.replication_policies_post ...'
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.replication_policies_post"
  end
  # resource path
  local_var_path = '/replication/policies'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#replication_policies_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_executions_eid_patch(id, eid, action, opts = {}) ⇒ nil

Stop a Retention job Stop a Retention job, only support "stop" action now.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

  • action —

    The action, only support &quot;stop&quot; now.

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

    the optional parameters

Returns:

  • (nil) 


3945
3946
3947
3948
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3945

def retentions_id_executions_eid_patch(id, eid, action, opts = {})
  retentions_id_executions_eid_patch_with_http_info(id, eid, action, opts)
  nil
end

#retentions_id_executions_eid_patch_with_http_info(id, eid, action, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Stop a Retention job Stop a Retention job, only support &quot;stop&quot; action now.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

  • action —

    The action, only support &quot;stop&quot; now.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 3957

def retentions_id_executions_eid_patch_with_http_info(id, eid, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_executions_eid_patch ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_executions_eid_patch"
  end
  # verify the required parameter 'eid' is set
  if @api_client.config.client_side_validation && eid.nil?
    fail ArgumentError, "Missing the required parameter 'eid' when calling ProductsApi.retentions_id_executions_eid_patch"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling ProductsApi.retentions_id_executions_eid_patch"
  end
  # resource path
  local_var_path = '/retentions/{id}/executions/{eid}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'eid' + '}', eid.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(action)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_executions_eid_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_executions_eid_tasks_get(id, eid, opts = {}) ⇒ Array<RetentionExecutionTask>

Get Retention job tasks Get Retention job tasks, each repository as a task.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

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

    the optional parameters

Returns:



4009
4010
4011
4012
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4009

def retentions_id_executions_eid_tasks_get(id, eid, opts = {})
  data, _status_code, _headers = retentions_id_executions_eid_tasks_get_with_http_info(id, eid, opts)
  data
end

#retentions_id_executions_eid_tasks_get_with_http_info(id, eid, opts = {}) ⇒ Array<(Array<RetentionExecutionTask>, Fixnum, Hash)>

Get Retention job tasks Get Retention job tasks, each repository as a task.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

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

    the optional parameters

Returns:

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

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



4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4020

def retentions_id_executions_eid_tasks_get_with_http_info(id, eid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_executions_eid_tasks_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_executions_eid_tasks_get"
  end
  # verify the required parameter 'eid' is set
  if @api_client.config.client_side_validation && eid.nil?
    fail ArgumentError, "Missing the required parameter 'eid' when calling ProductsApi.retentions_id_executions_eid_tasks_get"
  end
  # resource path
  local_var_path = '/retentions/{id}/executions/{eid}/tasks'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'eid' + '}', eid.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<RetentionExecutionTask>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_executions_eid_tasks_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_executions_eid_tasks_tid_get(id, eid, tid, opts = {}) ⇒ String

Get Retention job task log Get Retention job task log, tags ratain or deletion detail will be shown in a table.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

  • tid —

    Retention execution ID.

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

    the optional parameters

Returns:

  • (String) 


4070
4071
4072
4073
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4070

def retentions_id_executions_eid_tasks_tid_get(id, eid, tid, opts = {})
  data, _status_code, _headers = retentions_id_executions_eid_tasks_tid_get_with_http_info(id, eid, tid, opts)
  data
end

#retentions_id_executions_eid_tasks_tid_get_with_http_info(id, eid, tid, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get Retention job task log Get Retention job task log, tags ratain or deletion detail will be shown in a table.

Parameters:

  • id —

    Retention ID.

  • eid —

    Retention execution ID.

  • tid —

    Retention execution ID.

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4082

def retentions_id_executions_eid_tasks_tid_get_with_http_info(id, eid, tid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_executions_eid_tasks_tid_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_executions_eid_tasks_tid_get"
  end
  # verify the required parameter 'eid' is set
  if @api_client.config.client_side_validation && eid.nil?
    fail ArgumentError, "Missing the required parameter 'eid' when calling ProductsApi.retentions_id_executions_eid_tasks_tid_get"
  end
  # verify the required parameter 'tid' is set
  if @api_client.config.client_side_validation && tid.nil?
    fail ArgumentError, "Missing the required parameter 'tid' when calling ProductsApi.retentions_id_executions_eid_tasks_tid_get"
  end
  # resource path
  local_var_path = '/retentions/{id}/executions/{eid}/tasks/{tid}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'eid' + '}', eid.to_s).sub('{' + 'tid' + '}', tid.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_executions_eid_tasks_tid_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_executions_get(id, opts = {}) ⇒ Array<RetentionExecution>

Get a Retention job Get a Retention job, job status may be delayed before job service schedule it up.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:



4134
4135
4136
4137
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4134

def retentions_id_executions_get(id, opts = {})
  data, _status_code, _headers = retentions_id_executions_get_with_http_info(id, opts)
  data
end

#retentions_id_executions_get_with_http_info(id, opts = {}) ⇒ Array<(Array<RetentionExecution>, Fixnum, Hash)>

Get a Retention job Get a Retention job, job status may be delayed before job service schedule it up.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

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

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



4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4144

def retentions_id_executions_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_executions_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_executions_get"
  end
  # resource path
  local_var_path = '/retentions/{id}/executions'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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<RetentionExecution>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_executions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_executions_post(id, action, opts = {}) ⇒ nil

Trigger a Retention job Trigger a Retention job, if dry_run is True, nothing would be deleted actually.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

  • (nil) 


4189
4190
4191
4192
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4189

def retentions_id_executions_post(id, action, opts = {})
  retentions_id_executions_post_with_http_info(id, action, opts)
  nil
end

#retentions_id_executions_post_with_http_info(id, action, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Trigger a Retention job Trigger a Retention job, if dry_run is True, nothing would be deleted actually.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4200

def retentions_id_executions_post_with_http_info(id, action, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_executions_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_executions_post"
  end
  # verify the required parameter 'action' is set
  if @api_client.config.client_side_validation && action.nil?
    fail ArgumentError, "Missing the required parameter 'action' when calling ProductsApi.retentions_id_executions_post"
  end
  # resource path
  local_var_path = '/retentions/{id}/executions'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(action)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_executions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_get(id, opts = {}) ⇒ RetentionPolicy

Get Retention Policy Get Retention Policy.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:



4247
4248
4249
4250
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4247

def retentions_id_get(id, opts = {})
  data, _status_code, _headers = retentions_id_get_with_http_info(id, opts)
  data
end

#retentions_id_get_with_http_info(id, opts = {}) ⇒ Array<(RetentionPolicy, Fixnum, Hash)>

Get Retention Policy Get Retention Policy.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

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

    RetentionPolicy data, response status code and response headers



4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4257

def retentions_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_get"
  end
  # resource path
  local_var_path = '/retentions/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'RetentionPolicy')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_id_put(id, policy, opts = {}) ⇒ nil

Update Retention Policy Update Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when retention policy has already binded to project.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

  • (nil) 


4302
4303
4304
4305
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4302

def retentions_id_put(id, policy, opts = {})
  retentions_id_put_with_http_info(id, policy, opts)
  nil
end

#retentions_id_put_with_http_info(id, policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update Retention Policy Update Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when retention policy has already binded to project.

Parameters:

  • id —

    Retention ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4313

def retentions_id_put_with_http_info(id, policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_id_put ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.retentions_id_put"
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.retentions_id_put"
  end
  # resource path
  local_var_path = '/retentions/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_metadatas_get(opts = {}) ⇒ RetentionMetadata

Get Retention Metadatas Get Retention Metadatas.

Parameters:

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

    the optional parameters

Returns:



4359
4360
4361
4362
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4359

def retentions_metadatas_get(opts = {})
  data, _status_code, _headers = retentions_metadatas_get_with_http_info(opts)
  data
end

#retentions_metadatas_get_with_http_info(opts = {}) ⇒ Array<(RetentionMetadata, Fixnum, Hash)>

Get Retention Metadatas Get Retention Metadatas.

Parameters:

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

    the optional parameters

Returns:

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

    RetentionMetadata data, response status code and response headers



4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4368

def retentions_metadatas_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_metadatas_get ...'
  end
  # resource path
  local_var_path = '/retentions/metadatas'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'RetentionMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_metadatas_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retentions_post(policy, opts = {}) ⇒ nil

Create Retention Policy Create Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when no retention policy binded to project yet.

Parameters:

  • policy —

    Create Retention Policy successfully.

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

    the optional parameters

Returns:

  • (nil) 


4408
4409
4410
4411
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4408

def retentions_post(policy, opts = {})
  retentions_post_with_http_info(policy, opts)
  nil
end

#retentions_post_with_http_info(policy, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create Retention Policy Create Retention Policy, you can reference metadatas API for the policy model. You can check project metadatas to find whether a retention policy is already binded. This method should only be called when no retention policy binded to project yet.

Parameters:

  • policy —

    Create Retention Policy successfully.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4418

def retentions_post_with_http_info(policy, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.retentions_post ...'
  end
  # verify the required parameter 'policy' is set
  if @api_client.config.client_side_validation && policy.nil?
    fail ArgumentError, "Missing the required parameter 'policy' when calling ProductsApi.retentions_post"
  end
  # resource path
  local_var_path = '/retentions'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(policy)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#retentions_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scanners_get(opts = {}) ⇒ Array<ScannerRegistration>

List scanner registrations Returns a list of currently configured scanner registrations.

Parameters:

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

    the optional parameters

Returns:



4460
4461
4462
4463
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4460

def scanners_get(opts = {})
  data, _status_code, _headers = scanners_get_with_http_info(opts)
  data
end

#scanners_get_with_http_info(opts = {}) ⇒ Array<(Array<ScannerRegistration>, Fixnum, Hash)>

List scanner registrations Returns a list of currently configured scanner registrations.

Parameters:

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

    the optional parameters

Returns:

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

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



4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4469

def scanners_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scanners_get ...'
  end
  # resource path
  local_var_path = '/scanners'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<ScannerRegistration>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scanners_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scanners_ping_post(settings, opts = {}) ⇒ nil

Tests scanner registration settings Pings scanner adapter to test endpoint URL and authorization settings.

Parameters:

  • settings —

    A scanner registration settings to be tested.

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

    the optional parameters

Returns:

  • (nil) 


4509
4510
4511
4512
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4509

def scanners_ping_post(settings, opts = {})
  scanners_ping_post_with_http_info(settings, opts)
  nil
end

#scanners_ping_post_with_http_info(settings, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Tests scanner registration settings Pings scanner adapter to test endpoint URL and authorization settings.

Parameters:

  • settings —

    A scanner registration settings to be tested.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4519

def scanners_ping_post_with_http_info(settings, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scanners_ping_post ...'
  end
  # verify the required parameter 'settings' is set
  if @api_client.config.client_side_validation && settings.nil?
    fail ArgumentError, "Missing the required parameter 'settings' when calling ProductsApi.scanners_ping_post"
  end
  # resource path
  local_var_path = '/scanners/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(settings)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scanners_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scanners_registration_id_get(registration_id, opts = {}) ⇒ ScannerRegistration

Get a scanner registration details Retruns the details of the specified scanner registration.

Parameters:

  • registration_id —

    The scanner registration identifer.

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

    the optional parameters

Returns:



4562
4563
4564
4565
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4562

def scanners_registration_id_get(registration_id, opts = {})
  data, _status_code, _headers = scanners_registration_id_get_with_http_info(registration_id, opts)
  data
end

#scanners_registration_id_get_with_http_info(registration_id, opts = {}) ⇒ Array<(ScannerRegistration, Fixnum, Hash)>

Get a scanner registration details Retruns the details of the specified scanner registration.

Parameters:

  • registration_id —

    The scanner registration identifer.

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

    the optional parameters

Returns:

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

    ScannerRegistration data, response status code and response headers



4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4572

def scanners_registration_id_get_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scanners_registration_id_get ...'
  end
  # verify the required parameter 'registration_id' is set
  if @api_client.config.client_side_validation && registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling ProductsApi.scanners_registration_id_get"
  end
  # resource path
  local_var_path = '/scanners/{registration_id}'.sub('{' + 'registration_id' + '}', registration_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ScannerRegistration')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scanners_registration_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scanners_registration_id_metadata_get(registration_id, opts = {}) ⇒ ScannerAdapterMetadata

Get the metadata of the specified scanner registration Get the metadata of the specified scanner registration, including the capabilities and customzied properties.

Parameters:

  • registration_id —

    The scanner registration identifier.

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

    the optional parameters

Returns:



4616
4617
4618
4619
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4616

def scanners_registration_id_metadata_get(registration_id, opts = {})
  data, _status_code, _headers = scanners_registration_id_metadata_get_with_http_info(registration_id, opts)
  data
end

#scanners_registration_id_metadata_get_with_http_info(registration_id, opts = {}) ⇒ Array<(ScannerAdapterMetadata, Fixnum, Hash)>

Get the metadata of the specified scanner registration Get the metadata of the specified scanner registration, including the capabilities and customzied properties.

Parameters:

  • registration_id —

    The scanner registration identifier.

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

    the optional parameters

Returns:

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

    ScannerAdapterMetadata data, response status code and response headers



4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4626

def scanners_registration_id_metadata_get_with_http_info(registration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scanners_registration_id_metadata_get ...'
  end
  # verify the required parameter 'registration_id' is set
  if @api_client.config.client_side_validation && registration_id.nil?
    fail ArgumentError, "Missing the required parameter 'registration_id' when calling ProductsApi.scanners_registration_id_metadata_get"
  end
  # resource path
  local_var_path = '/scanners/{registration_id}/metadata'.sub('{' + 'registration_id' + '}', registration_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'ScannerAdapterMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scanners_registration_id_metadata_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scans_all_metrics_get(opts = {}) ⇒ Stats

Get the metrics of the latest scan all process Get the metrics of the latest scan all process

Parameters:

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

    the optional parameters

Returns:



4669
4670
4671
4672
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4669

def scans_all_metrics_get(opts = {})
  data, _status_code, _headers = scans_all_metrics_get_with_http_info(opts)
  data
end

#scans_all_metrics_get_with_http_info(opts = {}) ⇒ Array<(Stats, Fixnum, Hash)>

Get the metrics of the latest scan all process Get the metrics of the latest scan all process

Parameters:

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

    the optional parameters

Returns:

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

    Stats data, response status code and response headers



4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4678

def scans_all_metrics_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scans_all_metrics_get ...'
  end
  # resource path
  local_var_path = '/scans/all/metrics'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'Stats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scans_all_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#scans_schedule_metrics_get(opts = {}) ⇒ Stats

Get the metrics of the latest scheduled scan all process Get the metrics of the latest scheduled scan all process

Parameters:

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

    the optional parameters

Returns:



4717
4718
4719
4720
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4717

def scans_schedule_metrics_get(opts = {})
  data, _status_code, _headers = scans_schedule_metrics_get_with_http_info(opts)
  data
end

#scans_schedule_metrics_get_with_http_info(opts = {}) ⇒ Array<(Stats, Fixnum, Hash)>

Get the metrics of the latest scheduled scan all process Get the metrics of the latest scheduled scan all process

Parameters:

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

    the optional parameters

Returns:

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

    Stats data, response status code and response headers



4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4726

def scans_schedule_metrics_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.scans_schedule_metrics_get ...'
  end
  # resource path
  local_var_path = '/scans/schedule/metrics'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'Stats')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#scans_schedule_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_get(q, opts = {}) ⇒ Array<Search>

Search for projects, repositories and helm charts The Search endpoint returns information about the projects ,repositories and helm charts offered at public status or related to the current logged in user. The response includes the project, repository list and charts in a proper display order.

Parameters:

  • q —

    Search parameter for project and repository name.

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

    the optional parameters

Returns:



4766
4767
4768
4769
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4766

def search_get(q, opts = {})
  data, _status_code, _headers = search_get_with_http_info(q, opts)
  data
end

#search_get_with_http_info(q, opts = {}) ⇒ Array<(Array<Search>, Fixnum, Hash)>

Search for projects, repositories and helm charts The Search endpoint returns information about the projects ,repositories and helm charts offered at public status or related to the current logged in user. The response includes the project, repository list and charts in a proper display order.

Parameters:

  • q —

    Search parameter for project and repository name.

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

    the optional parameters

Returns:

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

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



4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4776

def search_get_with_http_info(q, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.search_get ...'
  end
  # verify the required parameter 'q' is set
  if @api_client.config.client_side_validation && q.nil?
    fail ArgumentError, "Missing the required parameter 'q' when calling ProductsApi.search_get"
  end
  # resource path
  local_var_path = '/search'

  # query parameters
  query_params = {}
  query_params[:'q'] = q

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<Search>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#statistics_get(opts = {}) ⇒ StatisticMap

Get projects number and repositories number relevant to the user This endpoint is aimed to statistic all of the projects number and repositories number relevant to the logined user, also the public projects number and repositories number. If the user is admin, he can also get total projects number and total repositories number.

Parameters:

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

    the optional parameters

Returns:



4820
4821
4822
4823
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4820

def statistics_get(opts = {})
  data, _status_code, _headers = statistics_get_with_http_info(opts)
  data
end

#statistics_get_with_http_info(opts = {}) ⇒ Array<(StatisticMap, Fixnum, Hash)>

Get projects number and repositories number relevant to the user This endpoint is aimed to statistic all of the projects number and repositories number relevant to the logined user, also the public projects number and repositories number. If the user is admin, he can also get total projects number and total repositories number.

Parameters:

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

    the optional parameters

Returns:

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

    StatisticMap data, response status code and response headers



4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4829

def statistics_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.statistics_get ...'
  end
  # resource path
  local_var_path = '/statistics'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'StatisticMap')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#statistics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_cve_allowlist_get(opts = {}) ⇒ CVEAllowlist

Get the system level allowlist of CVE. Get the system level allowlist of CVE. This API can be called by all authenticated users.

Parameters:

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

    the optional parameters

Returns:



4868
4869
4870
4871
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4868

def system_cve_allowlist_get(opts = {})
  data, _status_code, _headers = system_cve_allowlist_get_with_http_info(opts)
  data
end

#system_cve_allowlist_get_with_http_info(opts = {}) ⇒ Array<(CVEAllowlist, Fixnum, Hash)>

Get the system level allowlist of CVE. Get the system level allowlist of CVE. This API can be called by all authenticated users.

Parameters:

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

    the optional parameters

Returns:

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

    CVEAllowlist data, response status code and response headers



4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4877

def system_cve_allowlist_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_cve_allowlist_get ...'
  end
  # resource path
  local_var_path = '/system/CVEAllowlist'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'CVEAllowlist')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_cve_allowlist_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_cve_allowlist_put(opts = {}) ⇒ nil

Update the system level allowlist of CVE. This API overwrites the system level allowlist of CVE with the list in request body. Only system Admin has permission to call this API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :allowlist (CVEAllowlist) —

    The allowlist with new content

Returns:

  • (nil) 


4917
4918
4919
4920
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4917

def system_cve_allowlist_put(opts = {})
  system_cve_allowlist_put_with_http_info(opts)
  nil
end

#system_cve_allowlist_put_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update the system level allowlist of CVE. This API overwrites the system level allowlist of CVE with the list in request body. Only system Admin has permission to call this API.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :allowlist (CVEAllowlist) —

    The allowlist with new content

Returns:

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

    nil, response status code and response headers



4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4927

def system_cve_allowlist_put_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_cve_allowlist_put ...'
  end
  # resource path
  local_var_path = '/system/CVEAllowlist'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'allowlist'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_cve_allowlist_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_get(opts = {}) ⇒ Array<GCResult>

Get gc results. This endpoint let user get latest ten gc results.

Parameters:

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

    the optional parameters

Returns:



4965
4966
4967
4968
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4965

def system_gc_get(opts = {})
  data, _status_code, _headers = system_gc_get_with_http_info(opts)
  data
end

#system_gc_get_with_http_info(opts = {}) ⇒ Array<(Array<GCResult>, Fixnum, Hash)>

Get gc results. This endpoint let user get latest ten gc results.

Parameters:

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

    the optional parameters

Returns:

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

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



4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 4974

def system_gc_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_get ...'
  end
  # resource path
  local_var_path = '/system/gc'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<GCResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_id_get(id, opts = {}) ⇒ GCResult

Get gc status. This endpoint let user get gc status filtered by specific ID.

Parameters:

  • id —

    Relevant job ID

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

    the optional parameters

Returns:



5014
5015
5016
5017
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5014

def system_gc_id_get(id, opts = {})
  data, _status_code, _headers = system_gc_id_get_with_http_info(id, opts)
  data
end

#system_gc_id_get_with_http_info(id, opts = {}) ⇒ Array<(GCResult, Fixnum, Hash)>

Get gc status. This endpoint let user get gc status filtered by specific ID.

Parameters:

  • id —

    Relevant job ID

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

    the optional parameters

Returns:

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

    GCResult data, response status code and response headers



5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5024

def system_gc_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.system_gc_id_get"
  end
  # resource path
  local_var_path = '/system/gc/{id}'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'GCResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_id_log_get(id, opts = {}) ⇒ String

Get gc job log. This endpoint let user get gc job logs filtered by specific ID.

Parameters:

  • id —

    Relevant job ID

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

    the optional parameters

Returns:

  • (String) 


5068
5069
5070
5071
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5068

def system_gc_id_log_get(id, opts = {})
  data, _status_code, _headers = system_gc_id_log_get_with_http_info(id, opts)
  data
end

#system_gc_id_log_get_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Get gc job log. This endpoint let user get gc job logs filtered by specific ID.

Parameters:

  • id —

    Relevant job ID

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5078

def system_gc_id_log_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_id_log_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling ProductsApi.system_gc_id_log_get"
  end
  # resource path
  local_var_path = '/system/gc/{id}/log'.sub('{' + 'id' + '}', id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_id_log_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_schedule_get(opts = {}) ⇒ AdminJobSchedule

Get gc’s schedule. This endpoint is for get schedule of gc job.

Parameters:

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

    the optional parameters

Returns:



5121
5122
5123
5124
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5121

def system_gc_schedule_get(opts = {})
  data, _status_code, _headers = system_gc_schedule_get_with_http_info(opts)
  data
end

#system_gc_schedule_get_with_http_info(opts = {}) ⇒ Array<(AdminJobSchedule, Fixnum, Hash)>

Get gc&#39;s schedule. This endpoint is for get schedule of gc job.

Parameters:

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

    the optional parameters

Returns:

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

    AdminJobSchedule data, response status code and response headers



5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5130

def system_gc_schedule_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_schedule_get ...'
  end
  # resource path
  local_var_path = '/system/gc/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'AdminJobSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_schedule_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_schedule_post(schedule, opts = {}) ⇒ nil

Create a gc schedule. This endpoint is for update gc schedule.

Parameters:

  • schedule —

    Updates of gc&#39;s schedule.

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

    the optional parameters

Returns:

  • (nil) 


5170
5171
5172
5173
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5170

def system_gc_schedule_post(schedule, opts = {})
  system_gc_schedule_post_with_http_info(schedule, opts)
  nil
end

#system_gc_schedule_post_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a gc schedule. This endpoint is for update gc schedule.

Parameters:

  • schedule —

    Updates of gc&#39;s schedule.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5180

def system_gc_schedule_post_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_schedule_post ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ProductsApi.system_gc_schedule_post"
  end
  # resource path
  local_var_path = '/system/gc/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(schedule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_schedule_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_gc_schedule_put(schedule, opts = {}) ⇒ nil

Update gc’s schedule. This endpoint is for update gc schedule.

Parameters:

  • schedule —

    Updates of gc&#39;s schedule.

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

    the optional parameters

Returns:

  • (nil) 


5223
5224
5225
5226
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5223

def system_gc_schedule_put(schedule, opts = {})
  system_gc_schedule_put_with_http_info(schedule, opts)
  nil
end

#system_gc_schedule_put_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update gc&#39;s schedule. This endpoint is for update gc schedule.

Parameters:

  • schedule —

    Updates of gc&#39;s schedule.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5233

def system_gc_schedule_put_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_gc_schedule_put ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ProductsApi.system_gc_schedule_put"
  end
  # resource path
  local_var_path = '/system/gc/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(schedule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_gc_schedule_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_oidc_ping_post(endpoint, opts = {}) ⇒ nil

Test the OIDC endpoint. Test the OIDC endpoint, the setting of the endpoint is provided in the request. This API can only be called by system admin.

Parameters:

  • endpoint —

    Request body for OIDC endpoint to be tested.

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

    the optional parameters

Returns:

  • (nil) 


5276
5277
5278
5279
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5276

def system_oidc_ping_post(endpoint, opts = {})
  system_oidc_ping_post_with_http_info(endpoint, opts)
  nil
end

#system_oidc_ping_post_with_http_info(endpoint, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Test the OIDC endpoint. Test the OIDC endpoint, the setting of the endpoint is provided in the request. This API can only be called by system admin.

Parameters:

  • endpoint —

    Request body for OIDC endpoint to be tested.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5286

def system_oidc_ping_post_with_http_info(endpoint, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_oidc_ping_post ...'
  end
  # verify the required parameter 'endpoint' is set
  if @api_client.config.client_side_validation && endpoint.nil?
    fail ArgumentError, "Missing the required parameter 'endpoint' when calling ProductsApi.system_oidc_ping_post"
  end
  # resource path
  local_var_path = '/system/oidc/ping'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(endpoint)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_oidc_ping_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_scan_all_schedule_get(opts = {}) ⇒ AdminJobSchedule

Get scan_all’s schedule. This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.

Parameters:

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

    the optional parameters

Returns:



5328
5329
5330
5331
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5328

def system_scan_all_schedule_get(opts = {})
  data, _status_code, _headers = system_scan_all_schedule_get_with_http_info(opts)
  data
end

#system_scan_all_schedule_get_with_http_info(opts = {}) ⇒ Array<(AdminJobSchedule, Fixnum, Hash)>

Get scan_all&#39;s schedule. This endpoint is for getting a schedule for the scan all job, which scans all of images in Harbor.

Parameters:

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

    the optional parameters

Returns:

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

    AdminJobSchedule data, response status code and response headers



5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5337

def system_scan_all_schedule_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_scan_all_schedule_get ...'
  end
  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'AdminJobSchedule')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_scan_all_schedule_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_scan_all_schedule_post(schedule, opts = {}) ⇒ nil

Create a schedule or a manual trigger for the scan all job. This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Create a schedule or a manual trigger for the scan all job.

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

    the optional parameters

Returns:

  • (nil) 


5377
5378
5379
5380
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5377

def system_scan_all_schedule_post(schedule, opts = {})
  system_scan_all_schedule_post_with_http_info(schedule, opts)
  nil
end

#system_scan_all_schedule_post_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create a schedule or a manual trigger for the scan all job. This endpoint is for creating a schedule or a manual trigger for the scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Create a schedule or a manual trigger for the scan all job.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5387

def system_scan_all_schedule_post_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_scan_all_schedule_post ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ProductsApi.system_scan_all_schedule_post"
  end
  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(schedule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_scan_all_schedule_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_scan_all_schedule_put(schedule, opts = {}) ⇒ nil

Update scan all’s schedule. This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Updates the schedule of scan all job, which scans all of images in Harbor.

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

    the optional parameters

Returns:

  • (nil) 


5430
5431
5432
5433
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5430

def system_scan_all_schedule_put(schedule, opts = {})
  system_scan_all_schedule_put_with_http_info(schedule, opts)
  nil
end

#system_scan_all_schedule_put_with_http_info(schedule, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update scan all&#39;s schedule. This endpoint is for updating the schedule of scan all job, which scans all of images in Harbor.

Parameters:

  • schedule —

    Updates the schedule of scan all job, which scans all of images in Harbor.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5440

def system_scan_all_schedule_put_with_http_info(schedule, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.system_scan_all_schedule_put ...'
  end
  # verify the required parameter 'schedule' is set
  if @api_client.config.client_side_validation && schedule.nil?
    fail ArgumentError, "Missing the required parameter 'schedule' when calling ProductsApi.system_scan_all_schedule_put"
  end
  # resource path
  local_var_path = '/system/scanAll/schedule'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(schedule)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#system_scan_all_schedule_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#systeminfo_get(opts = {}) ⇒ GeneralInfo

Get general system info This API is for retrieving general system info, this can be called by anonymous request.

Parameters:

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

    the optional parameters

Returns:



5482
5483
5484
5485
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5482

def systeminfo_get(opts = {})
  data, _status_code, _headers = systeminfo_get_with_http_info(opts)
  data
end

#systeminfo_get_with_http_info(opts = {}) ⇒ Array<(GeneralInfo, Fixnum, Hash)>

Get general system info This API is for retrieving general system info, this can be called by anonymous request.

Parameters:

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

    the optional parameters

Returns:

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

    GeneralInfo data, response status code and response headers



5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5491

def systeminfo_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.systeminfo_get ...'
  end
  # resource path
  local_var_path = '/systeminfo'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'GeneralInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#systeminfo_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#systeminfo_getcert_get(opts = {}) ⇒ nil

Get default root certificate. This endpoint is for downloading a default root certificate.

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


5530
5531
5532
5533
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5530

def systeminfo_getcert_get(opts = {})
  systeminfo_getcert_get_with_http_info(opts)
  nil
end

#systeminfo_getcert_get_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Get default root certificate. This endpoint is for downloading a default root certificate.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5539

def systeminfo_getcert_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.systeminfo_getcert_get ...'
  end
  # resource path
  local_var_path = '/systeminfo/getcert'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#systeminfo_getcert_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#systeminfo_volumes_get(opts = {}) ⇒ SystemInfo

Get system volume info (total/free size). This endpoint is for retrieving system volume info that only provides for admin user.

Parameters:

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

    the optional parameters

Returns:



5577
5578
5579
5580
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5577

def systeminfo_volumes_get(opts = {})
  data, _status_code, _headers = systeminfo_volumes_get_with_http_info(opts)
  data
end

#systeminfo_volumes_get_with_http_info(opts = {}) ⇒ Array<(SystemInfo, Fixnum, Hash)>

Get system volume info (total/free size). This endpoint is for retrieving system volume info that only provides for admin user.

Parameters:

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

    the optional parameters

Returns:

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

    SystemInfo data, response status code and response headers



5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5586

def systeminfo_volumes_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.systeminfo_volumes_get ...'
  end
  # resource path
  local_var_path = '/systeminfo/volumes'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'SystemInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#systeminfo_volumes_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usergroups_get(opts = {}) ⇒ Array<UserGroup>

Get all user groups information Get all user groups information

Parameters:

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

    the optional parameters

Returns:



5625
5626
5627
5628
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5625

def usergroups_get(opts = {})
  data, _status_code, _headers = usergroups_get_with_http_info(opts)
  data
end

#usergroups_get_with_http_info(opts = {}) ⇒ Array<(Array<UserGroup>, Fixnum, Hash)>

Get all user groups information Get all user groups information

Parameters:

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

    the optional parameters

Returns:

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

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



5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5634

def usergroups_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.usergroups_get ...'
  end
  # resource path
  local_var_path = '/usergroups'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<UserGroup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#usergroups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usergroups_group_id_delete(group_id, opts = {}) ⇒ nil

Delete user group Delete user group

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


5674
5675
5676
5677
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5674

def usergroups_group_id_delete(group_id, opts = {})
  usergroups_group_id_delete_with_http_info(group_id, opts)
  nil
end

#usergroups_group_id_delete_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete user group Delete user group

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5684

def usergroups_group_id_delete_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.usergroups_group_id_delete ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ProductsApi.usergroups_group_id_delete"
  end
  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#usergroups_group_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usergroups_group_id_get(group_id, opts = {}) ⇒ UserGroup

Get user group information Get user group information

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:



5727
5728
5729
5730
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5727

def usergroups_group_id_get(group_id, opts = {})
  data, _status_code, _headers = usergroups_group_id_get_with_http_info(group_id, opts)
  data
end

#usergroups_group_id_get_with_http_info(group_id, opts = {}) ⇒ Array<(UserGroup, Fixnum, Hash)>

Get user group information Get user group information

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Returns:

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

    UserGroup data, response status code and response headers



5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5737

def usergroups_group_id_get_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.usergroups_group_id_get ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ProductsApi.usergroups_group_id_get"
  end
  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'UserGroup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#usergroups_group_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usergroups_group_id_put(group_id, opts = {}) ⇒ nil

Update group information Update user group information

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5782
5783
5784
5785
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5782

def usergroups_group_id_put(group_id, opts = {})
  usergroups_group_id_put_with_http_info(group_id, opts)
  nil
end

#usergroups_group_id_put_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update group information Update user group information

Parameters:

  • group_id —

    Group ID

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5793

def usergroups_group_id_put_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.usergroups_group_id_put ...'
  end
  # verify the required parameter 'group_id' is set
  if @api_client.config.client_side_validation && group_id.nil?
    fail ArgumentError, "Missing the required parameter 'group_id' when calling ProductsApi.usergroups_group_id_put"
  end
  # resource path
  local_var_path = '/usergroups/{group_id}'.sub('{' + 'group_id' + '}', group_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'usergroup'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#usergroups_group_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#usergroups_post(opts = {}) ⇒ nil

Create user group Create user group information

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


5836
5837
5838
5839
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5836

def usergroups_post(opts = {})
  usergroups_post_with_http_info(opts)
  nil
end

#usergroups_post_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create user group Create user group information

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5846

def usergroups_post_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.usergroups_post ...'
  end
  # resource path
  local_var_path = '/usergroups'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(opts[:'usergroup'])
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#usergroups_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_current_get(opts = {}) ⇒ User

Get current user info. This endpoint is to get the current user information.

Parameters:

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

    the optional parameters

Returns:



5884
5885
5886
5887
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5884

def users_current_get(opts = {})
  data, _status_code, _headers = users_current_get_with_http_info(opts)
  data
end

#users_current_get_with_http_info(opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get current user info. This endpoint is to get the current user information.

Parameters:

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5893

def users_current_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_current_get ...'
  end
  # resource path
  local_var_path = '/users/current'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_current_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_current_permissions_get(opts = {}) ⇒ Array<Permission>

Get current user permissions. This endpoint is to get the current user permissions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (String) —

    Get permissions of the scope

  • :relative (BOOLEAN) —

    If true, the resources in the response are relative to the scope, eg for resource &#39;/project/1/repository&#39; if relative is &#39;true&#39; then the resource in response will be &#39;repository&#39;.

Returns:



5934
5935
5936
5937
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5934

def users_current_permissions_get(opts = {})
  data, _status_code, _headers = users_current_permissions_get_with_http_info(opts)
  data
end

#users_current_permissions_get_with_http_info(opts = {}) ⇒ Array<(Array<Permission>, Fixnum, Hash)>

Get current user permissions. This endpoint is to get the current user permissions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :scope (String) —

    Get permissions of the scope

  • :relative (BOOLEAN) —

    If true, the resources in the response are relative to the scope, eg for resource &#39;/project/1/repository&#39; if relative is &#39;true&#39; then the resource in response will be &#39;repository&#39;.

Returns:

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

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



5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5945

def users_current_permissions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_current_permissions_get ...'
  end
  # resource path
  local_var_path = '/users/current/permissions'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = ['basicAuth']
  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<Permission>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_current_permissions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_get(opts = {}) ⇒ Array<User>

Get registered users of Harbor. This endpoint is for user to search registered users, support for filtering results with username.Notice, by now this operation is only for administrator.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :username (String) —

    Username for filtering results.

  • :email (String) —

    Email for filtering results.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page.

Returns:



5990
5991
5992
5993
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 5990

def users_get(opts = {})
  data, _status_code, _headers = users_get_with_http_info(opts)
  data
end

#users_get_with_http_info(opts = {}) ⇒ Array<(Array<User>, Fixnum, Hash)>

Get registered users of Harbor. This endpoint is for user to search registered users, support for filtering results with username.Notice, by now this operation is only for administrator.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :username (String) —

    Username for filtering results.

  • :email (String) —

    Email for filtering results.

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page.

Returns:

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

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



6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6003

def users_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_get ...'
  end
  # resource path
  local_var_path = '/users'

  # query parameters
  query_params = {}
  query_params[:'username'] = opts[:'username'] if !opts[:'username'].nil?
  query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<User>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_post(user, opts = {}) ⇒ nil

Creates a new user account. This endpoint is to create a user if the user does not already exist.

Parameters:

  • user —

    New created user.

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

    the optional parameters

Returns:

  • (nil) 


6047
6048
6049
6050
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6047

def users_post(user, opts = {})
  users_post_with_http_info(user, opts)
  nil
end

#users_post_with_http_info(user, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Creates a new user account. This endpoint is to create a user if the user does not already exist.

Parameters:

  • user —

    New created user.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6057

def users_post_with_http_info(user, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_post ...'
  end
  # verify the required parameter 'user' is set
  if @api_client.config.client_side_validation && user.nil?
    fail ArgumentError, "Missing the required parameter 'user' when calling ProductsApi.users_post"
  end
  # resource path
  local_var_path = '/users'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/plain'])
  # 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 = @api_client.object_to_http_body(user)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_search_get(username, opts = {}) ⇒ Array<UserSearch>

Search users by username This endpoint is to search the users by username.

Parameters:

  • username —

    Username for filtering results.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page.

Returns:



6102
6103
6104
6105
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6102

def users_search_get(username, opts = {})
  data, _status_code, _headers = users_search_get_with_http_info(username, opts)
  data
end

#users_search_get_with_http_info(username, opts = {}) ⇒ Array<(Array<UserSearch>, Fixnum, Hash)>

Search users by username This endpoint is to search the users by username.

Parameters:

  • username —

    Username for filtering results.

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    The page number, default is 1.

  • :page_size (Integer) —

    The size of per page.

Returns:

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

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



6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6114

def users_search_get_with_http_info(username, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_search_get ...'
  end
  # verify the required parameter 'username' is set
  if @api_client.config.client_side_validation && username.nil?
    fail ArgumentError, "Missing the required parameter 'username' when calling ProductsApi.users_search_get"
  end
  # resource path
  local_var_path = '/users/search'

  # query parameters
  query_params = {}
  query_params[:'username'] = username
  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', 'text/plain'])
  # 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 = ['basicAuth']
  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<UserSearch>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_cli_secret_put(user_id, input_secret, opts = {}) ⇒ nil

Set CLI secret for a user. This endpoint let user generate a new CLI secret for himself. This API only works when auth mode is set to ‘OIDC’. Once this API returns with successful status, the old secret will be invalid, as there will be only one CLI secret for a user.

Parameters:

  • user_id —

    User ID

  • input_secret —

    JSON object that includes the new secret

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

    the optional parameters

Returns:

  • (nil) 


6162
6163
6164
6165
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6162

def users_user_id_cli_secret_put(user_id, input_secret, opts = {})
  users_user_id_cli_secret_put_with_http_info(user_id, input_secret, opts)
  nil
end

#users_user_id_cli_secret_put_with_http_info(user_id, input_secret, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set CLI secret for a user. This endpoint let user generate a new CLI secret for himself. This API only works when auth mode is set to &#39;OIDC&#39;. Once this API returns with successful status, the old secret will be invalid, as there will be only one CLI secret for a user.

Parameters:

  • user_id —

    User ID

  • input_secret —

    JSON object that includes the new secret

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6173

def users_user_id_cli_secret_put_with_http_info(user_id, input_secret, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_cli_secret_put ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_cli_secret_put"
  end
  # verify the required parameter 'input_secret' is set
  if @api_client.config.client_side_validation && input_secret.nil?
    fail ArgumentError, "Missing the required parameter 'input_secret' when calling ProductsApi.users_user_id_cli_secret_put"
  end
  # resource path
  local_var_path = '/users/{user_id}/cli_secret'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(input_secret)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_cli_secret_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_delete(user_id, opts = {}) ⇒ nil

Mark a registered user as be removed. This endpoint let administrator of Harbor mark a registered user as be removed.It actually won’t be deleted from DB.

Parameters:

  • user_id —

    User ID for marking as to be removed.

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

    the optional parameters

Returns:

  • (nil) 


6220
6221
6222
6223
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6220

def users_user_id_delete(user_id, opts = {})
  users_user_id_delete_with_http_info(user_id, opts)
  nil
end

#users_user_id_delete_with_http_info(user_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Mark a registered user as be removed. This endpoint let administrator of Harbor mark a registered user as be removed.It actually won&#39;t be deleted from DB.

Parameters:

  • user_id —

    User ID for marking as to be removed.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6230

def users_user_id_delete_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_delete ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_delete"
  end
  # resource path
  local_var_path = '/users/{user_id}'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_get(user_id, opts = {}) ⇒ User

Get a user’s profile. Get user’s profile with user id.

Parameters:

  • user_id —

    Registered user ID

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

    the optional parameters

Returns:



6273
6274
6275
6276
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6273

def users_user_id_get(user_id, opts = {})
  data, _status_code, _headers = users_user_id_get_with_http_info(user_id, opts)
  data
end

#users_user_id_get_with_http_info(user_id, opts = {}) ⇒ Array<(User, Fixnum, Hash)>

Get a user&#39;s profile. Get user&#39;s profile with user id.

Parameters:

  • user_id —

    Registered user ID

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

    the optional parameters

Returns:

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

    User data, response status code and response headers



6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6283

def users_user_id_get_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_get ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_get"
  end
  # resource path
  local_var_path = '/users/{user_id}'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = ['basicAuth']
  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 => 'User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_password_put(user_id, password, opts = {}) ⇒ nil

Change the password on a user that already exists. This endpoint is for user to update password. Users with the admin role can change any user’s password. Guest users can change only their own password.

Parameters:

  • user_id —

    Registered user ID.

  • password —

    Password to be updated, the attribute &#39;old_password&#39; is optional when the API is called by the system administrator.

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

    the optional parameters

Returns:

  • (nil) 


6328
6329
6330
6331
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6328

def users_user_id_password_put(user_id, password, opts = {})
  users_user_id_password_put_with_http_info(user_id, password, opts)
  nil
end

#users_user_id_password_put_with_http_info(user_id, password, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Change the password on a user that already exists. This endpoint is for user to update password. Users with the admin role can change any user&#39;s password. Guest users can change only their own password.

Parameters:

  • user_id —

    Registered user ID.

  • password —

    Password to be updated, the attribute &#39;old_password&#39; is optional when the API is called by the system administrator.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6339

def users_user_id_password_put_with_http_info(user_id, password, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_password_put ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_password_put"
  end
  # verify the required parameter 'password' is set
  if @api_client.config.client_side_validation && password.nil?
    fail ArgumentError, "Missing the required parameter 'password' when calling ProductsApi.users_user_id_password_put"
  end
  # resource path
  local_var_path = '/users/{user_id}/password'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(password)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_password_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_put(user_id, profile, opts = {}) ⇒ nil

Update a registered user to change his profile. This endpoint let a registered user change his profile.

Parameters:

  • user_id —

    Registered user ID

  • profile —

    Only email, realname and comment can be modified.

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

    the optional parameters

Returns:

  • (nil) 


6387
6388
6389
6390
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6387

def users_user_id_put(user_id, profile, opts = {})
  users_user_id_put_with_http_info(user_id, profile, opts)
  nil
end

#users_user_id_put_with_http_info(user_id, profile, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a registered user to change his profile. This endpoint let a registered user change his profile.

Parameters:

  • user_id —

    Registered user ID

  • profile —

    Only email, realname and comment can be modified.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6398

def users_user_id_put_with_http_info(user_id, profile, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_put ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_put"
  end
  # verify the required parameter 'profile' is set
  if @api_client.config.client_side_validation && profile.nil?
    fail ArgumentError, "Missing the required parameter 'profile' when calling ProductsApi.users_user_id_put"
  end
  # resource path
  local_var_path = '/users/{user_id}'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(profile)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#users_user_id_sysadmin_put(user_id, sysadmin_flag, opts = {}) ⇒ nil

Update a registered user to change to be an administrator of Harbor. This endpoint let a registered user change to be an administrator of Harbor.

Parameters:

  • user_id —

    Registered user ID

  • sysadmin_flag —

    Toggle a user to admin or not.

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

    the optional parameters

Returns:

  • (nil) 


6446
6447
6448
6449
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6446

def users_user_id_sysadmin_put(user_id, sysadmin_flag, opts = {})
  users_user_id_sysadmin_put_with_http_info(user_id, sysadmin_flag, opts)
  nil
end

#users_user_id_sysadmin_put_with_http_info(user_id, sysadmin_flag, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Update a registered user to change to be an administrator of Harbor. This endpoint let a registered user change to be an administrator of Harbor.

Parameters:

  • user_id —

    Registered user ID

  • sysadmin_flag —

    Toggle a user to admin or not.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 6457

def users_user_id_sysadmin_put_with_http_info(user_id, sysadmin_flag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ProductsApi.users_user_id_sysadmin_put ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling ProductsApi.users_user_id_sysadmin_put"
  end
  # verify the required parameter 'sysadmin_flag' is set
  if @api_client.config.client_side_validation && sysadmin_flag.nil?
    fail ArgumentError, "Missing the required parameter 'sysadmin_flag' when calling ProductsApi.users_user_id_sysadmin_put"
  end
  # resource path
  local_var_path = '/users/{user_id}/sysadmin'.sub('{' + 'user_id' + '}', user_id.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', 'text/plain'])
  # 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 = @api_client.object_to_http_body(sysadmin_flag)
  auth_names = ['basicAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ProductsApi#users_user_id_sysadmin_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end