update api documentation

zonemaster · Nov 21, 2022 · 3e0cc4d · 3e0cc4d
1 parent bba2d62
commit 3e0cc4d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/API.md b/docs/API.md
@@ -386,6 +386,7 @@ The object has three keys, `"module"`, `"message"` and `"level"`.
 * `"module"`: a string. The *test module* that produced the result.
 * `"message"`: a string. A human-readable *message* describing that particular result.
 * `"level"`: a [*severity level*][Severity level]. The severity of the message.
+* `"testcase"`: a string. The *test case ID* of the *test case* that produced the result.
 
 Sometimes additional keys are present.
 
@@ -995,6 +996,8 @@ An object with the following properties:
 * `"params"`: See below.
   `start_domain_test` when the *test* was started.
 * `"results"`: A list of [*test result*][Test result] objects.
+* `"testcase_descriptions"`: A map with the test case IDs as keys and the
+  translated descriptions of the corresponding the test cases as values.
 
 If the test was created by [`start_domain_test`][start_domain_test] then `"params"`
 is a normalized version `"params"` object sent to [`start_domain_test`][start_domain_test]