You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by gu...@apache.org on 2020/06/05 21:48:13 UTC

[lucene-solr] 01/02: SOLR-13169 Improve docs for MOVEREPLICA - correct existing parameter docs.

This is an automated email from the ASF dual-hosted git repository.

gus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git

commit 4b496b364f23d7a838cbca35892aff1433ce5477
Author: Gus Heck <gu...@apache.org>
AuthorDate: Fri Jun 5 16:33:36 2020 -0400

    SOLR-13169 Improve docs for MOVEREPLICA - correct existing parameter docs.
---
 solr/solr-ref-guide/src/replica-management.adoc                       | 4 ++--
 solr/solrj/src/resources/apispec/collections.collection.Commands.json | 4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/solr/solr-ref-guide/src/replica-management.adoc b/solr/solr-ref-guide/src/replica-management.adoc
index cf508c3..2d66455 100644
--- a/solr/solr-ref-guide/src/replica-management.adoc
+++ b/solr/solr-ref-guide/src/replica-management.adoc
@@ -170,10 +170,10 @@ The API uses the Autoscaling framework to find nodes that can satisfy the disk r
 The name of the collection. This parameter is required.
 
 `shard`::
-The name of the shard that the replica belongs to. This parameter is required.
+The name of the shard for which a replica should be moved. Either this parameter or replica is required. If replica is specified, this parameter is ignored.
 
 `replica`::
-The name of the replica. This parameter is required.
+The name of the replica to move. Either this parameter or shard is required.
 
 `sourceNode`::
 The name of the node that contains the replica. This parameter is required.
diff --git a/solr/solrj/src/resources/apispec/collections.collection.Commands.json b/solr/solrj/src/resources/apispec/collections.collection.Commands.json
index a2694e1..1d9e6a4 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.Commands.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.Commands.json
@@ -24,11 +24,11 @@
       "properties": {
         "replica": {
           "type": "string",
-          "description": "The name of the replica"
+          "description": "The name of the replica to move. Either this parameter or shard is required."
         },
         "shard": {
           "type": "string",
-          "description": "The name of the shard"
+          "description": "The name of the shard for which a replica should be moved. Either this parameter or replica is required. If replica is specified, this parameter is ignored."
         },
         "sourceNode": {
           "type": "string",