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 2016/12/13 15:38:30 UTC
[3/4] lucene-solr:apiv2: Update Config API specs with descriptions
and docs
Update Config API specs with descriptions and docs
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/edea14f3
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/edea14f3
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/edea14f3
Branch: refs/heads/apiv2
Commit: edea14f33ea5b138c179044690a67d8406ef14d5
Parents: e7e8c65
Author: Cassandra Targett <ct...@apache.org>
Authored: Mon Dec 12 16:11:53 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Mon Dec 12 16:11:53 2016 -0600
----------------------------------------------------------------------
...ig.Commands.addRequestHandler.properties.json | 12 ++++++++----
.../core.config.Commands.addRuntimeLib.json | 10 +++++-----
.../apispec/core.config.Commands.generic.json | 17 +++++++++++++----
.../resources/apispec/core.config.Commands.json | 19 +++++++++++++++++--
.../core.config.Commands.updateRuntimeLib.json | 10 +++++-----
solr/core/src/resources/apispec/core.config.json | 1 +
6 files changed, 49 insertions(+), 20 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.Commands.addRequestHandler.properties.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Commands.addRequestHandler.properties.json b/solr/core/src/resources/apispec/core.config.Commands.addRequestHandler.properties.json
index 9994449..731c3d8 100644
--- a/solr/core/src/resources/apispec/core.config.Commands.addRequestHandler.properties.json
+++ b/solr/core/src/resources/apispec/core.config.Commands.addRequestHandler.properties.json
@@ -2,20 +2,24 @@
"type": "object",
"properties": {
"name": {
- "type": "string"
+ "type": "string",
+ "description": "The name of the request handler. This name will be used to update or remove the request handler later if necessary."
},
"class": {
- "type": "string"
+ "type": "string",
+ "description": "The request handler class. Class names do not need to be fully qualified if they are included with Solr, so you can abbreviate the name as 'solr.SearchHandler'. Custom or third-party class names may need to be fully qualified, however."
},
"runtimeLib": {
- "type": "boolean"
+ "type": "boolean",
+ "description": "An optional parameter to use a custom .jar file that has been uploaded to Solr's blobstore. This additionally requires that the .jar has also been registered with the 'add-runtimelib' command, which is one of the available commands for the Config API."
},
"startup": {
"type": "string",
+ "description": "Allows the request handler to only start when requested. The only option is 'lazy'.",
"enum": [
"lazy"
]
}
},
"additionalProperties": true
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.Commands.addRuntimeLib.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Commands.addRuntimeLib.json b/solr/core/src/resources/apispec/core.config.Commands.addRuntimeLib.json
index d95f502..8e2fb2d 100644
--- a/solr/core/src/resources/apispec/core.config.Commands.addRuntimeLib.json
+++ b/solr/core/src/resources/apispec/core.config.Commands.addRuntimeLib.json
@@ -1,23 +1,23 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Adding+Custom+Plugins+in+SolrCloud+Mode",
- "description": "",
+ "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",
"properties": {
"name": {
- "description": "Name of the jar blob in .system collection",
+ "description": "The name of the .jar blob in .system collection. This is the name you provided when you uploaded it.",
"type": "string"
},
"version": {
"type": "integer",
- "description": "The version of the blob in .system colection"
+ "description": "The version of the blob in .system collection. Be sure to use the correct version if you have multiple versions of the same .jar uploaded."
},
"sig": {
"type": "string",
- "description": "sha1 signature of the jar"
+ "description": "The sha1 signature of the .jar, if it was signed before uploading. If you signed the sha1 digest of your .jar file prior to uploading it to the .system collection, this is where you need to provide the signature."
}
},
"required": [
"name",
"version"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.Commands.generic.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Commands.generic.json b/solr/core/src/resources/apispec/core.config.Commands.generic.json
index 51b8fdf..9d2b01d 100644
--- a/solr/core/src/resources/apispec/core.config.Commands.generic.json
+++ b/solr/core/src/resources/apispec/core.config.Commands.generic.json
@@ -1,10 +1,19 @@
{
"type": "object",
"properties": {
- "name": { "type": "string"},
- "class": { "type": "string"},
- "runtimeLib": { "type": "boolean"}
+ "name": {
+ "type": "string",
+ "description": "The name of this configuration item. This name will be used to update or remove this later if necessary."
+ },
+ "class": {
+ "type": "string",
+ "description": "The configuration item class. Class names do not need to be fully qualified if they are included with Solr, so you can abbreviate the name as 'solr.SearchHandler'. Custom or third-party class names may need to be fully qualified, however."
+ },
+ "runtimeLib": {
+ "type": "boolean",
+ "description": "An optional parameter to use a custom .jar file that has been uploaded to Solr's blobstore. This additionally requires that the .jar has also been registered with the 'add-runtimelib' command, which is one of the available commands for the Config API."
+ }
},
"required": [ "name", "class"],
"additionalProperties": true
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.Commands.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Commands.json b/solr/core/src/resources/apispec/core.config.Commands.json
index f4e0687..e7d54ac 100644
--- a/solr/core/src/resources/apispec/core.config.Commands.json
+++ b/solr/core/src/resources/apispec/core.config.Commands.json
@@ -1,6 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API",
- "description": "The Config API enables manipulating various aspects of your solrconfig.xml using REST-like API calls.",
+ "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": [
"POST"
],
@@ -12,10 +12,14 @@
"commands": {
"set-property:": {
"type": "object",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API#ConfigAPI-Commandstomodifytheconfig",
+ "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
},
"unset-property": {
"type":"array",
+ "documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API#ConfigAPI-Commandstomodifytheconfig",
+ "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": {
"type": "string"
}
@@ -35,6 +39,7 @@
},
"delete-requesthandler": {
"type": "array",
+ "description": "Deletes one or more request handlers, using the name given when the request handler was created. Define more than one request handler by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -47,6 +52,7 @@
},
"delete-searchcomponent": {
"type": "array",
+ "description": "Deletes one or more search components, using the name given when the search component was created. Define more than one search component by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -61,6 +67,7 @@
},
"delete-initparams": {
"type": "array",
+ "description": "Deletes one or more init params, using the name given when the init param set was created. Define more than one init params by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -73,6 +80,7 @@
},
"delete-queryresponsewriter": {
"type": "array",
+ "description": "Deletes one or more query response writers, using the name given when the response writer was created. Define more than one response writer by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -84,7 +92,8 @@
"#include": "core.config.Commands.generic"
},
"delete-queryparser": {
- "type": "string"
+ "type": "string",
+ "description": "Deletes one or more query parsers, using the name given when the query parser was created. Define more than one query parser by separating the list of names with commas.",
},
"add-valuesourceparser": {
"#include": "core.config.Commands.generic"
@@ -94,6 +103,7 @@
},
"delete-valuesourceparser": {
"type": "array",
+ "description": "Deletes one or more ValueSourceParsers, using the name given when the ValueSourceParser was created. Define more than one ValueSourceParsers by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -106,6 +116,7 @@
},
"delete-transformer": {
"type": "array",
+ "description": "Deletes one or more document transformers, using the name given when the document transformer was created. Define more than one document transformers by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -118,6 +129,7 @@
},
"delete-updateprocessor": {
"type": "array",
+ "description": "Deletes one or more update processors, using the name given when the update processor was created. Define more than one update processors by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -130,6 +142,7 @@
},
"delete-queryconverter": {
"type": "array",
+ "description": "Deletes one or more query converters, using the name given when the query converter was created. Define more than one query converters by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -144,6 +157,7 @@
},
"delete-listener": {
"type": "array",
+ "description": "Deletes one or more listeners, using the name given when the listener was created. Define more than one listener by separating the list of names with commas.",
"items": {
"type": "string"
}
@@ -156,6 +170,7 @@
},
"delete-runtimelib": {
"type":"array",
+ "description": "Deletes one or more runtime libraries (runtimeLibs), using the name given when the runtimeLib was created. Define more than one runtimeLibs by separating the list of names with commas.",
"items": {
"type": "string"
}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.Commands.updateRuntimeLib.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Commands.updateRuntimeLib.json b/solr/core/src/resources/apispec/core.config.Commands.updateRuntimeLib.json
index d95f502..9d4df5b 100644
--- a/solr/core/src/resources/apispec/core.config.Commands.updateRuntimeLib.json
+++ b/solr/core/src/resources/apispec/core.config.Commands.updateRuntimeLib.json
@@ -1,23 +1,23 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Adding+Custom+Plugins+in+SolrCloud+Mode",
- "description": "",
+ "description": "Updates the registration of a .jar with the system.",
"type": "object",
"properties": {
"name": {
- "description": "Name of the jar blob in .system collection",
+ "description": "The name of the .jar blob in .system collection. This is the name you provided when you uploaded it.",
"type": "string"
},
"version": {
"type": "integer",
- "description": "The version of the blob in .system colection"
+ "description": "The version of the blob in .system collection. Be sure to use the correct version if you have multiple versions of the same .jar uploaded."
},
"sig": {
"type": "string",
- "description": "sha1 signature of the jar"
+ "description": "The sha1 signature of the .jar, if it was signed before uploading. If you signed the sha1 digest of your .jar file prior to uploading it to the .system collection, this is where you need to provide the signature."
}
},
"required": [
"name",
"version"
]
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/edea14f3/solr/core/src/resources/apispec/core.config.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.json b/solr/core/src/resources/apispec/core.config.json
index 0645967..2633fd9 100644
--- a/solr/core/src/resources/apispec/core.config.json
+++ b/solr/core/src/resources/apispec/core.config.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Config+API",
+ "description": "Gets the Solr configuration for a collection.",
"methods": [
"GET"
],