Class: DependencyTracker::AnalysisApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dependency-tracker-client/api/analysis_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalysisApi 



19
20
21
 
# File 'lib/dependency-tracker-client/api/analysis_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/dependency-tracker-client/api/analysis_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#retrieve_analysis(component, vulnerability, opts = {}) ⇒ Analysis

Retrieves an analysis trail

Options Hash (opts):

  • :project (String) —

    The UUID of the project



28
29
30
31
 
# File 'lib/dependency-tracker-client/api/analysis_api.rb', line 28

def retrieve_analysis(component, vulnerability, opts = {})
  data, _status_code, _headers = retrieve_analysis_with_http_info(component, vulnerability, opts)
  data
end

#retrieve_analysis_with_http_info(component, vulnerability, opts = {}) ⇒ Array<(Analysis, Integer, Hash)>

Retrieves an analysis trail

Options Hash (opts):

  • :project (String) —

    The UUID of the project



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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/dependency-tracker-client/api/analysis_api.rb', line 39

def retrieve_analysis_with_http_info(component, vulnerability, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalysisApi.retrieve_analysis ...'
  end
  # verify the required parameter 'component' is set
  if @api_client.config.client_side_validation && component.nil?
    fail ArgumentError, "Missing the required parameter 'component' when calling AnalysisApi.retrieve_analysis"
  end
  # verify the required parameter 'vulnerability' is set
  if @api_client.config.client_side_validation && vulnerability.nil?
    fail ArgumentError, "Missing the required parameter 'vulnerability' when calling AnalysisApi.retrieve_analysis"
  end
  # resource path
  local_var_path = '/v1/analysis'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'component'] = component
  query_params[:'vulnerability'] = vulnerability
  query_params[:'project'] = opts[:'project'] if !opts[:'project'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] 

  # return_type
  return_type = opts[:return_type] || 'Analysis' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalysisApi#retrieve_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_analysis(opts = {}) ⇒ Analysis

Records an analysis decision

Options Hash (opts):



97
98
99
100
 
# File 'lib/dependency-tracker-client/api/analysis_api.rb', line 97

def update_analysis(opts = {})
  data, _status_code, _headers = update_analysis_with_http_info(opts)
  data
end

#update_analysis_with_http_info(opts = {}) ⇒ Array<(Analysis, Integer, Hash)>

Records an analysis decision

Options Hash (opts):



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/dependency-tracker-client/api/analysis_api.rb', line 106

def update_analysis_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalysisApi.update_analysis ...'
  end
  # resource path
  local_var_path = '/v1/analysis'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  # return_type
  return_type = opts[:return_type] || 'Analysis' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalysisApi#update_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_global_analysis(opts = {}) ⇒ Analysis

Records an analysis decision

Options Hash (opts):



155
156
157
158
 
# File 'lib/dependency-tracker-client/api/analysis_api.rb', line 155

def update_global_analysis(opts = {})
  data, _status_code, _headers = update_global_analysis_with_http_info(opts)
  data
end

#update_global_analysis_with_http_info(opts = {}) ⇒ Array<(Analysis, Integer, Hash)>

Records an analysis decision

Options Hash (opts):



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

def update_global_analysis_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AnalysisApi.update_global_analysis ...'
  end
  # resource path
  local_var_path = '/v1/analysis/global'

  # query parameters
  query_params = opts[:query_params] || {}

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

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body']) 

  # return_type
  return_type = opts[:return_type] || 'Analysis' 

  # auth_names
  auth_names = opts[:auth_names] || ['X-Api-Key']

  new_options = opts.merge(
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AnalysisApi#update_global_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end