DOCSP-28129 error response (#112)

Dave Cuthbert · web-flow · commit 8c99bf0d6d8c · 2023-02-21T09:47:43.000-05:00
* DOCSP-28129 error response * DOCSP-28129 error response * DOCSP-28129 error response * DOCSP-28129 error response * DOCSP-28129 error response
diff --git a/source/includes/api/tables/progress-response.rst b/source/includes/api/tables/progress-response.rst
@@ -67,4 +67,14 @@
      - string
      - Destination cluster. Returned in the form
        ``<cluster name>: <host>:<port>``.
-     
+
+   * - ``error``
+     - string
+     - If an error occurred, indicates the name of the error. This field
+       is omitted when the call to the endpoint is successful.
+
+   * - ``errorDescription``
+     - string
+     - If an error occurred, gives a detailed description of the error.
+       This field is omitted when the call to the endpoint is successful
+
diff --git a/source/reference/api/progress.txt b/source/reference/api/progress.txt
@@ -28,7 +28,8 @@ Request
 Response
 --------
 
-All response fields are wrapped in a top-level ``progress`` object.
+All response fields are wrapped in a top-level ``progress`` object. The
+endpoint returns either an updated status or an error.
 
 .. include:: /includes/api/tables/progress-response.rst
 
