Class: DatadogAPIClient::V2::CodeCoverageAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/code_coverage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ CodeCoverageAPI

Returns a new instance of CodeCoverageAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#get_code_coverage_branch_summary(body, opts = {}) ⇒ Object

Get code coverage summary for a branch.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 29

def get_code_coverage_branch_summary(body, opts = {})
  data, _status_code, _headers = get_code_coverage_branch_summary_with_http_info(body, opts)
  data
end

#get_code_coverage_branch_summary_with_http_info(body, opts = {}) ⇒ Array<(CoverageSummaryResponse, Integer, Hash)>

Get code coverage summary for a branch.

Retrieve aggregated code coverage statistics for a specific branch in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner.

Parameters:

Returns:

  • (Array<(CoverageSummaryResponse, Integer, Hash)>) —

    CoverageSummaryResponse data, response status code and response headers



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
92
93
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 43

def get_code_coverage_branch_summary_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CodeCoverageAPI.get_code_coverage_branch_summary ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CodeCoverageAPI.get_code_coverage_branch_summary"
  end
  # resource path
  local_var_path = '/api/v2/code-coverage/branch/summary'

  # 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[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CoverageSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_code_coverage_branch_summary,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_code_coverage_commit_summary(body, opts = {}) ⇒ Object

Get code coverage summary for a commit.

See Also:



98
99
100
101
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 98

def get_code_coverage_commit_summary(body, opts = {})
  data, _status_code, _headers = get_code_coverage_commit_summary_with_http_info(body, opts)
  data
end

#get_code_coverage_commit_summary_with_http_info(body, opts = {}) ⇒ Array<(CoverageSummaryResponse, Integer, Hash)>

Get code coverage summary for a commit.

Retrieve aggregated code coverage statistics for a specific commit in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner.

The commit SHA must be a 40-character hexadecimal string (SHA-1 hash).

Parameters:

Returns:

  • (Array<(CoverageSummaryResponse, Integer, Hash)>) —

    CoverageSummaryResponse data, response status code and response headers



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
158
159
160
161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 114

def get_code_coverage_commit_summary_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CodeCoverageAPI.get_code_coverage_commit_summary ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CodeCoverageAPI.get_code_coverage_commit_summary"
  end
  # resource path
  local_var_path = '/api/v2/code-coverage/commit/summary'

  # 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[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CoverageSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_code_coverage_commit_summary,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_code_coverage_files(body, opts = {}) ⇒ Object

Get per-file code coverage data.

See Also:



169
170
171
172
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 169

def get_code_coverage_files(body, opts = {})
  data, _status_code, _headers = get_code_coverage_files_with_http_info(body, opts)
  data
end

#get_code_coverage_files_with_http_info(body, opts = {}) ⇒ Array<(FilesCoverageResponse, Integer, Hash)>

Get per-file code coverage data.

Retrieve per-file code coverage data for a specific commit, branch, or pull request. Exactly one of commit_sha, branch, or pr_number must be provided. Optionally filter by service, codeowner, or flag (at most one).

Parameters:

Returns:

  • (Array<(FilesCoverageResponse, Integer, Hash)>) —

    FilesCoverageResponse data, response status code and response headers



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
229
230
231
232
233
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 183

def get_code_coverage_files_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CodeCoverageAPI.get_code_coverage_files ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CodeCoverageAPI.get_code_coverage_files"
  end
  # resource path
  local_var_path = '/api/v2/code-coverage/files'

  # 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[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'FilesCoverageResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_code_coverage_files,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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

#get_code_coverage_pr_summary(body, opts = {}) ⇒ Object

Get code coverage summary for a pull request.

See Also:



238
239
240
241
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 238

def get_code_coverage_pr_summary(body, opts = {})
  data, _status_code, _headers = get_code_coverage_pr_summary_with_http_info(body, opts)
  data
end

#get_code_coverage_pr_summary_with_http_info(body, opts = {}) ⇒ Array<(CoverageSummaryResponse, Integer, Hash)>

Get code coverage summary for a pull request.

Retrieve aggregated code coverage statistics for a specific pull request in a repository. This endpoint provides overall coverage metrics as well as breakdowns by service and code owner.

Parameters:

Returns:

  • (Array<(CoverageSummaryResponse, Integer, Hash)>) —

    CoverageSummaryResponse data, response status code and response headers



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
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/datadog_api_client/v2/api/code_coverage_api.rb', line 252

def get_code_coverage_pr_summary_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CodeCoverageAPI.get_code_coverage_pr_summary ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling CodeCoverageAPI.get_code_coverage_pr_summary"
  end
  # resource path
  local_var_path = '/api/v2/code-coverage/pr/summary'

  # 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[:debug_body] || @api_client.object_to_http_body(body)

  # return_type
  return_type = opts[:debug_return_type] || 'CoverageSummaryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_code_coverage_pr_summary,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

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