From ea4e0be6b8a65123d838c0a5bc8c53b0e13efa93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Franti=C5=A1ek=20Nesveda?= Date: Tue, 11 Jul 2023 10:54:19 +0200 Subject: [PATCH] feat: Add Actor run status message to API docs (#632) The Actor run status message was documented in the "Update run" endpoint, but not in the run object examples. This adds it there. Closes #399. --- sources/platform/api_v2/api_v2_reference.apib | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/sources/platform/api_v2/api_v2_reference.apib b/sources/platform/api_v2/api_v2_reference.apib index 173b36dd6..51351d88a 100644 --- a/sources/platform/api_v2/api_v2_reference.apib +++ b/sources/platform/api_v2/api_v2_reference.apib @@ -4240,6 +4240,8 @@ a summary of your limits, and your current usage. - startedAt: `2019-11-30T07:34:24.202Z` (string, required) - finishedAt: `2019-12-12T09:30:12.202Z` (string, required) - status: `RUNNING` (string, required) +- statusMessage: `Actor is running` (string, nullable) +- isStatusMessageTerminal: false (boolean, nullable) - meta (object, required) - origin: `WEB` (string, required) - clientIp: `172.234.12.34` (string, required) @@ -4344,6 +4346,8 @@ a summary of your limits, and your current usage. - startedAt: `2019-11-30T07:34:24.202Z` (string, required) - finishedAt: `2019-12-12T09:30:12.202Z` (string, required) - status: `SUCCEEDED` (string, required) +- statusMessage: `Actor has finished` (string, nullable) +- isStatusMessageTerminal: true (boolean, nullable) - meta (object, required) - origin: `WEB` (string, required) - clientIp: `172.234.12.34` (string, nullable) @@ -4416,6 +4420,8 @@ a summary of your limits, and your current usage. - startedAt: `2019-11-30T07:34:24.202Z` (string, required) - finishedAt: `2019-12-12T09:30:12.202Z` (string, required) - status: `ABORTED` (string, required) +- statusMessage: `Actor was aborted` (string, nullable) +- isStatusMessageTerminal: true (boolean, nullable) - meta (object, required) - origin: `WEB` (string, required) - clientIp: `172.234.12.34` (string, required) @@ -4483,6 +4489,8 @@ a summary of your limits, and your current usage. - startedAt: `2019-11-30T07:34:24.202Z` (string, required) - finishedAt (string, nullable) - status: `RUNNING` (string, required) +- statusMessage: `Actor is running` (string, nullable) +- isStatusMessageTerminal: false (boolean, nullable) - meta (object, required) - origin: `WEB` (string, required) - clientIp: `172.234.12.34` (string, required)