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:31 UTC
[4/4] lucene-solr:apiv2: Update Request Params APIs with descriptions
Update Request Params APIs with descriptions
Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/1bbbe678
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/1bbbe678
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/1bbbe678
Branch: refs/heads/apiv2
Commit: 1bbbe678f1d9fb38f3fe4005a8d899241ab18217
Parents: edea14f
Author: Cassandra Targett <ct...@apache.org>
Authored: Tue Dec 13 09:37:20 2016 -0600
Committer: Cassandra Targett <ct...@apache.org>
Committed: Tue Dec 13 09:37:20 2016 -0600
----------------------------------------------------------------------
.../resources/apispec/core.config.Params.Commands.json | 11 ++++++-----
solr/core/src/resources/apispec/core.config.Params.json | 1 +
2 files changed, 7 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/1bbbe678/solr/core/src/resources/apispec/core.config.Params.Commands.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Params.Commands.json b/solr/core/src/resources/apispec/core.config.Params.Commands.json
index fd968b1..474f1a6 100644
--- a/solr/core/src/resources/apispec/core.config.Params.Commands.json
+++ b/solr/core/src/resources/apispec/core.config.Params.Commands.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Request+Parameters+API",
+ "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": [
"POST"
],
@@ -11,20 +12,20 @@
"commands": {
"set:": {
"type":"object",
- "description":"add or overwrite one or more param sets",
+ "description":"Add or overwrite one or more paramsets. Each paramset definition includes a paramset name, followed by key-value pairs of the parameter and value to be set.",
"additionalProperties": true
},
"unset": {
"type":"array",
+ "description": "Delete one or more paramsets.",
"items": {
"type": "string"
- },
- "description": "delete one or more parameter sets"
+ }
},
"update": {
"type":"object",
- "description": "update one or more param sets",
+ "description": "Update one or more paramsets. This command will attempt to merge an existing paramset with the new values. Each paramset definition includes a paramset name, followed by key-value pairs of the parameters and values to be updated.",
"additionalProperties": true
}
}
-}
\ No newline at end of file
+}
http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/1bbbe678/solr/core/src/resources/apispec/core.config.Params.json
----------------------------------------------------------------------
diff --git a/solr/core/src/resources/apispec/core.config.Params.json b/solr/core/src/resources/apispec/core.config.Params.json
index b256e66..cff0350 100644
--- a/solr/core/src/resources/apispec/core.config.Params.json
+++ b/solr/core/src/resources/apispec/core.config.Params.json
@@ -1,5 +1,6 @@
{
"documentation": "https://cwiki.apache.org/confluence/display/solr/Request+Parameters+API",
+ "description": "List all parameter sets (paramsets). Individual paramsets can be requested by paramset name.",
"methods": [
"GET"
],