summaryrefslogtreecommitdiff
path: root/docs/gl_objects
diff options
context:
space:
mode:
authorkinbald <g.desrumaux1@gmail.com>2022-03-07 23:47:14 +0100
committerkinbald <g.desrumaux1@gmail.com>2022-03-07 23:47:14 +0100
commitd78afb36e26f41d727dee7b0952d53166e0df850 (patch)
treefff0ffd4207907d40c83fc7f14cfb417587c0a0d /docs/gl_objects
parenta97e0cf81b5394b3a2b73d927b4efe675bc85208 (diff)
downloadgitlab-d78afb36e26f41d727dee7b0952d53166e0df850.tar.gz
docs: add pipeline test report summary support
Diffstat (limited to 'docs/gl_objects')
-rw-r--r--docs/gl_objects/pipelines_and_jobs.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/gl_objects/pipelines_and_jobs.rst b/docs/gl_objects/pipelines_and_jobs.rst
index 1628dc7..919e1c5 100644
--- a/docs/gl_objects/pipelines_and_jobs.rst
+++ b/docs/gl_objects/pipelines_and_jobs.rst
@@ -367,3 +367,27 @@ Examples
Get the test report for a pipeline::
test_report = pipeline.test_report.get()
+
+Pipeline test report summary
+====================
+
+Get a pipeline’s test report summary.
+
+Reference
+---------
+
+* v4 API
+
+ + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummary`
+ + :class:`gitlab.v4.objects.ProjectPipelineTestReportSummaryManager`
+ + :attr:`gitlab.v4.objects.ProjectPipeline.test_report)summary`
+
+* GitLab API: https://docs.gitlab.com/ee/api/pipelines.html#get-a-pipelines-test-report-summary
+
+Examples
+--------
+
+Get the test report summary for a pipeline::
+
+ test_report_summary = pipeline.test_report_summary.get()
+