(DOCSP-22948): start endpoint (#11)

* (DOCSP-22948): start endpoint

* update request formatting

* wording

* missing space

* typo fix

Author: jeff-allen-mongo

source/includes/api/requests/start.sh

@@ -0,0 +1,6 @@
+curl localhost:27182/api/v1/start -XPOST
+--data '
+   {
+      "source": "cluster0",
+      "destination": "cluster1"
+   } '

source/includes/api/responses/success.sh

@@ -0,0 +1 @@
+{"success":true}

source/reference.txt

@@ -7,5 +7,6 @@ Reference
 .. toctree::
    :titlesonly: 
 
+   /reference/api
    /reference/mongosync
-
+   

source/reference/api.txt

@@ -0,0 +1,12 @@
+.. _c2c-api:
+
+.. default-domain:: mongodb
+
+===
+API
+===
+
+.. toctree::
+   :titlesonly: 
+
+   /reference/api/start

source/reference/api/start.txt

@@ -0,0 +1,98 @@
+.. _c2c-api-start:
+
+=========
+``start``
+=========
+
+.. default-domain:: mongodb
+
+.. contents:: On this page
+   :local:
+   :backlinks: none
+   :depth: 2
+   :class: singlecol
+
+Description
+-----------
+
+Starts the synchronization between a source and destination cluster.
+
+Request
+-------
+
+.. code-block:: http
+
+   POST /api/v1/start 
+
+Request Body Parameters
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 20 13 13 54
+
+   * - Parameter
+     - Type
+     - Necessity
+     - Description
+
+   * - ``source``
+     - string
+     - Required
+     - Name of the source cluster.
+    
+   * - ``destination``
+     - string
+     - Required
+     - Name of the destination cluster.
+
+Response
+--------
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+   :widths: 20 14 66
+
+   * - Name
+     - Type
+     - Description
+
+   * - ``success``
+     - boolean
+     - When the request is successful, this value is ``true``.
+
+   * - ``error``
+     - string
+     - If an error occurred, indicates the name of the error. This field
+       is omitted from the response when ``success`` is ``true``.
+
+   * - ``errorDescription``
+     - string
+     - Detailed description of the error that occurred. This field is
+       omitted from the response when ``success`` is ``true``.
+
+Example
+-------
+
+The following example starts a synchronization job where ``cluster0`` is
+the source and ``cluster1`` is the destination.
+
+Request
+~~~~~~~
+
+.. literalinclude:: /includes/api/requests/start.sh
+   :language: shell
+
+Response
+~~~~~~~~
+
+.. literalinclude:: /includes/api/responses/success.sh
+   :language: shell
+
+Behavior
+--------
+
+If {+c2c-product-name+} is in a state other than ``IDLE``, the request
+fails.