Document ChecksApi.updateResult()
The call was added by Ie485bc031f65b18c78746ca64d8a0dbab1f03c47 released
in Gerrit 3.5.0. It was added for the Chromium buildbucket plugin in:
https://chromium-review.googlesource.com/c/infra/gerrit-plugins/buildbucket/+/2973596
The documentation is a copy of the API documentation.
Release-Notes: document `ChecksApi.updateResult()`
Co-Authored-With: Antoine Musso <hashar@free.fr>
Change-Id: Ie0e40ee9598137e544db54b43f02077cb14d816b
diff --git a/Documentation/pg-plugin-checks-api.txt b/Documentation/pg-plugin-checks-api.txt
index 8786cc4..ebfb862 100644
--- a/Documentation/pg-plugin-checks-api.txt
+++ b/Documentation/pg-plugin-checks-api.txt
@@ -42,3 +42,23 @@
`checksApi.announceUpdate()`
Tells Gerrit to call `provider.fetch()`.
+
+[[updateResult]]
+== updateResult
+`checksApi.updateResult(run: CheckRun, result: CheckResult)`
+
+Updates an individual result. This can be used for lazy laoding detailled
+information. For example, if you are using the
+link:pg-plugin-endpoints.html#_check_result_expanded[`check-result-expanded`
+endpoint], then you can load more result details when the user expands a result
+row.
+
+The parameter `run` is only used to *find* the correct run for updating the
+result. It will only be used for comparing `change`, `patchset`, `attempt` and
+`checkName`. Its properties other than `results` will not be updated.
+
+For us being able to identify the result that you want to update you have to
+set the `externalId` property. An undefined `externalId` will result in an
+error.
+
+An example usage can be found in link:https://chromium.googlesource.com/infra/gerrit-plugins/buildbucket/+/main/web/checks-result.ts[Chromium Buildbucket Plugin].
