DOCSP-34591 Add errorDescription and success keys to progress response (#295)

* DOCSP-34591 Add errorDescription and success keys to progress response

* DOCSP-34591 updates for feedback

* DOCSP-34591 updates for MM's feedback

Author: kanchana-mongodb

source/includes/api/responses/progress.json

@@ -16,5 +16,6 @@
                "Source":"cluster0: localhost:27017",
                "Destination":"cluster1: localhost:27018"
             }
-      }
+      },
+   "success": true
 }

source/includes/api/tables/progress-error-response.rst

@@ -8,8 +8,15 @@
      - Type
      - Description
 
+   * - ``success``
+     - boolean
+     - Status of the ``progress`` command. Value is ``true`` if the
+       command succeeds and ``false`` if the command fails.
+
    * - ``error``
      - string
-     - If an error occurred, gives a detailed description of the error.
-       This field is omitted when the call to the endpoint is successful
+     - Type of error.
 
+   * - ``errorDescription``
+     - string
+     - Detailed description of the error.

source/includes/api/tables/progress-response.rst

@@ -114,11 +114,11 @@
 
    * - ``mongosyncID``
      - string
-     - The identifier string for the ``mongosync`` instance.
+     - Identifier string for the ``mongosync`` instance.
 
    * - ``coordinatorID``
      - string
-     - The identifier string for the coordinator instance.
+     - Identifier string for the coordinator instance.
 
        - When ``mongosync`` is coordinated by another instance, this field shows
          the identifier string for the coordinator instance.
@@ -128,4 +128,3 @@
 
        - When ``mongosync`` starts up, this field returns ``null`` until
          ``mongosync`` identifies the coordinator.
-

source/reference/api/progress.txt

@@ -33,8 +33,14 @@ The ``progress`` endpoint returns either an updated status or an error.
 Successful Response
 ~~~~~~~~~~~~~~~~~~~
 
+The response object contains 2 top-level fields, ``success`` and
+``progress``. 
+
+The ``success`` field contains the status of the ``progress`` command. 
+Value is ``true`` if always ``true``. 
+
 If ``mongosync`` successfully gets the status of the sync process, 
-all response fields are wrapped in a top-level ``progress`` object 
+all response fields are wrapped in the top-level ``progress`` object 
 with the following fields:
 
 .. include:: /includes/api/tables/progress-response.rst
@@ -43,7 +49,7 @@ Error Response
 ~~~~~~~~~~~~~~
 
 If ``mongosync`` encounters an error, the ``progress`` endpoint returns 
-the following field:
+the following fields:
 
 .. include:: /includes/api/tables/progress-error-response.rst