class DependencyTracker::FindingApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/dependency-tracker-client/api/finding_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
export_findings_by_project(uuid, opts = {})
click to toggle source
Returns a the findings for the specified project as FPF @param uuid [String] @param [Hash] opts the optional parameters @return [nil]
# File lib/dependency-tracker-client/api/finding_api.rb, line 26 def export_findings_by_project(uuid, opts = {}) export_findings_by_project_with_http_info(uuid, opts) nil end
export_findings_by_project_with_http_info(uuid, opts = {})
click to toggle source
Returns a the findings for the specified project as FPF @param uuid [String] @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/dependency-tracker-client/api/finding_api.rb, line 35 def export_findings_by_project_with_http_info(uuid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FindingApi.export_findings_by_project ...' end # verify the required parameter 'uuid' is set if @api_client.config.client_side_validation && uuid.nil? fail ArgumentError, "Missing the required parameter 'uuid' when calling FindingApi.export_findings_by_project" end # resource path local_var_path = '/v1/finding/project/{uuid}/export'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] # 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: FindingApi#export_findings_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
get_findings_by_project(uuid, opts = {})
click to toggle source
Returns a list of all findings for a specific project @param uuid [String] @param [Hash] opts the optional parameters @return [Array<Finding>]
# File lib/dependency-tracker-client/api/finding_api.rb, line 84 def get_findings_by_project(uuid, opts = {}) data, _status_code, _headers = get_findings_by_project_with_http_info(uuid, opts) data end
get_findings_by_project_with_http_info(uuid, opts = {})
click to toggle source
Returns a list of all findings for a specific project @param uuid [String] @param [Hash] opts the optional parameters @return [Array<(Array<Finding>, Integer, Hash)>] Array<Finding> data, response status code and response headers
# File lib/dependency-tracker-client/api/finding_api.rb, line 93 def get_findings_by_project_with_http_info(uuid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FindingApi.get_findings_by_project ...' end # verify the required parameter 'uuid' is set if @api_client.config.client_side_validation && uuid.nil? fail ArgumentError, "Missing the required parameter 'uuid' when calling FindingApi.get_findings_by_project" end # resource path local_var_path = '/v1/finding/project/{uuid}'.sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'Array<Finding>' # 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: FindingApi#get_findings_by_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end