Class: Harbor2Client::SystemCVEAllowlistApi

Inherits:
Object
  • Object
show all
Defined in:
lib/harbor2_client/api/system_cve_allowlist_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SystemCVEAllowlistApi

Returns a new instance of SystemCVEAllowlistApi.



19
20
21
 
# File 'lib/harbor2_client/api/system_cve_allowlist_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_client/api/system_cve_allowlist_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_system_cve_allowlist(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

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:



27
28
29
30
 
# File 'lib/harbor2_client/api/system_cve_allowlist_api.rb', line 27

def get_system_cve_allowlist(opts = {})
  data, _status_code, _headers = get_system_cve_allowlist_with_http_info(opts)
  data
end

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

Options Hash (opts):

  • :x_request_id (String) —

    An unique ID for the request

Returns:

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

    CVEAllowlist data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/harbor2_client/api/system_cve_allowlist_api.rb', line 37

def get_system_cve_allowlist_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemCVEAllowlistApi.get_system_cve_allowlist ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling SystemCVEAllowlistApi.get_system_cve_allowlist, the character length must be great than or equal to 1.'
  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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

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

#put_system_cve_allowlist(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):

  • :x_request_id (String) —

    An unique ID for the request

  • :allowlist (CVEAllowlist) —

    The allowlist with new content

Returns:

  • (nil) 


83
84
85
86
 
# File 'lib/harbor2_client/api/system_cve_allowlist_api.rb', line 83

def put_system_cve_allowlist(opts = {})
  put_system_cve_allowlist_with_http_info(opts)
  nil
end

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

  • :x_request_id (String) —

    An unique ID for the request

  • :allowlist (CVEAllowlist) —

    The allowlist with new content

Returns:

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

    nil, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/harbor2_client/api/system_cve_allowlist_api.rb', line 94

def put_system_cve_allowlist_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemCVEAllowlistApi.put_system_cve_allowlist ...'
  end
  if @api_client.config.client_side_validation && !opts[:'x_request_id'].nil? && opts[:'x_request_id'].to_s.length < 1
    fail ArgumentError, 'invalid value for "opts[:"x_request_id"]" when calling SystemCVEAllowlistApi.put_system_cve_allowlist, the character length must be great than or equal to 1.'
  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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'X-Request-Id'] = opts[:'x_request_id'] if !opts[:'x_request_id'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'allowlist'])
  auth_names = ['basic']
  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: SystemCVEAllowlistApi#put_system_cve_allowlist\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end