summaryrefslogtreecommitdiffstats
path: root/testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md
diff options
context:
space:
mode:
Diffstat (limited to 'testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md')
-rw-r--r--testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md b/testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md
new file mode 100644
index 0000000000..755b2f7897
--- /dev/null
+++ b/testing/web-platform/tests/tools/wave/docs/rest-api/tests-api/read-malfunctioning.md
@@ -0,0 +1,30 @@
+# `read malfunctioning` - [Tests API](../README.md#tests-api)
+
+The `read malfunctioning` method of the tests API returns a list of test files, which were flagged as not working properly in a specific session. This is useful to [add them to the exclude list](../../usage/excluding-tests.md) of further test sessions.
+
+## HTTP Request
+
+`GET /api/tests/<session_token>/malfunctioning`
+
+## Response Payload
+
+```json
+"Array<String>"
+```
+
+## Example
+
+**Request:**
+
+`GET /api/tests/7dafeec0-c351-11e9-84c5-3d1ede2e7d2e/malfunctioning`
+
+**Response:**
+
+```json
+[
+ "/apiOne/test/one.html",
+ "/apiOne/test/five.html",
+ "/apiThree/test/two.html",
+ "/apiThree/test/twenty.html"
+]
+```