Skip to content

Commit 37dce2f

Browse files
(DOCSP-22950): resume endpoint (#13)
* (DOCSP-22950): resume endpoint * wording * clarify empty data requirement * styling and formatting * add a space
1 parent d51d778 commit 37dce2f

File tree

5 files changed

+70
-1
lines changed

5 files changed

+70
-1
lines changed
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
This endpoint does not use HTTP request body parameters. However, you
2+
**must** specify the ``--data`` option with an empty object ``{ }``.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
curl localhost:27182/api/v1/resume -XPOST --data '{ }'

source/reference/api.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,5 @@ API
1010
:titlesonly:
1111

1212
/reference/api/pause
13+
/reference/api/resume
1314
/reference/api/start

source/reference/api/pause.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Request
3333
Request Body Parameters
3434
~~~~~~~~~~~~~~~~~~~~~~~
3535

36-
This endpoint does not use HTTP request body parameters.
36+
.. include:: includes/api/facts/no-body-parameters.rst
3737

3838
Response
3939
--------

source/reference/api/resume.txt

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
.. _c2c-api-resume:
2+
3+
==========
4+
``resume``
5+
==========
6+
7+
.. default-domain:: mongodb
8+
9+
.. contents:: On this page
10+
:local:
11+
:backlinks: none
12+
:depth: 2
13+
:class: singlecol
14+
15+
Description
16+
-----------
17+
18+
Resumes a paused synchronization session based on data stored on the
19+
destination cluster.
20+
21+
Requirement
22+
-----------
23+
24+
To use the ``resume`` endpoint, the {+c2c-product-name+} must be in the
25+
``PAUSED`` state.
26+
27+
Request
28+
-------
29+
30+
.. code-block:: http
31+
32+
POST /api/v1/resume
33+
34+
Request Body Parameters
35+
~~~~~~~~~~~~~~~~~~~~~~~
36+
37+
.. include:: includes/api/facts/no-body-parameters.rst
38+
39+
Response
40+
--------
41+
42+
.. include:: /includes/api/tables/basic-response.rst
43+
44+
Example
45+
-------
46+
47+
The following example resumes a paused synchronization operation.
48+
49+
Request
50+
~~~~~~~
51+
52+
.. literalinclude:: /includes/api/requests/resume.sh
53+
:language: shell
54+
55+
Response
56+
~~~~~~~~
57+
58+
.. literalinclude:: /includes/api/responses/success.sh
59+
:language: shell
60+
61+
Behavior
62+
--------
63+
64+
If the ``resume`` request is successful, {+c2c-product-name+} enters the
65+
``RUNNING`` state.

0 commit comments

Comments
 (0)