Skip to content

Commit d7fd445

Browse files
authored
DOCSP-28806 mongosyncID/coordinatorID return fields for /progress calls (#123)
* DOCSP-28806 mongosyncID/coordinatorID return fields for /progress calls * Fixes per Ian * Fixes per Evgeni
1 parent 65002b9 commit d7fd445

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,20 @@
8181
- If an error occurred, gives a detailed description of the error.
8282
This field is omitted when the call to the endpoint is successful
8383

84+
* - ``mongosyncID``
85+
- string
86+
- The identifier string for the ``mongosync`` instance.
87+
88+
* - ``coordinatorID``
89+
- string
90+
- The identifier string for the coordinator instance.
91+
92+
- When ``mongosync`` is coordinated by another instance, this field shows
93+
the identifier string for the coordinator instance.
94+
95+
- When ``mongosync`` is a coordinator or runs alone, this field returns
96+
the same value as its ``mongosyncID`` field.
97+
98+
- When ``mongosync`` starts up, this field returns ``null`` until
99+
``mongosync`` identifies the coordinator.
100+

0 commit comments

Comments
 (0)