Skip to content

Commit 7471661

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Add new endpoints for Code Coverage summary information (#3481)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent f87325c commit 7471661

23 files changed

+3402
-0
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 324 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7297,6 +7297,51 @@ components:
72977297
data:
72987298
$ref: '#/components/schemas/BillingDimensionsMappingBody'
72997299
type: object
7300+
BranchCoverageSummaryRequest:
7301+
description: Request object for getting code coverage summary for a branch.
7302+
properties:
7303+
data:
7304+
$ref: '#/components/schemas/BranchCoverageSummaryRequestData'
7305+
required:
7306+
- data
7307+
type: object
7308+
BranchCoverageSummaryRequestAttributes:
7309+
description: Attributes for requesting code coverage summary for a branch.
7310+
properties:
7311+
branch:
7312+
description: The branch name.
7313+
example: prod
7314+
minLength: 1
7315+
type: string
7316+
repository_id:
7317+
description: The repository identifier.
7318+
example: github.com/datadog/shopist
7319+
minLength: 1
7320+
type: string
7321+
required:
7322+
- repository_id
7323+
- branch
7324+
type: object
7325+
BranchCoverageSummaryRequestData:
7326+
description: Data object for branch summary request.
7327+
properties:
7328+
attributes:
7329+
$ref: '#/components/schemas/BranchCoverageSummaryRequestAttributes'
7330+
type:
7331+
$ref: '#/components/schemas/BranchCoverageSummaryRequestType'
7332+
required:
7333+
- type
7334+
- attributes
7335+
type: object
7336+
BranchCoverageSummaryRequestType:
7337+
description: JSON:API type for branch coverage summary request. The value must
7338+
always be `ci_app_coverage_branch_summary_request`.
7339+
enum:
7340+
- ci_app_coverage_branch_summary_request
7341+
example: ci_app_coverage_branch_summary_request
7342+
type: string
7343+
x-enum-varnames:
7344+
- CI_APP_COVERAGE_BRANCH_SUMMARY_REQUEST
73007345
Budget:
73017346
description: A budget.
73027347
properties:
@@ -11760,6 +11805,51 @@ components:
1176011805
required:
1176111806
- location
1176211807
type: object
11808+
CommitCoverageSummaryRequest:
11809+
description: Request object for getting code coverage summary for a commit.
11810+
properties:
11811+
data:
11812+
$ref: '#/components/schemas/CommitCoverageSummaryRequestData'
11813+
required:
11814+
- data
11815+
type: object
11816+
CommitCoverageSummaryRequestAttributes:
11817+
description: Attributes for requesting code coverage summary for a commit.
11818+
properties:
11819+
commit_sha:
11820+
description: The commit SHA (40-character hexadecimal string).
11821+
example: 66adc9350f2cc9b250b69abddab733dd55e1a588
11822+
pattern: ^[a-fA-F0-9]{40}$
11823+
type: string
11824+
repository_id:
11825+
description: The repository identifier.
11826+
example: github.com/datadog/shopist
11827+
minLength: 1
11828+
type: string
11829+
required:
11830+
- repository_id
11831+
- commit_sha
11832+
type: object
11833+
CommitCoverageSummaryRequestData:
11834+
description: Data object for commit summary request.
11835+
properties:
11836+
attributes:
11837+
$ref: '#/components/schemas/CommitCoverageSummaryRequestAttributes'
11838+
type:
11839+
$ref: '#/components/schemas/CommitCoverageSummaryRequestType'
11840+
required:
11841+
- type
11842+
- attributes
11843+
type: object
11844+
CommitCoverageSummaryRequestType:
11845+
description: JSON:API type for commit coverage summary request. The value must
11846+
always be `ci_app_coverage_commit_summary_request`.
11847+
enum:
11848+
- ci_app_coverage_commit_summary_request
11849+
example: ci_app_coverage_commit_summary_request
11850+
type: string
11851+
x-enum-varnames:
11852+
- CI_APP_COVERAGE_COMMIT_SUMMARY_REQUEST
1176311853
CompletionCondition:
1176411854
description: The definition of `CompletionCondition` object.
1176511855
properties:
@@ -13270,6 +13360,123 @@ components:
1327013360
type: string
1327113361
x-enum-varnames:
1327213362
- COST_BY_ORG
13363+
CoverageSummaryAttributes:
13364+
description: Attributes object for code coverage summary response.
13365+
properties:
13366+
codeowners:
13367+
additionalProperties:
13368+
$ref: '#/components/schemas/CoverageSummaryCodeownerStats'
13369+
description: Coverage statistics broken down by code owner.
13370+
nullable: true
13371+
type: object
13372+
evaluated_flags_count:
13373+
description: Total number of coverage flags evaluated.
13374+
example: 8
13375+
format: int64
13376+
type: integer
13377+
evaluated_reports_count:
13378+
description: Total number of coverage reports evaluated.
13379+
example: 12
13380+
format: int64
13381+
type: integer
13382+
patch_coverage:
13383+
description: Overall patch coverage percentage.
13384+
example: 70.1
13385+
format: double
13386+
nullable: true
13387+
type: number
13388+
services:
13389+
additionalProperties:
13390+
$ref: '#/components/schemas/CoverageSummaryServiceStats'
13391+
description: Coverage statistics broken down by service.
13392+
nullable: true
13393+
type: object
13394+
total_coverage:
13395+
description: Overall total coverage percentage.
13396+
example: 82.4
13397+
format: double
13398+
nullable: true
13399+
type: number
13400+
type: object
13401+
CoverageSummaryCodeownerStats:
13402+
description: Coverage statistics for a specific code owner.
13403+
properties:
13404+
evaluated_flags_count:
13405+
description: Number of coverage flags evaluated for the code owner.
13406+
example: 2
13407+
format: int64
13408+
type: integer
13409+
evaluated_reports_count:
13410+
description: Number of coverage reports evaluated for the code owner.
13411+
example: 4
13412+
format: int64
13413+
type: integer
13414+
patch_coverage:
13415+
description: Patch coverage percentage for the code owner.
13416+
example: 75.2
13417+
format: double
13418+
nullable: true
13419+
type: number
13420+
total_coverage:
13421+
description: Total coverage percentage for the code owner.
13422+
example: 88.7
13423+
format: double
13424+
nullable: true
13425+
type: number
13426+
type: object
13427+
CoverageSummaryData:
13428+
description: Data object for coverage summary response.
13429+
properties:
13430+
attributes:
13431+
$ref: '#/components/schemas/CoverageSummaryAttributes'
13432+
id:
13433+
description: Unique identifier for the coverage summary (base64-hashed).
13434+
example: ZGQxMjM0NV9tYWluXzE3MDk1NjQwMDA=
13435+
type: string
13436+
type:
13437+
$ref: '#/components/schemas/CoverageSummaryType'
13438+
type: object
13439+
CoverageSummaryResponse:
13440+
description: Response object containing code coverage summary.
13441+
properties:
13442+
data:
13443+
$ref: '#/components/schemas/CoverageSummaryData'
13444+
type: object
13445+
CoverageSummaryServiceStats:
13446+
description: Coverage statistics for a specific service.
13447+
properties:
13448+
evaluated_flags_count:
13449+
description: Number of coverage flags evaluated for the service.
13450+
example: 3
13451+
format: int64
13452+
type: integer
13453+
evaluated_reports_count:
13454+
description: Number of coverage reports evaluated for the service.
13455+
example: 5
13456+
format: int64
13457+
type: integer
13458+
patch_coverage:
13459+
description: Patch coverage percentage for the service.
13460+
example: 72.3
13461+
format: double
13462+
nullable: true
13463+
type: number
13464+
total_coverage:
13465+
description: Total coverage percentage for the service.
13466+
example: 85.5
13467+
format: double
13468+
nullable: true
13469+
type: number
13470+
type: object
13471+
CoverageSummaryType:
13472+
description: JSON:API type for coverage summary response. The value must always
13473+
be `ci_app_coverage_summary`.
13474+
enum:
13475+
- ci_app_coverage_summary
13476+
example: ci_app_coverage_summary
13477+
type: string
13478+
x-enum-varnames:
13479+
- CI_APP_COVERAGE_SUMMARY
1327313480
Cpu:
1327413481
description: CPU usage statistics derived from historical Spark job metrics.
1327513482
Provides multiple estimates so users can choose between conservative and cost-saving
@@ -67602,6 +67809,7 @@ components:
6760267809
cloud_cost_management_write: Configure cloud cost accounts and global
6760367810
customizations. For more details, see the Cloud Cost Management docs.
6760467811
code_analysis_read: View Code Analysis.
67812+
code_coverage_read: View Code Coverage.
6760567813
continuous_profiler_pgo_read: Read and query Continuous Profiler data
6760667814
for Profile-Guided Optimization (PGO).
6760767815
coterm_read: Read terminal recordings.
@@ -74203,6 +74411,119 @@ paths:
7420374411
operator: OR
7420474412
permissions:
7420574413
- security_monitoring_filters_write
74414+
/api/v2/code-coverage/branch/summary:
74415+
post:
74416+
description: 'Retrieve aggregated code coverage statistics for a specific branch
74417+
in a repository.
74418+
74419+
This endpoint provides overall coverage metrics as well as breakdowns by service
74420+
74421+
and code owner.
74422+
74423+
74424+
**Note**: This endpoint requires the `code_coverage_read` permission.'
74425+
operationId: GetCodeCoverageBranchSummary
74426+
requestBody:
74427+
content:
74428+
application/json:
74429+
schema:
74430+
$ref: '#/components/schemas/BranchCoverageSummaryRequest'
74431+
required: true
74432+
responses:
74433+
'200':
74434+
content:
74435+
application/json:
74436+
schema:
74437+
$ref: '#/components/schemas/CoverageSummaryResponse'
74438+
description: OK
74439+
'400':
74440+
$ref: '#/components/responses/BadRequestResponse'
74441+
'403':
74442+
$ref: '#/components/responses/NotAuthorizedResponse'
74443+
'404':
74444+
$ref: '#/components/responses/NotFoundResponse'
74445+
'429':
74446+
$ref: '#/components/responses/TooManyRequestsResponse'
74447+
'500':
74448+
content:
74449+
application/json:
74450+
schema:
74451+
$ref: '#/components/schemas/APIErrorResponse'
74452+
description: Internal server error
74453+
security:
74454+
- apiKeyAuth: []
74455+
appKeyAuth: []
74456+
- AuthZ:
74457+
- code_coverage_read
74458+
summary: Get code coverage summary for a branch
74459+
tags:
74460+
- Code Coverage
74461+
x-codegen-request-body-name: body
74462+
x-permission:
74463+
operator: OR
74464+
permissions:
74465+
- code_coverage_read
74466+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
74467+
74468+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
74469+
/api/v2/code-coverage/commit/summary:
74470+
post:
74471+
description: 'Retrieve aggregated code coverage statistics for a specific commit
74472+
in a repository.
74473+
74474+
This endpoint provides overall coverage metrics as well as breakdowns by service
74475+
74476+
and code owner.
74477+
74478+
74479+
The commit SHA must be a 40-character hexadecimal string (SHA-1 hash).
74480+
74481+
74482+
**Note**: This endpoint requires the `code_coverage_read` permission.'
74483+
operationId: GetCodeCoverageCommitSummary
74484+
requestBody:
74485+
content:
74486+
application/json:
74487+
schema:
74488+
$ref: '#/components/schemas/CommitCoverageSummaryRequest'
74489+
required: true
74490+
responses:
74491+
'200':
74492+
content:
74493+
application/json:
74494+
schema:
74495+
$ref: '#/components/schemas/CoverageSummaryResponse'
74496+
description: OK
74497+
'400':
74498+
$ref: '#/components/responses/BadRequestResponse'
74499+
'403':
74500+
$ref: '#/components/responses/NotAuthorizedResponse'
74501+
'404':
74502+
$ref: '#/components/responses/NotFoundResponse'
74503+
'429':
74504+
$ref: '#/components/responses/TooManyRequestsResponse'
74505+
'500':
74506+
content:
74507+
application/json:
74508+
schema:
74509+
$ref: '#/components/schemas/APIErrorResponse'
74510+
description: Internal server error
74511+
security:
74512+
- apiKeyAuth: []
74513+
appKeyAuth: []
74514+
- AuthZ:
74515+
- code_coverage_read
74516+
summary: Get code coverage summary for a commit
74517+
tags:
74518+
- Code Coverage
74519+
x-codegen-request-body-name: body
74520+
x-permission:
74521+
operator: OR
74522+
permissions:
74523+
- code_coverage_read
74524+
x-unstable: '**Note**: This endpoint is in preview and may be subject to change.
74525+
74526+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
7420674527
/api/v2/container_images:
7420774528
get:
7420874529
description: 'Get all Container Images for your organization.
@@ -103481,6 +103802,9 @@ tags:
103481103802
API. See the [Cloudflare integration page](https://docs.datadoghq.com/integrations/cloudflare/)
103482103803
for more information.
103483103804
name: Cloudflare Integration
103805+
- description: Retrieve and analyze code coverage data from Code Coverage. See the
103806+
[Code Coverage page](https://docs.datadoghq.com/code_coverage/) for more information.
103807+
name: Code Coverage
103484103808
- description: Manage your Datadog Confluent Cloud integration accounts and account
103485103809
resources directly through the Datadog API. See the [Confluent Cloud page](https://docs.datadoghq.com/integrations/confluent_cloud/)
103486103810
for more information.

0 commit comments

Comments
 (0)