Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

Ref Guide: monospace parameter names for overall consistency

Cassandra Targett5bf487f8b4ae
diff --git a/solr/solr-ref-guide/src/configsets-api.adoc b/solr/solr-ref-guide/src/configsets-api.adoc
index 311018996c9..6c8a162b9c2 100644
--- a/solr/solr-ref-guide/src/configsets-api.adoc
+++ b/solr/solr-ref-guide/src/configsets-api.adoc
@@ -94,13 +94,13 @@ If you use any of these parameters or features, you must have enabled security f
The `upload` command takes the following parameters:
-name::
+`name`::
The configset to be created when the upload is complete. This parameter is required.
-overwrite::
+`overwrite`::
If set to `true`, Solr will overwrite an existing configset with the same name (if false, the request will fail). Default is `false`.
-cleanup::
+`cleanup`::
When overwriting an existing configset (`overwrite=true`), this parameter tells Solr to delete the files in ZooKeeper that existed in the old configset but not in the one being uploaded. Default is `false`.
The body of the request should be a zip file that contains the configset. The zip file must be created from within the `conf` directory (i.e., `solrconfig.xml` must be the top level entry in the zip file).
@@ -132,13 +132,13 @@ If you have not yet uploaded any configsets, see the <<Upload a Configset>> comm
The following parameters are supported when creating a configset.
-name::
+`name`::
The configset to be created. This parameter is required.
-baseConfigSet::
+`baseConfigSet`::
The name of the configset to copy as a base. This defaults to `_default`
-configSetProp._property_=_value_::
+`configSetProp._property_=_value_`::
A configset property from the base configset to override in the copied configset.
For example, to create a configset named "myConfigset" based on a previously defined "predefinedTemplate" configset, overriding the immutable property to false.
@@ -192,7 +192,7 @@ curl -X POST -H 'Content-type: application/json' -d '{
The `delete` command removes a configset. It does not remove any collections that were created with the configset.
-name::
+`name`::
The configset to be deleted. This parameter is required.
To delete a configset named "myConfigSet":