Apache
/
lucene
mirror of https://github.com/apache/lucene.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

SOLR-10848: Update v2 api specs with new Ref Guide address and anchor links

This commit is contained in:
Cassandra Targett 2017-07-21 15:47:01 -05:00
parent 4045fa9eb7
commit cdae11e25a
51 changed files with 101 additions and 102 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
solr/core/src/java/org/apache/solr/api/V2HttpCall.java
View File

@ -82,7 +82,7 @@ public class V2HttpCall extends HttpSolrCall {
api = new Api(null) { api = new Api(null) {
@Override @Override
public void call(SolrQueryRequest req, SolrQueryResponse rsp) { public void call(SolrQueryRequest req, SolrQueryResponse rsp) {
rsp.add("documentation", "https://cwiki.apache.org/confluence/display/solr/v2+API"); rsp.add("documentation", "https://lucene.apache.org/solr/guide/v2-api.html");
rsp.add("description", "V2 API root path"); rsp.add("description", "V2 API root path");
} }
}; };

19
solr/solr-ref-guide/src/v2-api.adoc
View File

@ -78,7 +78,7 @@ Example : `\http://localhost:8983/v2/c/gettingstarted/get/_introspect`
---- ----
{ {
"spec":[{ "spec":[{
"documentation":"https://cwiki.apache.org/confluence/display/solr/RealTime+Get", "documentation":"https://lucene.apache.org/solr/guide/real-time-get.html",
"description":"RealTime Get allows retrieving documents by ID before the documents have been committed to the index. It is useful when you need access to documents as soon as they are indexed but your commit times are high for other reasons.", "description":"RealTime Get allows retrieving documents by ID before the documents have been committed to the index. It is useful when you need access to documents as soon as they are indexed but your commit times are high for other reasons.",
"methods":["GET"], "methods":["GET"],
"url":{ "url":{
@ -94,7 +94,8 @@ Example : `\http://localhost:8983/v2/c/gettingstarted/get/_introspect`
"type":"string", "type":"string",
"description":"An optional filter query to add to the query. One use case for this is security filtering, in case users or groups should not be able to retrieve the document ID requested."}}}}], "description":"An optional filter query to add to the query. One use case for this is security filtering, in case users or groups should not be able to retrieve the document ID requested."}}}}],
"WARNING":"This response format is experimental. It is likely to change in the future.", "WARNING":"This response format is experimental. It is likely to change in the future.",
"availableSubPaths":{}} "availableSubPaths":{}
}
---- ----
Description of some of the keys in the above example: Description of some of the keys in the above example:
@ -112,29 +113,29 @@ Example of introspect for a POST API: `\http://localhost:8983/v2/c/gettingstarte
---- ----
{ {
"spec":[{ "spec":[{
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html",
"description":"Several collection-level operations are supported with this endpoint: modify collection attributes; reload a collection; migrate documents to a different collection; rebalance collection leaders; balance properties across shards; and add or delete a replica property.", "description":"Several collection-level operations are supported with this endpoint: modify collection attributes; reload a collection; migrate documents to a different collection; rebalance collection leaders; balance properties across shards; and add or delete a replica property.",
"methods":["POST"], "methods":["POST"],
"url":{"paths":["/collections/{collection}", "url":{"paths":["/collections/{collection}",
"/c/{collection}"]}, "/c/{collection}"]},
"commands":{"modify":{ "commands":{"modify":{
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-modifycoll", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#modifycollection",
"description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.", "description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.",
"type":"object", "type":"object",
"properties":{ "properties":{
"rule":{ "rule":{
"type":"array", "type":"array",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation":"https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description":"Modifies the rules for where replicas should be located in a cluster.", "description":"Modifies the rules for where replicas should be located in a cluster.",
"items":{"type":"string"}}, "items":{"type":"string"}},
"snitch":{ "snitch":{
"type":"array", "type":"array",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation":"https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description":"Details of the snitch provider", "description":"Details of the snitch provider",
"items":{"type":"string"}}, "items":{"type":"string"}},
"autoAddReplicas":{ "autoAddReplicas":{
"type":"boolean", "type":"boolean",
"description":"When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://cwiki.apache.org/confluence/display/solr/Running+Solr+on+HDFS for more details on settings and overrides."}, "description":"When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://lucene.apache.org/solr/guide/running-solr-on-hdfs.html for more details on settings and overrides."},
"replicationFactor":{ "replicationFactor":{
"type":"string", "type":"string",
"description":"The number of replicas to be created for each shard. Replicas are physical copies of each shard, acting as failover for the shard. Note that changing this value on an existing collection does not automatically add more replicas to the collection. However, it will allow add-replica commands to succeed."}, "description":"The number of replicas to be created for each shard. Replicas are physical copies of each shard, acting as failover for the shard. Note that changing this value on an existing collection does not automatically add more replicas to the collection. However, it will allow add-replica commands to succeed."},
@ -148,9 +149,7 @@ Example of introspect for a POST API: `\http://localhost:8983/v2/c/gettingstarte
"/c/gettingstarted/schema":["POST", "GET"], "/c/gettingstarted/schema":["POST", "GET"],
"/c/gettingstarted/export":["POST", "GET"], "/c/gettingstarted/export":["POST", "GET"],
"/c/gettingstarted/admin/ping":["POST", "GET"], "/c/gettingstarted/admin/ping":["POST", "GET"],
"/c/gettingstarted/update":["POST"]}, "/c/gettingstarted/update":["POST"]}
[... more sub-paths ...]
} }
---- ----

8
solr/solrj/src/resources/apispec/cluster.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Cluster-wide commands to assign roles to nodes, remove role assignments, or add, edit or remove a cluster-wide property.", "description": "Cluster-wide commands to assign roles to nodes, remove role assignments, or add, edit or remove a cluster-wide property.",
"methods": [ "methods": [
"POST" "POST"
@ -12,7 +12,7 @@
"commands": { "commands": {
"add-role":{ "add-role":{
"type":"object", "type":"object",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api15", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#addrole",
"description":"Assign a specific role to a node in the cluster.", "description":"Assign a specific role to a node in the cluster.",
"properties": { "properties": {
"role": { "role": {
@ -33,7 +33,7 @@
}, },
"remove-role":{ "remove-role":{
"type":"object", "type":"object",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api16", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#removerole",
"description":"Unassign a role from a node in the cluster.", "description":"Unassign a role from a node in the cluster.",
"properties": { "properties": {
"role": { "role": {
@ -53,7 +53,7 @@
}, },
"set-property": { "set-property": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api11", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#clusterprop",
"description": "Add, edit, or delete a cluster-wide property.", "description": "Add, edit, or delete a cluster-wide property.",
"properties": { "properties": {
"name": { "name": {

4
solr/solrj/src/resources/apispec/cluster.aliases.json
View File

@ -1,6 +1,6 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Provides list of collection alises.", "description": "Provides list of collection aliases.",
"methods": [ "methods": [
"GET" "GET"
], ],

4
solr/solrj/src/resources/apispec/cluster.configs.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API", "documentation": "https://lucene.apache.org/solr/guide/configsets-api.html",
"description": "Create ConfigSets.", "description": "Create ConfigSets.",
"methods": [ "methods": [
"POST" "POST"
@ -12,7 +12,7 @@
"create": { "create": {
"type" :"object", "type" :"object",
"description": "Create a ConfigSet, based on another ConfigSet already in ZooKeeper.", "description": "Create a ConfigSet, based on another ConfigSet already in ZooKeeper.",
"documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-create", "documentation": "https://lucene.apache.org/solr/guide/configsets-api.html#configsets-create",
"properties": { "properties": {
"name" :{ "name" :{
"type" :"string", "type" :"string",

2
solr/solrj/src/resources/apispec/cluster.configs.delete.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-delete", "documentation": "https://lucene.apache.org/solr/guide/configsets-api.html#configsets-delete",
"description": "Delete ConfigSets. The name of the ConfigSet to delete must be provided as a path parameter.", "description": "Delete ConfigSets. The name of the ConfigSet to delete must be provided as a path parameter.",
"methods": [ "methods": [
"DELETE" "DELETE"

2
solr/solrj/src/resources/apispec/cluster.configs.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/ConfigSets+API#ConfigSetsAPI-list", "documentation": "https://lucene.apache.org/solr/guide/configsets-api.html#configsets-list",
"description": "List all ConfigSets in the cluster.", "description": "List all ConfigSets in the cluster.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/cluster.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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).", "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": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/cluster.nodes.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Provides general information about the available nodes of the cluster.", "description": "Provides general information about the available nodes of the cluster.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/cluster.security.BasicAuth.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Basic+Authentication+Plugin", "documentation": "https://lucene.apache.org/solr/guide/basic-authentication-plugin.html",
"description": "Modifies the configuration of Basic authentication, allowing you to add or remove users and their passwords.", "description": "Modifies the configuration of Basic authentication, allowing you to add or remove users and their passwords.",
"methods": [ "methods": [
"POST" "POST"

2
solr/solrj/src/resources/apispec/cluster.security.RuleBasedAuthorization.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-Based+Authorization+Plugin", "documentation": "https://lucene.apache.org/solr/guide/rule-based-authorization-plugin.html",
"description": "Defines roles for accessing Solr, and assigns users to those roles. Use this API to change user authorizations to each of Solr's components.", "description": "Defines roles for accessing Solr, and assigns users to those roles. Use this API to change user authorizations to each of Solr's components.",
"methods": [ "methods": [
"POST" "POST"

2
solr/solrj/src/resources/apispec/cluster.security.authentication.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Securing+Solr", "documentation": "https://lucene.apache.org/solr/guide/securing-solr.html",
"description":"This is a placeholder output when no authentication is configured", "description":"This is a placeholder output when no authentication is configured",
"methods": [ "methods": [
"POST" "POST"

2
solr/solrj/src/resources/apispec/cluster.security.authentication.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Authentication+and+Authorization+Plugins", "documentation": "https://lucene.apache.org/solr/guide/authentication-and-authorization-plugins.html",
"description": "Shows the configuration for authentication, including users, classes (type of authentication) and other parameters.", "description": "Shows the configuration for authentication, including users, classes (type of authentication) and other parameters.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/cluster.security.authorization.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Securing+Solr", "documentation": "https://lucene.apache.org/solr/guide/securing-solr.html",
"description":"This is a placeholder output when no authorization is configured", "description":"This is a placeholder output when no authorization is configured",
"methods": [ "methods": [
"POST" "POST"

2
solr/solrj/src/resources/apispec/cluster.security.authorization.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Authentication+and+Authorization+Plugins", "documentation": "https://lucene.apache.org/solr/guide/authentication-and-authorization-plugins.html",
"description":"Shows the configuration for authorization, including the classes (type of authorization), permissions, user-roles, and other parameters.", "description":"Shows the configuration for authorization, including the classes (type of authorization), permissions, user-roles, and other parameters.",
"methods": [ "methods": [
"GET" "GET"

22
solr/solrj/src/resources/apispec/collections.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#create",
"description": "Create collections and collection aliases, backup or restore collections, and delete collections and aliases.", "description": "Create collections and collection aliases, backup or restore collections, and delete collections and aliases.",
"methods": [ "methods": [
"POST" "POST"
@ -13,7 +13,7 @@
"commands": { "commands": {
"create": { "create": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#create",
"description": "Create a collection.", "description": "Create a collection.",
"properties": { "properties": {
"name": { "name": {
@ -26,7 +26,7 @@
}, },
"router": { "router": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Shards+and+Indexing+Data+in+SolrCloud", "documentation": "https://lucene.apache.org/solr/guide/shards-and-indexing-data-in-solrcloud.html",
"description": "These properties define how to distribute documents across a collection's shards.", "description": "These properties define how to distribute documents across a collection's shards.",
"properties": { "properties": {
"name": { "name": {
@ -82,12 +82,12 @@
}, },
"autoAddReplicas": { "autoAddReplicas": {
"type": "boolean", "type": "boolean",
"description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://cwiki.apache.org/confluence/display/solr/Running+Solr+on+HDFS for more details on settings and overrides.", "description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://lucene.apache.org/solr/guide/running-solr-on-hdfs.html for more details on settings and overrides.",
"default": "false" "default": "false"
}, },
"rule": { "rule": {
"type": "array", "type": "array",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "Defines rules for where replicas should be located in a cluster.", "description": "Defines rules for where replicas should be located in a cluster.",
"items": { "items": {
"type": "string" "type": "string"
@ -95,7 +95,7 @@
}, },
"snitch": { "snitch": {
"type": "array", "type": "array",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "", "description": "",
"items": { "items": {
"type": "string" "type": "string"
@ -103,7 +103,7 @@
}, },
"properties": { "properties": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Defining+core.properties", "documentation": "https://lucene.apache.org/solr/guide/defining-core-properties.html",
"description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.", "description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.",
"additionalProperties": true "additionalProperties": true
}, },
@ -117,7 +117,7 @@
] ]
}, },
"create-alias": { "create-alias": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api4", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#createalias",
"description": "Allows one or more collections to be known by another name. If this command is used on an existing alias, the existing alias will be replaced with the new collection details.", "description": "Allows one or more collections to be known by another name. If this command is used on an existing alias, the existing alias will be replaced with the new collection details.",
"type": "object", "type": "object",
"properties": { "properties": {
@ -143,7 +143,7 @@
] ]
}, },
"delete-alias": { "delete-alias": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api5", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deletealias",
"description": "Deletes a collection alias", "description": "Deletes a collection alias",
"type": "object", "type": "object",
"properties": { "properties": {
@ -159,7 +159,7 @@
"required":["name"] "required":["name"]
}, },
"backup-collection": { "backup-collection": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-Backup", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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", "type": "object",
"properties": { "properties": {
@ -187,7 +187,7 @@
] ]
}, },
"restore-collection": { "restore-collection": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-Restore", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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", "type": "object",
"properties": { "properties": {

12
solr/solrj/src/resources/apispec/collections.collection.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Several collection-level operations are supported with this endpoint: modify collection attributes; reload a collection; migrate documents to a different collection; rebalance collection leaders; balance properties across shards; and add or delete a replica property.", "description": "Several collection-level operations are supported with this endpoint: modify collection attributes; reload a collection; migrate documents to a different collection; rebalance collection leaders; balance properties across shards; and add or delete a replica property.",
"methods": [ "methods": [
"POST" "POST"
@ -19,7 +19,7 @@
}, },
"migrate-docs":{ "migrate-docs":{
"type":"object", "type":"object",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api12", "documentation":"https://lucene.apache.org/solr/guide/collections-api.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.", "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":{ "properties":{
"target":{ "target":{
@ -44,7 +44,7 @@
}, },
"balance-shard-unique":{ "balance-shard-unique":{
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-BalanceSliceUnique", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#balanceshardunique",
"description": "Insures 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.", "description": "Insures 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":{ "properties":{
"property":{ "property":{
@ -65,7 +65,7 @@
}, },
"rebalance-leaders" :{ "rebalance-leaders" :{
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-RebalanceLeaders", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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":{ "properties":{
"maxAtOnce":{ "maxAtOnce":{
@ -80,7 +80,7 @@
} }
}, },
"add-replica-property": { "add-replica-property": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-AddReplicaProp", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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", "type": "object",
"properties": { "properties": {
@ -115,7 +115,7 @@
}, },
"delete-replica-property": { "delete-replica-property": {
"description": "Deletes an arbitrary property from a particular replica", "description": "Deletes an arbitrary property from a particular replica",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-DeleteReplicaProp", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#deletereplicaprop",
"type": "object", "type": "object",
"properties": { "properties": {
"shard": { "shard": {

8
solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json
View File

@ -1,11 +1,11 @@
{ {
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-modifycoll", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#modifycollection",
"description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.", "description":"Modifies specific attributes of a collection. Multiple attributes can be changed at one time.",
"type": "object", "type": "object",
"properties":{ "properties":{
"rule": { "rule": {
"type": "array", "type": "array",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "Modifies the rules for where replicas should be located in a cluster.", "description": "Modifies the rules for where replicas should be located in a cluster.",
"items": { "items": {
"type": "string" "type": "string"
@ -13,7 +13,7 @@
}, },
"snitch": { "snitch": {
"type": "array", "type": "array",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Rule-based+Replica+Placement", "documentation": "https://lucene.apache.org/solr/guide/rule-based-replica-placement.html",
"description": "Details of the snitch provider", "description": "Details of the snitch provider",
"items": { "items": {
"type": "string" "type": "string"
@ -21,7 +21,7 @@
}, },
"autoAddReplicas": { "autoAddReplicas": {
"type": "boolean", "type": "boolean",
"description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://cwiki.apache.org/confluence/display/solr/Running+Solr+on+HDFS for more details on settings and overrides." "description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://lucene.apache.org/solr/guide/running-solr-on-hdfs.html for more details on settings and overrides."
}, },
"replicationFactor": { "replicationFactor": {
"type": "integer", "type": "integer",

2
solr/solrj/src/resources/apispec/collections.collection.Commands.reload.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api2", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#reload",
"description": "Reloads a collection so new configuration changes can take effect and be available for use by the system.", "description": "Reloads a collection so new configuration changes can take effect and be available for use by the system.",
"type" : "object", "type" : "object",
"properties":{ "properties":{

2
solr/solrj/src/resources/apispec/collections.collection.delete.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api6", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#delete",
"description": "Deletes a collection.", "description": "Deletes a collection.",
"methods": [ "methods": [
"DELETE" "DELETE"

2
solr/solrj/src/resources/apispec/collections.collection.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#list",
"description": "Lists all collections, with details on shards and replicas in each collection.", "description": "Lists all collections, with details on shards and replicas in each collection.",
"methods": [ "methods": [
"GET" "GET"

12
solr/solrj/src/resources/apispec/collections.collection.shards.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Allows you to create a shard, split an existing shard or add a new replica.", "description": "Allows you to create a shard, split an existing shard or add a new replica.",
"methods": [ "methods": [
"POST" "POST"
@ -13,7 +13,7 @@
"commands": { "commands": {
"split": { "split": {
"type" : "object", "type" : "object",
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api3", "documentation":"https://lucene.apache.org/solr/guide/collections-api.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 shard name as the basis for their names, adding an underscore and a number to differentiate the new shard. For example, 'shard1' would become 'shard1_0' and 'shard1_1'. Note that this operation can take a long time to complete.", "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 shard name as the basis for their names, adding an underscore and a number to differentiate the new shard. For example, 'shard1' would become 'shard1_0' and 'shard1_1'. Note that this operation can take a long time to complete.",
"properties": { "properties": {
"shard":{ "shard":{
@ -30,7 +30,7 @@
}, },
"coreProperties":{ "coreProperties":{
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Defining+core.properties", "documentation": "https://lucene.apache.org/solr/guide/defining-core-properties.html",
"description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.", "description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.",
"additionalProperties":true "additionalProperties":true
}, },
@ -56,7 +56,7 @@
}, },
"coreProperties": { "coreProperties": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Defining+core.properties", "documentation": "https://lucene.apache.org/solr/guide/defining-core-properties.html",
"description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.", "description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set, the node name, the data directory, among others.",
"additionalProperties": true "additionalProperties": true
}, },
@ -68,7 +68,7 @@
"required":["shard"] "required":["shard"]
}, },
"add-replica": { "add-replica": {
"documentation":"https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api_addreplica", "documentation":"https://lucene.apache.org/solr/guide/collections-api.html#addreplica",
"description": "", "description": "",
"type" : "object", "type" : "object",
"properties": { "properties": {
@ -94,7 +94,7 @@
}, },
"coreProperties": { "coreProperties": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Defining+core.properties", "documentation": "https://lucene.apache.org/solr/guide/defining-core-properties.html",
"description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set and the node name, among others.", "description": "Allows adding core.properties for the collection. Some examples of core properties you may want to modify include the config set and the node name, among others.",
"additionalProperties": true "additionalProperties": true
}, },

4
solr/solrj/src/resources/apispec/collections.collection.shards.shard.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html",
"description": "Commands to force leader election and synchronize shards.", "description": "Commands to force leader election and synchronize shards.",
"methods": [ "methods": [
"POST", "POST",
@ -13,7 +13,7 @@
}, },
"commands": { "commands": {
"force-leader": { "force-leader": {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-ForceLeader", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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", "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" "type": "object"
}, },

2
solr/solrj/src/resources/apispec/collections.collection.shards.shard.delete.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api7", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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": [ "methods": [
"DELETE" "DELETE"

2
solr/solrj/src/resources/apispec/collections.collection.shards.shard.replica.delete.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api9", "documentation": "https://lucene.apache.org/solr/guide/collections-api.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.", "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": [ "methods": [
"DELETE" "DELETE"

2
solr/solrj/src/resources/apispec/collections.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1", "documentation": "https://lucene.apache.org/solr/guide/collections-api.html#list",
"description": "List all available collections and their properties.", "description": "List all available collections and their properties.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.RealtimeGet.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/RealTime+Get", "documentation": "https://lucene.apache.org/solr/guide/realtime-get.html",
"description": "RealTime Get allows retrieving documents by ID before the documents have been committed to the index. It is useful when you need access to documents as soon as they are indexed but your commit times are high for other reasons.", "description": "RealTime Get allows retrieving documents by ID before the documents have been committed to the index. It is useful when you need access to documents as soon as they are indexed but your commit times are high for other reasons.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.SchemaEdit.addCopyField.json
View File

@ -1,5 +1,5 @@
{ {
"documentation" : "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-AddaNewCopyFieldRule", "documentation" : "https://lucene.apache.org/solr/guide/schema-api.html#add-a-new-copy-field-rule",
"description": "Adds a new copy field rule, to allow one field to be populated with the contents of one or more other fields.", "description": "Adds a new copy field rule, to allow one field to be populated with the contents of one or more other fields.",
"type": "object", "type": "object",
"properties": { "properties": {

4
solr/solrj/src/resources/apispec/core.SchemaEdit.addField.json
View File

@ -1,5 +1,5 @@
{ {
"documentation" :"https://cwiki.apache.org/confluence/display/solr/Schema+API", "documentation" :"https://lucene.apache.org/solr/guide/schema-api.html",
"type":"object", "type":"object",
"properties":{ "properties":{
"name": { "name": {
@ -78,7 +78,7 @@
}, },
"docValues": { "docValues": {
"type": "boolean", "type": "boolean",
"description": "If true, field values will be stored in a column-oriented docValues structure. This can be more efficient for some fields, particularly those used for faceting. More information is available from https://cwiki.apache.org/confluence/display/solr/DocValues. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all non-text fields (such as dates, integers, longs, etc.)." "description": "If true, field values will be stored in a column-oriented docValues structure. This can be more efficient for some fields, particularly those used for faceting. More information is available from https://lucene.apache.org/solr/guide/docvalues.html. If this is not defined, it will inherit the value from the fieldType. If the fieldType does not define a value, it will default to true for all non-text fields (such as dates, integers, longs, etc.)."
}, },
"termPayloads": { "termPayloads": {
"type": "boolean", "type": "boolean",

2
solr/solrj/src/resources/apispec/core.SchemaEdit.addFieldType.json
View File

@ -37,7 +37,7 @@
}, },
"multiTermAnalyzer": { "multiTermAnalyzer": {
"description": "A multiterm analyzer section defines how incoming queries that results in Multi-Term expansion will be analyzed for a field of this type.", "description": "A multiterm analyzer section defines how incoming queries that results in Multi-Term expansion will be analyzed for a field of this type.",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Analyzers#Analyzers-AnalysisforMulti-TermExpansion", "documentation": "https://lucene.apache.org/solr/guide/analyzers.html#analysis-for-multi-term-expansion",
"#include": "core.SchemaEdit.addFieldType.analyzers" "#include": "core.SchemaEdit.addFieldType.analyzers"
}, },
"analyzer": { "analyzer": {

2
solr/solrj/src/resources/apispec/core.SchemaEdit.deleteCopyField.json
View File

@ -1,6 +1,6 @@
{ {
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaCopyFieldRule", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html#delete-a-copy-field-rule",
"description": "Deletes a copy field rule. Both sides of the copy rule (source and destination) are required in order to delete the rule.", "description": "Deletes a copy field rule. Both sides of the copy rule (source and destination) are required in order to delete the rule.",
"properties":{ "properties":{
"source": { "source": {

2
solr/solrj/src/resources/apispec/core.SchemaEdit.deleteDynamicField.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaDynamicFieldRule", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html#delete-a-dynamic-field-rule",
"description": "Deletes a dynamic field.", "description": "Deletes a dynamic field.",
"type":"object", "type":"object",
"properties": { "properties": {

2
solr/solrj/src/resources/apispec/core.SchemaEdit.deleteField.json
View File

@ -1,5 +1,5 @@
{ {
"documentation" : "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaField", "documentation" : "https://lucene.apache.org/solr/guide/schema-api.html#delete-a-field",
"description": "Deletes a field from the schema.", "description": "Deletes a field from the schema.",
"type":"object", "type":"object",
"properties":{ "properties":{

2
solr/solrj/src/resources/apispec/core.SchemaEdit.deleteFieldType.json
View File

@ -1,5 +1,5 @@
{ {
"documentation":"https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-DeleteaFieldType", "documentation":"https://lucene.apache.org/solr/guide/schema-api.html#delete-a-field-type",
"description": "Deletes a field type from the schema.", "description": "Deletes a field type from the schema.",
"type":"object", "type":"object",
"properties": { "properties": {

4
solr/solrj/src/resources/apispec/core.SchemaEdit.json
View File

@ -1,6 +1,6 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html",
"description": "The Schema API provides viewing, editing, adding, and deleting elements of Solr's schema. This API can only be used if Managed Schema is enabled and the schema is defined as mutable. See https://cwiki.apache.org/confluence/display/solr/Schema+Factory+Definition+in+SolrConfig for more information about enabling Managed Schema.", "description": "The Schema API provides viewing, editing, adding, and deleting elements of Solr's schema. This API can only be used if Managed Schema is enabled and the schema is defined as mutable. See https://lucene.apache.org/solr/guide/schema-factory-definition-in-solrconfig.html for more information about enabling Managed Schema.",
"methods": [ "methods": [
"POST" "POST"
], ],

2
solr/solrj/src/resources/apispec/core.SchemaRead.copyFields.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-ListCopyFields", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html#list-copy-fields",
"description": "Lists all copy fields.", "description": "Lists all copy fields.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.SchemaRead.dynamicFields_fieldTypes.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html",
"methods": [ "methods": [
"GET" "GET"
], ],

2
solr/solrj/src/resources/apispec/core.SchemaRead.fields.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API#SchemaAPI-ListFields", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html#list-fields",
"description": "Get only the fields defined in the schema.", "description": "Get only the fields defined in the schema.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.SchemaRead.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API", "documentation": "https://lucene.apache.org/solr/guide/schema-api.html",
"methods": [ "methods": [
"GET" "GET"
], ],

2
solr/solrj/src/resources/apispec/core.Update.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Schema+API", "documentation": "https://lucene.apache.org/solr/guide/uploading-data-with-index-handlers.html",
"methods": [ "methods": [
"POST" "POST"
], ],

6
solr/solrj/src/resources/apispec/core.config.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API", "documentation": "https://lucene.apache.org/solr/guide/config-api.html",
"description": "The Config API enables manipulating various aspects of your solrconfig.xml using REST-like API calls. All properties set with this API update a file called configoverlay.json, but not the solrconfig.xml file itself.", "description": "The Config API enables manipulating various aspects of your solrconfig.xml using REST-like API calls. All properties set with this API update a file called configoverlay.json, but not the solrconfig.xml file itself.",
"methods": [ "methods": [
"POST" "POST"
@ -12,13 +12,13 @@
"commands": { "commands": {
"set-property:": { "set-property:": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API#ConfigAPI-Commandstomodifytheconfig", "documentation": "https://lucene.apache.org/solr/guide/config-api.html#commands-to-modify-the-config",
"description": "Sets one or more of several pre-defined properties. These properties set cache sizes and classes, commit rules, JMX settings, and request dispatcher settings. See the documentation for the list of properties that are supported. If a property is set that already exists, it will be overwritten.", "description": "Sets one or more of several pre-defined properties. These properties set cache sizes and classes, commit rules, JMX settings, and request dispatcher settings. See the documentation for the list of properties that are supported. If a property is set that already exists, it will be overwritten.",
"additionalProperties": true "additionalProperties": true
}, },
"unset-property": { "unset-property": {
"type":"array", "type":"array",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API#ConfigAPI-Commandstomodifytheconfig", "documentation": "https://lucene.apache.org/solr/guide/config-api.html#commands-to-modify-the-config",
"description": "Removes one or more of several pre-defined properties. These properties set cache sizes and classes, commit rules, JMX settings, and request dispatcher settings. See the documentation for the list of properties that are supported. The value of the property does not need to be defined with the list of properties, only the name of the property.", "description": "Removes one or more of several pre-defined properties. These properties set cache sizes and classes, commit rules, JMX settings, and request dispatcher settings. See the documentation for the list of properties that are supported. The value of the property does not need to be defined with the list of properties, only the name of the property.",
"items": { "items": {
"type": "string" "type": "string"

2
solr/solrj/src/resources/apispec/core.config.Commands.runtimeLib.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Adding+Custom+Plugins+in+SolrCloud+Mode", "documentation": "https://lucene.apache.org/solr/guide/adding-custom-plugins-in-solrcloud-mode.html",
"description": "Allows you to register .jars that have been uploaded to the .system collection in Solr. Note that uploading the .jar must occur before using this API.", "description": "Allows you to register .jars that have been uploaded to the .system collection in Solr. Note that uploading the .jar must occur before using this API.",
"type": "object", "type": "object",
"properties": { "properties": {

2
solr/solrj/src/resources/apispec/core.config.Params.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Request+Parameters+API", "documentation": "https://lucene.apache.org/solr/guide/request-parameters-api.html",
"description": "Create, update and delete request parameter sets (paramsets) to override or replace parameters defined in solrconfig.xml. Parameter sets are used with request handlers by setting the useParams attribute to the paramset name in the definition of the request handler or with individual requests to Solr. Parameter sets defined with this API are stored in a file params.json in ZooKeeper or on the filesystem when not using SolrCloud. Note this API does not directly update solrconfig.xml. ", "description": "Create, update and delete request parameter sets (paramsets) to override or replace parameters defined in solrconfig.xml. Parameter sets are used with request handlers by setting the useParams attribute to the paramset name in the definition of the request handler or with individual requests to Solr. Parameter sets defined with this API are stored in a file params.json in ZooKeeper or on the filesystem when not using SolrCloud. Note this API does not directly update solrconfig.xml. ",
"methods": [ "methods": [
"POST" "POST"

2
solr/solrj/src/resources/apispec/core.config.Params.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Request+Parameters+API", "documentation": "https://lucene.apache.org/solr/guide/request-parameters-api.html",
"description": "List all parameter sets (paramsets). Individual paramsets can be requested by paramset name.", "description": "List all parameter sets (paramsets). Individual paramsets can be requested by paramset name.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.config.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API", "documentation": "https://lucene.apache.org/solr/guide/config-api.html",
"description": "Gets the Solr configuration for a collection.", "description": "Gets the Solr configuration for a collection.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.system.blob.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Blob+Store+API", "documentation": "https://lucene.apache.org/solr/guide/blob-store-api.html",
"description": "Lists blobs in the blob store (the .system collection). The list can be limited by name or name and version.", "description": "Lists blobs in the blob store (the .system collection). The list can be limited by name or name and version.",
"methods": [ "methods": [
"GET" "GET"

2
solr/solrj/src/resources/apispec/core.system.blob.upload.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/Blob+Store+API", "documentation": "https://lucene.apache.org/solr/guide/blob-store-api.html",
"description": "Uploads a blob to the blob store. Note that the blob store is a specially named collection (which must be '.system') which must be created before uploading a blob to it.", "description": "Uploads a blob to the blob store. Note that the blob store is a specially named collection (which must be '.system') which must be created before uploading a blob to it.",
"methods": [ "methods": [
"POST" "POST"

8
solr/solrj/src/resources/apispec/cores.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html",
"description": "Actions on non-specific cores. See the /cores/{core} endpoint for actions on specific, named, cores.", "description": "Actions on non-specific cores. See the /cores/{core} endpoint for actions on specific, named, cores.",
"methods": [ "methods": [
"POST" "POST"
@ -12,7 +12,7 @@
"commands": { "commands": {
"create": { "create": {
"type" : "object", "type" : "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-CREATE", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-create",
"description": "Creates a new core. If you are using SolrCloud, you should use the Collections API instead. While a core for a SolrCloud cluster can be created with this API, it is considered an expert-level action. The Collections API has commands for creating new shards and replicas that ensure the safety of those actions within your cluster.", "description": "Creates a new core. If you are using SolrCloud, you should use the Collections API instead. While a core for a SolrCloud cluster can be created with this API, it is considered an expert-level action. The Collections API has commands for creating new shards and replicas that ensure the safety of those actions within your cluster.",
"properties": { "properties": {
"name": { "name": {
@ -37,7 +37,7 @@
}, },
"configSet": { "configSet": {
"type": "string", "type": "string",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+Sets", "documentation": "https://lucene.apache.org/solr/guide/config-sets.html",
"description": "The name of a config set to use. The config set must already exist. The solr.xml file defines the location of the configset base directory, and configuration files can be shared between cores by defining sub-directories. The files in the named configSet will be used for the schema and config properties instead of defining them explicitly." "description": "The name of a config set to use. The config set must already exist. The solr.xml file defines the location of the configset base directory, and configuration files can be shared between cores by defining sub-directories. The files in the named configSet will be used for the schema and config properties instead of defining them explicitly."
}, },
"loadOnStartup": { "loadOnStartup": {
@ -60,7 +60,7 @@
}, },
"props": { "props": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/Defining+core.properties", "documentation": "https://lucene.apache.org/solr/guide/defining-core-properties.html",
"description": "Allows adding core.properties for the collection.", "description": "Allows adding core.properties for the collection.",
"additionalProperties": true "additionalProperties": true
}, },

2
solr/solrj/src/resources/apispec/cores.Status.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-STATUS", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-status",
"description": "Provides status and other information about the status of each core. Individual cores can be requested by core name.", "description": "Provides status and other information about the status of each core. Individual cores can be requested by core name.",
"methods": [ "methods": [
"GET" "GET"

14
solr/solrj/src/resources/apispec/cores.core.Commands.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html",
"description": "Actions that are peformed on individual cores, such as reloading, swapping cores, renaming, and others.", "description": "Actions that are peformed on individual cores, such as reloading, swapping cores, renaming, and others.",
"methods": [ "methods": [
"POST" "POST"
@ -12,12 +12,12 @@
"commands": { "commands": {
"reload": { "reload": {
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-RELOAD", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-reload",
"description": "Reloads a core. This is useful when you have made changes on disk such as editing the schema or solrconfig.xml files. Most APIs reload cores automatically, so this should not be necessary if changes were made with those APIs." "description": "Reloads a core. This is useful when you have made changes on disk such as editing the schema or solrconfig.xml files. Most APIs reload cores automatically, so this should not be necessary if changes were made with those APIs."
}, },
"swap": { "swap": {
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-SWAP", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-swap",
"description": "Swaps the names of two existing Solr cores. This can be used to swap new content into production. The former core can be swapped back if necessary. Using this API is not supported in SolrCloud mode.", "description": "Swaps the names of two existing Solr cores. This can be used to swap new content into production. The former core can be swapped back if necessary. Using this API is not supported in SolrCloud mode.",
"properties": { "properties": {
"with": { "with": {
@ -35,7 +35,7 @@
}, },
"rename": { "rename": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-RENAME", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-rename",
"description": "Change the name of a core.", "description": "Change the name of a core.",
"properties": { "properties": {
"to": { "to": {
@ -53,7 +53,7 @@
}, },
"unload": { "unload": {
"type": "object", "type": "object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-UNLOAD", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-unload",
"description": "Removes a core. Active requests would continue to be processed, but new requests will not be sent to the new core. If a core is registered under more than one name, only the name given in the request is removed.", "description": "Removes a core. Active requests would continue to be processed, but new requests will not be sent to the new core. If a core is registered under more than one name, only the name given in the request is removed.",
"properties": { "properties": {
"deleteIndex": { "deleteIndex": {
@ -79,7 +79,7 @@
}, },
"merge-indexes": { "merge-indexes": {
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-MERGEINDEXES", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-mergeindexes",
"description":"Merges one or more indexes to another index. The indexes must have completed commits, and should be locked against writes until the merge is complete to avoid index corruption. The target core (which is the core that should be used as the endpoint for this command) must exist before using this command. A commit should also be performed on this core after the merge is complete.", "description":"Merges one or more indexes to another index. The indexes must have completed commits, and should be locked against writes until the merge is complete to avoid index corruption. The target core (which is the core that should be used as the endpoint for this command) must exist before using this command. A commit should also be performed on this core after the merge is complete.",
"properties": { "properties": {
"indexDir": { "indexDir": {
@ -105,7 +105,7 @@
"split": { "#include": "cores.core.Commands.split"}, "split": { "#include": "cores.core.Commands.split"},
"request-recovery": { "request-recovery": {
"type":"object", "type":"object",
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-REQUESTRECOVERY", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-requestrecovery",
"description": "Manually asks a core to recover by synching with a leader. It may help SolrCloud clusters where a node refuses to come back up. However, it is considered an expert-level command, and should be used very carefully." "description": "Manually asks a core to recover by synching with a leader. It may help SolrCloud clusters where a node refuses to come back up. However, it is considered an expert-level command, and should be used very carefully."
}, },
"force-prepare-for-leadership": { "force-prepare-for-leadership": {

2
solr/solrj/src/resources/apispec/cores.core.Commands.split.json
View File

@ -1,5 +1,5 @@
{ {
"documentation": "https://cwiki.apache.org/confluence/display/solr/CoreAdmin+API#CoreAdminAPI-SPLIT", "documentation": "https://lucene.apache.org/solr/guide/coreadmin-api.html#coreadmin-split",
"description": "Allows splitting an index into two or more new indexes.", "description": "Allows splitting an index into two or more new indexes.",
"type": "object", "type": "object",
"properties": { "properties": {