From 5942c32fb6fcf6f54cc0b7e81bb18a20369bc30f Mon Sep 17 00:00:00 2001 From: shuangela Date: Tue, 29 Apr 2025 10:46:14 -0400 Subject: [PATCH] DOCSP-48400-confusion-multi-shard-key (#732) * add explaination * condense wording * add source and destination (cherry picked from commit 9734cd334370c621642f824dc4272a9a770fb827) --- source/includes/intro-start-api-example-intro.rst | 5 ++--- source/reference/api/start.txt | 4 ++++ 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/source/includes/intro-start-api-example-intro.rst b/source/includes/intro-start-api-example-intro.rst index 27f6e9202..344c9371d 100644 --- a/source/includes/intro-start-api-example-intro.rst +++ b/source/includes/intro-start-api-example-intro.rst @@ -1,3 +1,2 @@ -The following example starts a sync job between ``cluster0`` and -``cluster1``. The source cluster is ``cluster0`` and the destination -cluster is ``cluster1``. \ No newline at end of file +The following example starts a sync job between the source cluster ``cluster0`` and the +destination cluster ``cluster1``. \ No newline at end of file diff --git a/source/reference/api/start.txt b/source/reference/api/start.txt index 8236d9f4d..e6afb7a0c 100644 --- a/source/reference/api/start.txt +++ b/source/reference/api/start.txt @@ -360,6 +360,10 @@ Response: Start Sync from Replica Set to Sharded Cluster ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +The following example starts a sync job between the source replica set ``cluster0`` and the +destination sharded cluster ``cluster1``. The ``key`` array in this example defines the shard key +``{"location": 1, "region": 1 }``. + Request: .. literalinclude:: /includes/api/requests/start-rs-shard.sh