You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ct...@apache.org on 2019/06/13 00:03:58 UTC
[lucene-solr] 02/02: SOLR-13235: update doc links in apispec files
to new pages
This is an automated email from the ASF dual-hosted git repository.
ctargett pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git
commit 65b539104122d487c0cbed6ef38c3fd962b8f9e5
Author: Cassandra Targett <ct...@apache.org>
AuthorDate: Wed Jun 12 16:36:41 2019 -0500
SOLR-13235: update doc links in apispec files to new pages
---
solr/solrj/src/resources/apispec/cluster.Commands.json | 12 ++++++------
solr/solrj/src/resources/apispec/cluster.aliases.json | 2 +-
solr/solrj/src/resources/apispec/cluster.json | 2 +-
solr/solrj/src/resources/apispec/cluster.nodes.json | 2 +-
.../src/resources/apispec/collections.Commands.json | 18 +++++++++---------
.../apispec/collections.collection.Commands.json | 14 +++++++-------
.../collections.collection.Commands.modify.json | 2 +-
.../collections.collection.Commands.reload.json | 2 +-
.../apispec/collections.collection.delete.json | 2 +-
.../src/resources/apispec/collections.collection.json | 2 +-
.../collections.collection.shards.Commands.json | 6 +++---
.../collections.collection.shards.shard.Commands.json | 4 ++--
.../collections.collection.shards.shard.delete.json | 2 +-
...ections.collection.shards.shard.replica.delete.json | 2 +-
solr/solrj/src/resources/apispec/collections.json | 2 +-
15 files changed, 37 insertions(+), 37 deletions(-)
diff --git a/solr/solrj/src/resources/apispec/cluster.Commands.json b/solr/solrj/src/resources/apispec/cluster.Commands.json
index da31b3c..069cd1d 100644
--- a/solr/solrj/src/resources/apispec/cluster.Commands.json
+++ b/solr/solrj/src/resources/apispec/cluster.Commands.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html",
"description": "Cluster-wide commands to assign roles to nodes, remove role assignments, or add, edit or remove a cluster-wide property.",
"methods": [
"POST"
@@ -12,7 +12,7 @@
"commands": {
"add-role":{
"type":"object",
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#addrole",
+ "documentation":"https://lucene.apache.org/solr/guide/cluster-node-management.html#addrole",
"description":"Assign a specific role to a node in the cluster.",
"properties": {
"role": {
@@ -33,7 +33,7 @@
},
"remove-role":{
"type":"object",
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#removerole",
+ "documentation":"https://lucene.apache.org/solr/guide/cluster-node-management.html#removerole",
"description":"Unassign a role from a node in the cluster.",
"properties": {
"role": {
@@ -53,7 +53,7 @@
},
"set-property": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#clusterprop",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html#clusterprop",
"description": "Add, edit, or delete a cluster-wide property.",
"properties": {
"name": {
@@ -72,7 +72,7 @@
},
"set-obj-property": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#clusterprop",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html#clusterprop",
"description": "Add, edit, or delete a cluster-wide property.",
"properties": {
"legacyCloud": {
@@ -150,7 +150,7 @@
},
"utilize-node": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#utilizenode",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html#utilizenode",
"description": "use a replica to reduce load",
"properties": {
"node": {
diff --git a/solr/solrj/src/resources/apispec/cluster.aliases.json b/solr/solrj/src/resources/apispec/cluster.aliases.json
index b200f7f..c614002 100644
--- a/solr/solrj/src/resources/apispec/cluster.aliases.json
+++ b/solr/solrj/src/resources/apispec/cluster.aliases.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-aliasing.html",
"description": "Provides list of collection aliases.",
"methods": [
"GET"
diff --git a/solr/solrj/src/resources/apispec/cluster.json b/solr/solrj/src/resources/apispec/cluster.json
index 75d5369..028869d 100644
--- a/solr/solrj/src/resources/apispec/cluster.json
+++ b/solr/solrj/src/resources/apispec/cluster.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html",
"description": "General information about the cluster, including defined collections (with the 'cluster' endpoint), status of the overseer (with the 'cluster/overseer' endpoint), and available nodes (with the 'cluster/nodes' endpoint).",
"methods": [
"GET"
diff --git a/solr/solrj/src/resources/apispec/cluster.nodes.json b/solr/solrj/src/resources/apispec/cluster.nodes.json
index 60f3a21..0dd474d 100644
--- a/solr/solrj/src/resources/apispec/cluster.nodes.json
+++ b/solr/solrj/src/resources/apispec/cluster.nodes.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html",
"description": "Provides general information about the available nodes of the cluster.",
"methods": [
"GET"
diff --git a/solr/solrj/src/resources/apispec/collections.Commands.json b/solr/solrj/src/resources/apispec/collections.Commands.json
index f24fe72..827f1a7 100644
--- a/solr/solrj/src/resources/apispec/collections.Commands.json
+++ b/solr/solrj/src/resources/apispec/collections.Commands.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#create",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#create",
"description": "Create collections and collection aliases, backup or restore collections, and delete collections and aliases.",
"methods": [
"POST"
@@ -13,7 +13,7 @@
"commands": {
"create": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#create",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#create",
"description": "Create a collection.",
"properties": {
"name": {
@@ -128,7 +128,7 @@
]
},
"create-alias": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#createalias",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-aliasing.html#createalias",
"description": "Allows one or more collections to be known by another name (to include time partitioned collections). If this command is used on an existing alias, the existing alias will be replaced with the new collection details.",
"type": "object",
"properties": {
@@ -145,7 +145,7 @@
},
"router" : {
"type":"object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#createalias",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-aliasing.html#createalias",
"description":"Routing specific properties to define a time routed alias. Do not specify 'collections' when creating a time routed alias.",
"properties" : {
"name" : {
@@ -192,7 +192,7 @@
},
"create-collection": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#create",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#create",
"description": "The settings to use to create a collection for each new time partition. Most options from the collection create command are available, except for 'name', 'async' and 'waitForFinalState'.",
"additionalProperties": true
},
@@ -206,7 +206,7 @@
]
},
"delete-alias": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deletealias",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-aliasing.html#deletealias",
"description": "Deletes a collection alias",
"type": "object",
"properties": {
@@ -224,7 +224,7 @@
]
},
"set-alias-property": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#modifyalias",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-aliasing.html#modifyalias",
"description": "Allows changing the properties on an alias. If a key is set with an empty string then it will be removed",
"type": "object",
"properties": {
@@ -247,7 +247,7 @@
]
},
"backup-collection": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#backup",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#backup",
"description": "Backup Solr indexes and configurations for a specific collection. One copy of the indexes will be taken from each shard, and the config set for the collection will also be copied.",
"type": "object",
"properties": {
@@ -275,7 +275,7 @@
]
},
"restore-collection": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#restore",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#restore",
"description": "Restore Solr indexes and configurations from a backup. You cannot restore into the same collection you took the backup from. The target collection must not exist before calling this command, as it will be created by the restore action. The new collection will have the same number of shards and replicas as the original collection, and all routing strategies will be retained.",
"type": "object",
"properties": {
diff --git a/solr/solrj/src/resources/apispec/collections.collection.Commands.json b/solr/solrj/src/resources/apispec/collections.collection.Commands.json
index d77cb62..a2694e1 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.Commands.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.Commands.json
@@ -19,7 +19,7 @@
},
"move-replica": {
"type": "object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#movereplica",
+ "documentation": "https://lucene.apache.org/solr/guide/replica-management.html#movereplica",
"description": "This command moves a replica from one node to a new node. In case of shared filesystems the `dataDir` and `ulogDir` may be reused.",
"properties": {
"replica": {
@@ -57,7 +57,7 @@
},
"migrate-docs":{
"type":"object",
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#migrate",
+ "documentation":"https://lucene.apache.org/solr/guide/collection-management.html#migrate",
"description": "Moves documents with a given routing key to another collection. The source collection will continue to have the same documents, but will start re-routing write requests to the new collection. This command only works on collections using the 'compositeId' type of document routing.",
"properties":{
"target":{
@@ -82,7 +82,7 @@
},
"balance-shard-unique":{
"type":"object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#balanceshardunique",
+ "documentation": "https://lucene.apache.org/solr/guide/cluster-node-management.html#balanceshardunique",
"description": "Ensures a property is distributed equally across all physical nodes of a collection. If the property already exists on a replica, effort is made to leave it there. However, if it does not exist on any repica, a shard will be chosen and the property added.",
"properties":{
"property":{
@@ -103,7 +103,7 @@
},
"rebalance-leaders" :{
"type":"object",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#rebalanceleaders",
+ "documentation": "https://lucene.apache.org/solr/guide/replica-management.html#rebalanceleaders",
"description": "Reassign leaders in a collection according to the preferredLeader property across active nodes. This command should be run after the preferredLeader property has been set with the balance-shards or add-replica-property commands.",
"properties":{
"maxAtOnce":{
@@ -118,7 +118,7 @@
}
},
"add-replica-property": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#addreplicaprop",
+ "documentation": "https://lucene.apache.org/solr/guide/replica-management.html#addreplicaprop",
"description": "Assign an arbitrary property to a particular replica and give it the value specified. If the property already exists, it will be overwritten with the new value.",
"type": "object",
"properties": {
@@ -153,7 +153,7 @@
},
"delete-replica-property": {
"description": "Deletes an arbitrary property from a particular replica",
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deletereplicaprop",
+ "documentation": "https://lucene.apache.org/solr/guide/replica-management.html#deletereplicaprop",
"type": "object",
"properties": {
"shard": {
@@ -172,7 +172,7 @@
"required":["shard","replica","property"]
},
"set-collection-property": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#collectionprop",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#collectionprop",
"description": "Sets a property for the collection",
"type": "object",
"properties": {
diff --git a/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json b/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json
index 62e35cc..7a12eb1 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json
@@ -1,5 +1,5 @@
{
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#modifycollection",
+ "documentation":"https://lucene.apache.org/solr/guide/collection-management.html#modifycollection",
"description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.",
"type": "object",
"properties":{
diff --git a/solr/solrj/src/resources/apispec/collections.collection.Commands.reload.json b/solr/solrj/src/resources/apispec/collections.collection.Commands.reload.json
index 3db50ab..ed94858 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.Commands.reload.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.Commands.reload.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#reload",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#reload",
"description": "Reloads a collection so new configuration changes can take effect and be available for use by the system.",
"type" : "object",
"properties":{
diff --git a/solr/solrj/src/resources/apispec/collections.collection.delete.json b/solr/solrj/src/resources/apispec/collections.collection.delete.json
index eef5571..2e38c0f 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.delete.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.delete.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#delete",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#delete",
"description": "Deletes a collection.",
"methods": [
"DELETE"
diff --git a/solr/solrj/src/resources/apispec/collections.collection.json b/solr/solrj/src/resources/apispec/collections.collection.json
index a755fdc..4c2d4d4 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#list",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#list",
"description": "Lists all collections, with details on shards and replicas in each collection.",
"methods": [
"GET"
diff --git a/solr/solrj/src/resources/apispec/collections.collection.shards.Commands.json b/solr/solrj/src/resources/apispec/collections.collection.shards.Commands.json
index 25d3e9d..b82bf8a 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.shards.Commands.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.shards.Commands.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/shard-management.html",
"description": "Allows you to create a shard, split an existing shard or add a new replica.",
"methods": [
"POST"
@@ -13,7 +13,7 @@
"commands": {
"split": {
"type" : "object",
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#splitshard",
+ "documentation":"https://lucene.apache.org/solr/guide/shard-management.html#splitshard",
"description": "Splits an existing shard into two or more new shards. During this action, the existing shard will continue to contain the original data, but new data will be routed to the new shards once the split is complete. New shards will have as many replicas as the existing shards. A soft commit will be done automatically. An explicit commit request is not required because the index is automatically saved to disk during the split operation. New shards will use the original sh [...]
"properties": {
"shard":{
@@ -78,7 +78,7 @@
"required":["shard"]
},
"add-replica": {
- "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#addreplica",
+ "documentation":"https://lucene.apache.org/solr/guide/replica-management.html#addreplica",
"description": "",
"type" : "object",
"properties": {
diff --git a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.Commands.json b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.Commands.json
index 27bfbd9..2f8485f 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.Commands.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.Commands.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
+ "documentation": "https://lucene.apache.org/solr/guide/shard-management.html",
"description": "Commands to force leader election and synchronize shards.",
"methods": [
"POST",
@@ -13,7 +13,7 @@
},
"commands": {
"force-leader": {
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#forceleader",
+ "documentation": "https://lucene.apache.org/solr/guide/shard-management.html#forceleader",
"description": "In the unlikely event of a shard losing its leader, this command can be invoked to force the election of a new leader",
"type": "object"
},
diff --git a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.delete.json b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.delete.json
index fdfc7be..ae7c36a 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.delete.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.delete.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deleteshard",
+ "documentation": "https://lucene.apache.org/solr/guide/shard-management.html#deleteshard",
"description": "Deletes a shard by unloading all replicas of the shard, removing it from clusterstate.json, and by default deleting the instanceDir and dataDir. Only inactive shards or those which have no range for custom sharding will be deleted.",
"methods": [
"DELETE"
diff --git a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.replica.delete.json b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.replica.delete.json
index 8cd3315..2d4691d 100644
--- a/solr/solrj/src/resources/apispec/collections.collection.shards.shard.replica.delete.json
+++ b/solr/solrj/src/resources/apispec/collections.collection.shards.shard.replica.delete.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deletereplica",
+ "documentation": "https://lucene.apache.org/solr/guide/replica-management.html#deletereplica",
"description": "Deletes a replica. If the responding node is up, the core is unloaded, the entry removed from clusterstate.json, and the instanceDir and dataDir removed. If the node is not up, the entry for the replica is removed from clusterstate.json; if the nodes comes up later, the replica is automatically de-registered.",
"methods": [
"DELETE"
diff --git a/solr/solrj/src/resources/apispec/collections.json b/solr/solrj/src/resources/apispec/collections.json
index 87cd7b0..10b91ab 100644
--- a/solr/solrj/src/resources/apispec/collections.json
+++ b/solr/solrj/src/resources/apispec/collections.json
@@ -1,5 +1,5 @@
{
- "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#list",
+ "documentation": "https://lucene.apache.org/solr/guide/collection-management.html#list",
"description": "List all available collections and their properties.",
"methods": [
"GET"