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

#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) 


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

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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/harbor2_legacy_client/api/products_api.rb', line 244

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