DOCSP-34591 Add errorDescription and success keys to progress response

[kanchana-mongodb]

• JIRA
• Stage
• Build

[mmcclimon]

One tweak to make, plus two other changes on the page (https://preview-mongodbkanchanamongodb.gatsbyjs.io/cluster-sync/DOCSP-34591/reference/api/progress/#response-1) that aren't in this .rst file:

First, just above the error response table:

If mongosync encounters an error, the progress endpoint returns the following field:

This should be "fields" (plural).

Second: the success boolean field is also returned for non-error responses. I don't know if we want to document this in the table, but I think we should at least update the sample successful response to this (note the top-level "success" key):

{
   "success":  true,
   "progress":
      {
         "state":"RUNNING",
         "canCommit":true,
         "canWrite":false,
         "info":"change event application",
         "lagTimeSeconds":0,
         "collectionCopy":
            {
               "estimatedTotalBytes":694,
               "estimatedCopiedBytes":694
            },
         "directionMapping":
            {
               "Source":"cluster0: localhost:27017",
               "Destination":"cluster1: localhost:27018"
            }
      }
}

Thanks!

[mmcclimon]

This is a boolean field, not a string.

[mmcclimon]

One more tweak; thanks!

[mmcclimon]

This table item is a little misleading. This table is introduced by the sentence

If mongosync successfully gets the status of the sync process, all response fields are wrapped in a top-level progress object with the following fields:

The success key is a top-level field, not part of the progress object. That is: a successful response looks like this:

{
  success: true,
  progress: {
    // All the other fields as in the table
  }
}

So, this description is fine, but it's a top-level field and not part of the progress object.

[sarah-olson-mongodb]

Thanks @kanchana-mongodb! LGTM

[mmcclimon]

LGTM % 1 small suggestion; that isn't really a technical point but a clarity one, so happy to approve without needing another review. Thanks!

[mmcclimon]

(nit) Since this is in the "successful response" section, we could maybe simplify by saying here that success will always be true here.