Skip to content

Commit e9f16d1

Browse files
author
Dave Cuthbert
authored
DOCS-15470 add can write v1.0 (#62)
* DOCS-15470 add canWrite * Fix section order * Review feedback
1 parent 3dc1377 commit e9f16d1

File tree

3 files changed

+20
-13
lines changed

3 files changed

+20
-13
lines changed

source/includes/api/responses/progress.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
{
44
"state":"RUNNING",
55
"canCommit":true,
6+
"canWrite":false,
67
"info":"change event application",
78
"lagTimeSeconds":0,
89
"collectionCopy":

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. list-table::
22
:header-rows: 1
33
:stub-columns: 1
4-
:widths: 20 14 66
4+
:widths: 20 20 60
55

66
* - Field
77
- Type
@@ -18,6 +18,12 @@
1818
request will succeed. This also means that the initial sync has
1919
completed and is applying change events.
2020

21+
* - ``canWrite``
22+
- boolean
23+
- If ``true``, indicates that it is possible to write to the
24+
destination cluster. Index validation continues until the
25+
:ref:`commit <c2c-api-commit>` is complete.
26+
2127
* - ``info``
2228
- string
2329
- Provides extra information on the synchronization progress.

source/reference/api/progress.txt

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,18 @@ All response fields are wrapped in a top-level ``progress`` object.
3232

3333
.. include:: /includes/api/tables/progress-response.rst
3434

35+
Behavior
36+
--------
37+
38+
- When ``mongosync`` is in the ``IDLE`` state, all output
39+
fields except ``state`` and ``canCommit`` are ``null``.
40+
41+
- When ``mongosync`` is in the ``PAUSED`` state, the
42+
``lagTimeSeconds`` field is ``null``.
43+
44+
- The endpoint does not auto-refresh. To get updated status, call the
45+
``progress`` endpoint again.
46+
3547
Example
3648
-------
3749

@@ -50,15 +62,3 @@ Response
5062
:language: json
5163
:copyable: false
5264

53-
Behavior
54-
--------
55-
56-
- When ``mongosync`` is in the ``IDLE`` state, all output
57-
fields except ``state`` and ``canCommit`` are ``null``.
58-
59-
- When ``mongosync`` is in the ``PAUSED`` state, the
60-
``lagTimeSeconds`` field is ``null``.
61-
62-
- The endpoint does not auto-refresh. To get updated status, call the
63-
``progress`` endpoint again.
64-

0 commit comments

Comments
 (0)