project_code_coverage_summary
Gets or lists a project_code_coverage_summary resource.
Overview​
| Name | project_code_coverage_summary |
| Type | Resource |
| Id | gitlab.analytics.project_code_coverage_summary |
Fields​
The following fields are returned by SELECT queries:
- get
GraphQL response envelope
| Name | Datatype | Description |
|---|---|---|
average_coverage | number | Average percentage of the different code coverage results available for the project. |
coverage_count | integer | Number of different code coverage results available. |
last_updated_on | string | Latest date when the code coverage was created for the project. |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | full_path, host | Code coverage summary associated with the project. Generated from the GitLab GraphQL schema field Project.codeCoverageSummary (CodeCoverageSummary). |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
full_path | string | Full path of the project, for example gitlab-org/gitlab |
host | string | GitLab host, with an optional port (default gitlab.com). Resolved from the GITLAB_HOST environment variable when it is set (x-stackQL-envVar); a WHERE host value always takes precedence. Self-managed instances: the provider is generated from the gitlab.com schema, so older instances may reject fields they do not serve. (default: gitlab.com, x-stackQL-envVar: GITLAB_HOST) |
SELECT examples​
- get
Code coverage summary associated with the project. Generated from the GitLab GraphQL schema field Project.codeCoverageSummary (CodeCoverageSummary).
SELECT
average_coverage,
coverage_count,
last_updated_on
FROM gitlab.analytics.project_code_coverage_summary
WHERE full_path = '{{ full_path }}' -- required
AND host = '{{ host }}' -- required (defaults to gitlab.com; or set GITLAB_HOST)
;