This is an automated email from the ASF dual-hosted git repository. asf-gitbox-commits pushed a commit to branch branch_10_1 in repository https://gitbox.apache.org/repos/asf/solr.git
commit 9ec1ec417085b27f024520de92664c5054fb7c97 Author: Serhiy Bzhezytskyy <[email protected]> AuthorDate: Sun Oct 4 16:10:42 2026 +0300 SOLR-18495: Use {name} placeholders for names in Ref Guide URLs (#5005) (cherry picked from commit def6679f4eca857cc9e79987660b98d7c034e7ce) (cherry picked from commit be3b3ae35166ba0f67415af00a1c6edf629683a6) --- .../configuration-guide/pages/collections-api.adoc | 2 +- .../configuration-guide/pages/coreadmin-api.adoc | 22 ++++++------- .../configuration-guide/pages/package-manager.adoc | 2 +- .../modules/configuration-guide/pages/v2-api.adoc | 16 ++++----- .../modules/deployment-guide/pages/python.adoc | 2 +- .../deployment-guide/pages/task-management.adoc | 14 ++++---- .../pages/user-managed-index-replication.adoc | 38 +++++++++++----------- .../getting-started/pages/about-this-guide.adoc | 3 ++ .../getting-started/pages/tutorial-solrcloud.adoc | 4 +-- .../indexing-guide/pages/date-formatting-math.adoc | 4 +-- .../pages/document-enrichment-with-llms.adoc | 12 +++---- .../modules/indexing-guide/pages/filters.adoc | 4 +-- .../indexing-guide/pages/indexing-with-cbor.adoc | 4 +-- .../pages/indexing-with-update-handlers.adoc | 16 ++++----- .../modules/indexing-guide/pages/reindexing.adoc | 2 +- .../query-guide/pages/exporting-result-sets.adoc | 12 +++---- .../query-guide/pages/function-queries.adoc | 4 +-- .../query-guide/pages/jdbc-dbvisualizer.adoc | 2 +- .../modules/query-guide/pages/jdbc-squirrel.adoc | 2 +- .../modules/query-guide/pages/jdbc-zeppelin.adoc | 2 +- .../modules/query-guide/pages/logs.adoc | 2 +- .../query-guide/pages/response-writers.adoc | 2 +- .../pages/stream-decorator-reference.adoc | 8 ++--- 23 files changed, 91 insertions(+), 88 deletions(-) diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc index b6991820be8..c2406b59788 100644 --- a/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc +++ b/solr/solr-ref-guide/modules/configuration-guide/pages/collections-api.adoc @@ -65,7 +65,7 @@ V2 API:: ==== [source,bash] ---- -curl http://localhost:8983/api/collections/collection1/shards -H 'Content-Type: application/json' -d ' +curl http://localhost:8983/api/collections/{collectionName}/shards -H 'Content-Type: application/json' -d ' { "split": { "shard": "shard1", diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc index 5ce880ba795..da6e63565d3 100644 --- a/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc +++ b/solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc @@ -111,7 +111,7 @@ The `CREATE` action creates a new core and registers it. If a Solr core with the given name already exists, it will continue to handle requests while the new core is initializing. When the new core is ready, it will take new requests and the old core will be unloaded. -`admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data` +`admin/cores?action=CREATE&name=\{coreName}&instanceDir=\{instanceDir}&config=solrconfig.xml&dataDir=data` [tabs#coreadmin-create-request] ====== V1 API:: @@ -127,7 +127,7 @@ http://localhost:8983/solr/admin/cores?action=CREATE&name=techproducts_v2&config If you have already existing core files deployed on disk, and need to just create the Solr core from them then the url will look something like [source,bash] ---- -http://localhost:8983/solr/admin/cores?action=CREATE&name=_core-name_&instanceDir=_path/to/dir_&config=solrconfig.xml&dataDir=data +http://localhost:8983/solr/admin/cores?action=CREATE&name={coreName}&instanceDir={instanceDir}&config=solrconfig.xml&dataDir=data ---- ==== @@ -352,7 +352,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/admin/cores?action=RENAME&core=currentCoreName&other=newCoreName"; +curl -X GET "http://localhost:8983/solr/admin/cores?action=RENAME&core={currentCoreName}&other=newCoreName"; ---- ==== V2 API:: @@ -360,7 +360,7 @@ V2 API:: ==== [source,bash] ---- -curl http://localhost:8983/api/cores/currentCoreName/rename -H 'Content-Type: application/json' -d ' +curl http://localhost:8983/api/cores/{currentCoreName}/rename -H 'Content-Type: application/json' -d ' { "to": "newCoreName" } @@ -416,7 +416,7 @@ V1 API:: ==== [source,bash] ---- -`admin/cores?action=SWAP&core=_core-name_&other=_other-core-name_` +`admin/cores?action=SWAP&core={coreName}&other={otherCoreName}` ---- ==== V2 API:: @@ -424,7 +424,7 @@ V2 API:: ==== [source,bash] ---- -curl http://localhost:8983/api/cores/_core-name_/swap -H 'Content-Type: application/json' -d ' +curl http://localhost:8983/api/cores/{coreName}/swap -H 'Content-Type: application/json' -d ' { "with": "_other-core-name_" } @@ -570,7 +570,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/admin/cores?action=MERGEINDEXES&core=targetCoreName&indexDir=path/to/core1/data/index&indexDir=path/to/core2/data/index"; +curl -X GET "http://localhost:8983/solr/admin/cores?action=MERGEINDEXES&core={targetCoreName}&indexDir=path/to/core1/data/index&indexDir=path/to/core2/data/index"; ---- ==== @@ -579,7 +579,7 @@ V2 API:: ==== [source,bash] ---- -curl http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Content-Type: application/json' -d ' +curl http://localhost:8983/api/cores/{targetCoreName}/merge-indices -H 'Content-Type: application/json' -d ' { "indexDirs": ["path/to/core1/data/index","path/to/core2/data/index"] } @@ -601,7 +601,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/admin/cores?action=mergeindexes&core=targetCoreName&srcCore=core1&srcCore=core2"; +curl -X GET "http://localhost:8983/solr/admin/cores?action=mergeindexes&core={targetCoreName}&srcCore=core1&srcCore=core2"; ---- ==== @@ -610,7 +610,7 @@ V2 API:: ==== [source,bash] ---- -curl http://localhost:8983/api/cores/targetCoreName/merge-indices -H 'Content-Type: application/json' -d ' +curl http://localhost:8983/api/cores/{targetCoreName}/merge-indices -H 'Content-Type: application/json' -d ' { "srcCores": ["core1","core2"] } @@ -949,7 +949,7 @@ http://localhost:8983/solr/admin/cores?action=REQUESTSTATUS&requestid=1 The `REQUESTRECOVERY` action manually asks a core to recover by syncing with the leader. This should be considered an "expert" level command and should be used in situations where the node (SorlCloud replica) is unable to become active automatically. -`admin/cores?action=REQUESTRECOVERY&core=_core-name_` +`admin/cores?action=REQUESTRECOVERY&core=\{coreName}` === REQUESTRECOVERY Parameters diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc index 4adb2fa4806..93c5d5882a8 100644 --- a/solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc +++ b/solr/solr-ref-guide/modules/configuration-guide/pages/package-manager.adoc @@ -140,7 +140,7 @@ If the collection is named `collection1`, the package name is `mypackage`, and t [source,bash] ---- -curl "http://localhost:8983/api/collections/collection1/config/params"; \ +curl "http://localhost:8983/api/collections/{collectionName}/config/params"; \ -H 'Content-type:application/json' -d "{set: {PKG_VERSIONS: {mypackage: '1.0.0'}}}" ---- diff --git a/solr/solr-ref-guide/modules/configuration-guide/pages/v2-api.adoc b/solr/solr-ref-guide/modules/configuration-guide/pages/v2-api.adoc index 7fcd600c7fb..26390f38c30 100644 --- a/solr/solr-ref-guide/modules/configuration-guide/pages/v2-api.adoc +++ b/solr/solr-ref-guide/modules/configuration-guide/pages/v2-api.adoc @@ -39,15 +39,15 @@ Following are some v2 API URL paths and path prefixes, along with some of the op |=== |Path prefix |Some Supported Operations |`/api/collections` |Create, alias, backup, and restore a collection. -|`/api/c/_collection-name_/update` |Update requests. -|`/api/c/_collection-name_/config` |Configuration requests. -|`/api/c/_collection-name_/schema` |Schema requests. -|`/api/c/_collection-name_/_handler-name_` |Handler-specific requests. -|`/api/c/_collection-name_/shards` |Split a shard, create a shard, add a replica. -|`/api/c/_collection-name_/shards/_shard-name_` |Delete a shard, force leader election -|`/api/c/_collection-name_/shards/_shard-name_/_replica-name_` |Delete a replica. +|`/api/c/\{collectionName}/update` |Update requests. +|`/api/c/\{collectionName}/config` |Configuration requests. +|`/api/c/\{collectionName}/schema` |Schema requests. +|`/api/c/\{collectionName}/\{handlerName}` |Handler-specific requests. +|`/api/c/\{collectionName}/shards` |Split a shard, create a shard, add a replica. +|`/api/c/\{collectionName}/shards/\{shardName}` |Delete a shard, force leader election +|`/api/c/\{collectionName}/shards/\{shardName}/\{replicaName}` |Delete a replica. |`/api/cores` |Create a core. -|`/api/cores/_core-name_` |Reload, rename, delete, and unload a core. +|`/api/cores/\{coreName}` |Reload, rename, delete, and unload a core. |`/api/node` |Perform overseer operation, rejoin leader election. |`/api/cluster` |List live nodes, add role, remove role, set cluster property. |=== diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/python.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/python.adoc index 0c94ef5606d..93fbab258dc 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/python.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/python.adoc @@ -24,7 +24,7 @@ JSON is the preferred interchange format for Python users, and Python has suppor ---- from urllib2 import * import json -connection = urlopen('http://localhost:8983/solr/collection_name/select?q=cheese&wt=json') +connection = urlopen('http://localhost:8983/solr/{collectionName}/select?q=cheese&wt=json') response = json.load(connection) print response['response']['numFound'], "documents found." diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc index 96033d67c6d..8693bb2dbe0 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/task-management.adoc @@ -49,7 +49,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/collectionName/tasks/list"; +curl -X GET "http://localhost:8983/solr/{collectionName}/tasks/list"; ---- ==== @@ -58,7 +58,7 @@ V2 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks"; +curl -X GET "http://localhost:8983/v2/collections/{collectionName}/tasks"; ---- ==== ====== @@ -117,7 +117,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/collectionName/tasks/cancel?queryUUID=5"; +curl -X GET "http://localhost:8983/solr/{collectionName}/tasks/cancel?queryUUID=5"; ---- ==== V2 API:: @@ -125,7 +125,7 @@ V2 API:: ==== [source,bash] ---- -curl -X DELETE "http://localhost:8983/v2/collections/collectionName/tasks/5"; +curl -X DELETE "http://localhost:8983/v2/collections/{collectionName}/tasks/5"; ---- ==== ====== @@ -214,7 +214,7 @@ V1 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/solr/collectionName/tasks/list?taskUUID=5"; +curl -X GET "http://localhost:8983/solr/{collectionName}/tasks/list?taskUUID=5"; ---- ==== @@ -223,14 +223,14 @@ V2 API:: ==== [source,bash] ---- -curl -X GET "http://localhost:8983/v2/collections/collectionName/tasks/5"; +curl -X GET "http://localhost:8983/v2/collections/{collectionName}/tasks/5"; ---- ==== ====== === taskUUID Parameter With the V1 API, the `taskUUID` request parameter specifies which task's status to check. -With the V2 API, the task ID is instead supplied as part of the path, e.g. `/v2/collections/collectionName/tasks/\{taskID}`. +With the V2 API, the task ID is instead supplied as part of the path, e.g. `/v2/collections/\{collectionName}/tasks/\{taskID}`. === Sample Response diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/user-managed-index-replication.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/user-managed-index-replication.adoc index 4191e3a27a6..259ce3d0430 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/user-managed-index-replication.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/user-managed-index-replication.adoc @@ -367,13 +367,13 @@ You can use the HTTP commands below to control the ReplicationHandler's operatio Enable replication on the "leader" for all its followers. + [source,bash] -http://_leader_host:port_/solr/_core_name_/replication?command=enablereplication +http://{leaderHost}:{port}/solr/{coreName}/replication?command=enablereplication `disablereplication`:: Disable replication on the leader for all its followers. + [source,bash] -http://_leader_host:port_/solr/_core_name_/replication?command=disablereplication +http://{leaderHost}:{port}/solr/{coreName}/replication?command=disablereplication `indexversion`:: Return the version of the latest replicatable index on the specified leader or follower. @@ -383,7 +383,7 @@ Return the version of the latest replicatable index on the specified leader or f [source,bash] ---- -http://_host:port_/solr/_core_name_/replication?command=indexversion +http://{host}:{port}/solr/{coreName}/replication?command=indexversion ---- ==== @@ -393,7 +393,7 @@ http://_host:port_/solr/_core_name_/replication?command=indexversion [source,bash] ---- -http://_host:port_/api/cores/_core_name_/replication/indexversion +http://{host}:{port}/api/cores/{coreName}/replication/indexversion ---- ==== @@ -402,7 +402,7 @@ http://_host:port_/api/cores/_core_name_/replication/indexversion Force the specified follower to fetch a copy of the index from its leader. + [source.bash] -http://_follower_host:port_/solr/_core_name_/replication?command=fetchindex +http://{followerHost}:{port}/solr/{coreName}/replication?command=fetchindex + You can pass an extra attribute such as `leaderUrl` or `compression` (or any other parameter described in <<Configuring a Follower Server>>) to do a one time replication from a leader. This removes the need for hard-coding the leader URL in the follower configuration. @@ -411,25 +411,25 @@ This removes the need for hard-coding the leader URL in the follower configurati Abort copying an index from a leader to the specified follower. + [source,bash] -http://_follower_host:port_/solr/_core_name_/replication?command=abortfetch +http://{followerHost}:{port}/solr/{coreName}/replication?command=abortfetch `enablepoll`:: Enable the specified follower to poll for changes on the leader. + [source,bash] -http://_follower_host:port_/solr/_core_name_/replication?command=enablepoll +http://{followerHost}:{port}/solr/{coreName}/replication?command=enablepoll `disablepoll`:: Disable the specified follower from polling for changes on the leader. + [source,bash] -http://_follower_host:port_/solr/_core_name_/replication?command=disablepoll +http://{followerHost}:{port}/solr/{coreName}/replication?command=disablepoll `details`:: Retrieve configuration details and current status. + [source,bash] -http://_follower_host:port_/solr/_core_name_/replication?command=details +http://{followerHost}:{port}/solr/{coreName}/replication?command=details `filelist`:: Retrieve a list of Lucene files present in the specified host's index. @@ -440,7 +440,7 @@ Retrieve a list of Lucene files present in the specified host's index. [source,bash] ---- -http://_host:port_/solr/_core_name_/replication?command=filelist&generation=<_generation-number_> +http://{host}:{port}/solr/{coreName}/replication?command=filelist&generation={generationNumber} ---- ==== @@ -450,7 +450,7 @@ http://_host:port_/solr/_core_name_/replication?command=filelist&generation=<_ge [source,bash] ---- -http://_host:port_/api/cores/_core_name_/replication/files?generation=<_generation-number_> +http://{host}:{port}/api/cores/{coreName}/replication/files?generation={generationNumber} ---- ==== @@ -466,7 +466,7 @@ Retrieve a stream of a specific file path of a core. [source,bash] ---- -http://_host:port_/solr/_core_name_/replication?command=filecontent&;<_directory-type_>=<_file-path_>&wt=filestream +http://{host}:{port}/solr/{coreName}/replication?command=filecontent&{directoryType}={filePath}&wt=filestream ---- ==== @@ -476,7 +476,7 @@ http://_host:port_/solr/_core_name_/replication?command=filecontent&;<_directory- [source,bash] ---- -http://_host:port_/api/cores/_core_name_/replication/files/<_file-path_>&dirType=<_directory-type_> +http://{host}:{port}/api/cores/{coreName}/replication/files/{filePath}&dirType={directoryType} ---- ==== @@ -506,7 +506,7 @@ There are several optional parameters: Create a backup on leader if there are committed index data in the server; otherwise, does nothing. + [source,bash] -http://_leader_host:port_/solr/_core_name_/replication?command=backup +http://{leaderHost}:{port}/solr/{coreName}/replication?command=backup + This command is useful for making periodic backups. There are several supported request parameters: @@ -529,7 +529,7 @@ For file system repository, location defaults to the core's dataDir (data direct Restore a backup from a backup repository. + [source,bash] -http://_leader_host:port_/solr/_core_name_/replication?command=restore +http://{leaderHost}:{port}/solr/{coreName}/replication?command=restore + This command is used to restore a backup. There are several supported request parameters: @@ -550,7 +550,7 @@ For file system repository, location defaults to core's dataDir (data directory) Check the status of a running restore operation. + [source,bash] -http://_leader_host:port_/solr/_core_name_/replication?command=restorestatus +http://{leaderHost}:{port}/solr/{coreName}/replication?command=restorestatus + This command is used to check the status of a restore operation. This command takes no parameters. @@ -562,7 +562,7 @@ If it failed then an "exception" will also be sent in the response. Delete any backup created using the `backup` command. + [source,bash] -http://_leader_host:port_ /solr/_core_name_/replication?command=deletebackup +http://{leaderHost}:{port} /solr/{coreName}/replication?command=deletebackup + There are two supported parameters: @@ -599,7 +599,7 @@ Use the health endpoint as follows: [source,bash] ---- -http://_follower_host:port_/solr/admin/info/health?maxGenerationLag=<_max_lag_> +http://{followerHost}:{port}/solr/admin/info/health?maxGenerationLag={maxLag} ---- ==== @@ -608,7 +608,7 @@ http://_follower_host:port_/solr/admin/info/health?maxGenerationLag=<_max_lag_> [source,bash] ---- -http://_follower_host:port_/api/node/health?maxGenerationLag=<_max_lag_> +http://{followerHost}:{port}/api/node/health?maxGenerationLag={maxLag} ---- ==== diff --git a/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc b/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc index c7519914ed8..21bf80cf747 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/about-this-guide.adoc @@ -73,6 +73,9 @@ As of the 7.2 version of this Guide, these examples are not yet complete - more The section xref:configuration-guide:v2-api.adoc[] provides more information about how to work with the new API structure, including how to disable it if you choose to do so. +In URLs and paths, a name in curly braces, such as `\{collectionName}` or `\{coreName}`, stands for a value you replace with your own. +The names are the ones the V2 API uses for its path parameters. + All APIs return a response header that includes the status of the request and the time to process it. Some APIs will also include the parameters used for the request. Many of the examples in this Guide omit this header information, which you can do locally by adding the parameter `omitHeader=true` to any request. diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc index d96a6d2373e..348dfeee00a 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc @@ -117,7 +117,7 @@ V1 API:: ==== [,console] ---- -curl http://host:8983/solr/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}' +curl http://host:8983/solr/{collectionName}/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}' ---- ==== @@ -126,7 +126,7 @@ V2 API:: ==== [,console] ---- -curl http://host:8983/api/collections/mycollection/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}' +curl http://host:8983/api/collections/{collectionName}/config -d '{"set-user-property": {"update.autoCreateFields":"false"}}' ---- ==== ====== diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/date-formatting-math.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/date-formatting-math.adoc index 596b098d9cd..f7679b6584f 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/date-formatting-math.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/date-formatting-math.adoc @@ -157,7 +157,7 @@ For example, the following request will use range faceting to facet over the cur [source,text] ---- -http://localhost:8983/solr/my_collection/select?q=*:*&facet.range=my_date_field&facet=true&facet.range.start=NOW/MONTH&facet.range.end=NOW/MONTH%2B1MONTH&facet.range.gap=%2B1DAY&wt=xml +http://localhost:8983/solr/{collectionName}/select?q=*:*&facet.range=my_date_field&facet=true&facet.range.start=NOW/MONTH&facet.range.end=NOW/MONTH%2B1MONTH&facet.range.gap=%2B1DAY&wt=xml ---- [source,xml] @@ -176,7 +176,7 @@ While in this example, the "days" will be computed relative to the specified tim [source,text] ---- -http://localhost:8983/solr/my_collection/select?q=*:*&facet.range=my_date_field&facet=true&facet.range.start=NOW/MONTH&facet.range.end=NOW/MONTH%2B1MONTH&facet.range.gap=%2B1DAY&TZ=America/Los_Angeles&wt=xml +http://localhost:8983/solr/{collectionName}/select?q=*:*&facet.range=my_date_field&facet=true&facet.range.start=NOW/MONTH&facet.range.end=NOW/MONTH%2B1MONTH&facet.range.gap=%2B1DAY&TZ=America/Los_Angeles&wt=xml ---- [source,xml] diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/document-enrichment-with-llms.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/document-enrichment-with-llms.adoc index a8b0ac1d257..8acbe6328b5 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/document-enrichment-with-llms.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/document-enrichment-with-llms.adoc @@ -144,7 +144,7 @@ These parameters can be defined in one of the following ways: <processor class="solr.languagemodels.update.processor.factory.DocumentEnrichmentUpdateProcessorFactory"> <str name="inputField">string_field</str> <str name="outputField">summary</str> - <str name="prompt">Summarize this content: \{string_field}</str> + <str name="prompt">Summarize this content: {string_field}</str> <str name="model">model-name</str> </processor> <processor class="solr.RunUpdateProcessorFactory"/> @@ -371,20 +371,20 @@ To upload the model in a `/path/myModel.json` file, please run: [source,bash] ---- -curl -XPUT 'http://localhost:8983/solr/YOUR_COLLECTION/schema/large-language-model-store' --data-binary "@/path/myModel.json" -H 'Content-type:application/json' +curl -XPUT 'http://localhost:8983/solr/{collectionName}/schema/large-language-model-store' --data-binary "@/path/myModel.json" -H 'Content-type:application/json' ---- To delete the `currentModel` model: [source,bash] ---- -curl -XDELETE 'http://localhost:8983/solr/YOUR_COLLECTION/schema/large-language-model-store/currentModel' +curl -XDELETE 'http://localhost:8983/solr/{collectionName}/schema/large-language-model-store/currentModel' ---- To view all models: [source,text] -http://localhost:8983/solr/YOUR_COLLECTION/schema/large-language-model-store +http://localhost:8983/solr/{collectionName}/schema/large-language-model-store .Example: /path/myOpenAIModel.json @@ -441,7 +441,7 @@ excluding the `DocumentEnrichmentUpdateProcessor` (let's call it 'no-enrichment' <processor class="solr.languagemodels.update.processor.factory.DocumentEnrichmentUpdateProcessorFactory"> <str name="inputField">string_field</str> <str name="outputField">summary</str> - <str name="prompt">Summarize this content: \{string_field}</str> + <str name="prompt">Summarize this content: {string_field}</str> <str name="model">model-name</str> </processor> <processor class="solr.RunUpdateProcessorFactory"/> @@ -485,7 +485,7 @@ You still define two chains, but this time the 'enrichment' one only includes th <processor class="solr.languagemodels.update.processor.factory.DocumentEnrichmentUpdateProcessorFactory"> <str name="inputField">string_field</str> <str name="outputField">summary</str> - <str name="prompt">Summarize this content: \{string_field}</str> + <str name="prompt">Summarize this content: {string_field}</str> <str name="model">model-name</str> </processor> <processor class="solr.RunUpdateProcessorFactory"/> diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc index 017b3726956..4321ca83891 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/filters.adoc @@ -1777,7 +1777,7 @@ The name that should be used for this set of stop words in the managed REST API. *Example:* //TODO: make this show an actual API call. -With this configuration the set of words is named "english" and can be managed via `/solr/collection_name/schema/analysis/stopwords/english` +With this configuration the set of words is named "english" and can be managed via `/solr/\{collectionName}/schema/analysis/stopwords/english` [tabs#filter-managedstop] ====== @@ -1830,7 +1830,7 @@ The name that should be used for this mapping on synonyms in the managed REST AP *Example:* //TODO: make this show an actual API call -With this configuration the set of mappings is named "english" and can be managed via `/solr/collection_name/schema/analysis/synonyms/english` +With this configuration the set of mappings is named "english" and can be managed via `/solr/\{collectionName}/schema/analysis/synonyms/english` [tabs#filter-managed-synonymgrpah] ====== diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-cbor.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-cbor.adoc index 0d15b4f01c1..72decea90cd 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-cbor.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-cbor.adoc @@ -57,7 +57,7 @@ cbor_data = cbor2.dumps(json_data) # Set the endpoint URL # ensure that the collection 'coll1' is already created -url = "http://localhost:8983/solr/coll1/update/cbor?commit=true"; +url = "http://localhost:8983/solr/{collectionName}/update/cbor?commit=true"; # Send a POST request with CBOR data response = requests.post(url, data=cbor_data, headers={"Content-Type": "application/cbor"}) @@ -122,7 +122,7 @@ const jsonData = [ const cborData = cbor.encode(jsonData); // Set the endpoint URL - const url = "http://localhost:8983/solr/coll1/update/cbor?commit=true"; + const url = "http://localhost:8983/solr/{collectionName}/update/cbor?commit=true"; try { // Send a POST request with CBOR data diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-update-handlers.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-update-handlers.adoc index 87d75e13d74..738b1870742 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-update-handlers.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/indexing-with-update-handlers.adoc @@ -60,7 +60,7 @@ The simplest way to add documents via JSON is to send each document individually [source,bash] ---- -curl 'http://localhost:8983/solr/my_collection/update/json/docs' -H 'Content-Type: application/json' --data-binary ' +curl 'http://localhost:8983/solr/{collectionName}/update/json/docs' -H 'Content-Type: application/json' --data-binary ' { "id": "1", "title": "Doc 1" @@ -73,7 +73,7 @@ Adding multiple documents at one time via JSON can be done via a JSON Array of J [source,bash] ---- -curl 'http://localhost:8983/solr/my_collection/update' -H 'Content-Type: application/json' --data-binary ' +curl 'http://localhost:8983/solr/{collectionName}/update' -H 'Content-Type: application/json' --data-binary ' [ { "id": "1", @@ -100,7 +100,7 @@ Multiple commands, adding and deleting documents, may be contained in one messag [source,bash,subs="verbatim,callouts"] ---- -curl 'http://localhost:8983/solr/my_collection/update' -H 'Content-Type: application/json' --data-binary ' +curl 'http://localhost:8983/solr/{collectionName}/update' -H 'Content-Type: application/json' --data-binary ' { "add": { "doc": { @@ -371,7 +371,7 @@ For example: [source,bash] ---- -curl http://localhost:8983/solr/my_collection/update -H "Content-Type: text/xml" --data-binary ' +curl http://localhost:8983/solr/{collectionName}/update -H "Content-Type: text/xml" --data-binary ' <add> <doc> <field name="authors">Patrick Eagar</field> @@ -388,7 +388,7 @@ For posting XML messages contained in a file, you can use the alternative form: [source,bash] ---- -curl http://localhost:8983/solr/my_collection/update -H "Content-Type: text/xml" --data-binary @myfile.xml +curl http://localhost:8983/solr/{collectionName}/update -H "Content-Type: text/xml" --data-binary @myfile.xml ---- The approach above works well, but using the `--data-binary` option causes `curl` to load the whole `myfile.xml` into memory before posting it to server. @@ -397,7 +397,7 @@ This alternative `curl` command performs equivalent operations but with minimal [source,bash] ---- -curl http://localhost:8983/solr/my_collection/update -H "Content-Type: text/xml" -T "myfile.xml" -X POST +curl http://localhost:8983/solr/{collectionName}/update -H "Content-Type: text/xml" -T "myfile.xml" -X POST ---- Responses from Solr take the form shown here: @@ -509,7 +509,7 @@ A sample CSV file is provided at `example/exampledocs/books.csv` that you can us [source,bash] ---- -curl 'http://localhost:8983/solr/my_collection/update?commit=true' --data-binary @example/exampledocs/books.csv -H 'Content-type:application/csv' +curl 'http://localhost:8983/solr/{collectionName}/update?commit=true' --data-binary @example/exampledocs/books.csv -H 'Content-type:application/csv' ---- === CSV Update Parameters @@ -735,7 +735,7 @@ This file could then be imported into Solr by setting the `separator` to tab (%0 [source,bash] ---- -curl 'http://localhost:8983/solr/my_collection/update/csv?commit=true&separator=%09&escape=%5c' --data-binary @/tmp/result.txt +curl 'http://localhost:8983/solr/{collectionName}/update/csv?commit=true&separator=%09&escape=%5c' --data-binary @/tmp/result.txt ---- === CSV Update Convenience Paths diff --git a/solr/solr-ref-guide/modules/indexing-guide/pages/reindexing.adoc b/solr/solr-ref-guide/modules/indexing-guide/pages/reindexing.adoc index 0f4795a1322..48e3b114209 100644 --- a/solr/solr-ref-guide/modules/indexing-guide/pages/reindexing.adoc +++ b/solr/solr-ref-guide/modules/indexing-guide/pages/reindexing.adoc @@ -133,7 +133,7 @@ The best approach is to first delete everything from the index, and then index y You can delete all documents with a "delete-by-query", such as this: [source,bash] -curl 'http://localhost:8983/solr/my_collection/update' -H 'Content-Type: application/json' --data-binary '{"delete":{"query":"*:*" }}' +curl 'http://localhost:8983/solr/{collectionName}/update' -H 'Content-Type: application/json' --data-binary '{"delete":{"query":"*:*" }}' It's important to verify that *all* documents have been deleted, as that ensures the Lucene index segments have been deleted as well. diff --git a/solr/solr-ref-guide/modules/query-guide/pages/exporting-result-sets.adoc b/solr/solr-ref-guide/modules/query-guide/pages/exporting-result-sets.adoc index d870f56f961..503d12eb272 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/exporting-result-sets.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/exporting-result-sets.adoc @@ -65,7 +65,7 @@ V1 API:: ==== [source,text] ---- -http://localhost:8983/solr/collection_name/export?q=my-query&sort=severity+desc,timestamp+desc&fl=severity,timestamp,msg +http://localhost:8983/solr/{collectionName}/export?q=my-query&sort=severity+desc,timestamp+desc&fl=severity,timestamp,msg ---- ==== @@ -74,7 +74,7 @@ V2 API:: ==== [source,text] ---- -http://localhost:8983/api/collections/collection_name/export?q=my-query&sort=severity+desc,timestamp+desc&fl=severity,timestamp,msg +http://localhost:8983/api/collections/{collectionName}/export?q=my-query&sort=severity+desc,timestamp+desc&fl=severity,timestamp,msg ---- ==== ====== @@ -124,7 +124,7 @@ V1 API:: ==== [source,text] ---- -http://localhost:8983/solr/collection_name/export?q=my-query&sort=timestamp+desc,&fl=timestamp,reporter,severity&expr=top(n=2,input(),sort="timestamp+desc") +http://localhost:8983/solr/{collectionName}/export?q=my-query&sort=timestamp+desc,&fl=timestamp,reporter,severity&expr=top(n=2,input(),sort="timestamp+desc") ---- ==== @@ -133,7 +133,7 @@ V2 API:: ==== [source,text] ---- -http://localhost:8983/api/collections/collection_name/export?q=my-query&sort=timestamp+desc,&fl=timestamp,reporter,severity&expr=top(n=2,input(),sort="timestamp+desc") +http://localhost:8983/api/collections/{collectionName}/export?q=my-query&sort=timestamp+desc,&fl=timestamp,reporter,severity&expr=top(n=2,input(),sort="timestamp+desc") ---- ==== ====== @@ -150,7 +150,7 @@ V1 API:: ==== [source,text] ---- -http://localhost:8983/solr/collection_name/export?q=my-query&sort=reporter+desc,&fl=reporter&expr=unique(input(),over="reporter") +http://localhost:8983/solr/{collectionName}/export?q=my-query&sort=reporter+desc,&fl=reporter&expr=unique(input(),over="reporter") ---- ==== @@ -159,7 +159,7 @@ V2 API:: ==== [source,text] ---- -http://localhost:8983/api/collections/collection_name/export?q=my-query&sort=reporter+desc,&fl=reporter&expr=unique(input(),over="reporter") +http://localhost:8983/api/collections/{collectionName}/export?q=my-query&sort=reporter+desc,&fl=reporter&expr=unique(input(),over="reporter") ---- ==== ====== diff --git a/solr/solr-ref-guide/modules/query-guide/pages/function-queries.adoc b/solr/solr-ref-guide/modules/query-guide/pages/function-queries.adoc index 7244db1428f..a78f53331e3 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/function-queries.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/function-queries.adoc @@ -632,7 +632,7 @@ To sort by the density of the box and return the value of the density in score, [source,text] ---- -http://localhost:8983/solr/collection_name/select?q=boxname:findbox _val_:"div(weight,product(x,y,z))"&fl=boxname x y z weight score +http://localhost:8983/solr/{collectionName}/select?q=boxname:findbox _val_:"div(weight,product(x,y,z))"&fl=boxname x y z weight score ---- == Sort By Function @@ -642,7 +642,7 @@ For example, to sort results by distance, you could enter: [source,text] ---- -http://localhost:8983/solr/collection_name/select?q=*:*&sort=dist(2, point1, point2) desc +http://localhost:8983/solr/{collectionName}/select?q=*:*&sort=dist(2, point1, point2) desc ---- Sort by function also supports pseudo-fields: fields can be generated dynamically and return results as though it was normal field in the index. diff --git a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-dbvisualizer.adoc b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-dbvisualizer.adoc index 8dbb2934f52..af0aad10aed 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-dbvisualizer.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-dbvisualizer.adoc @@ -40,7 +40,7 @@ image::jdbc-dbvisualizer/dbvisualizer_solrjdbc_2.png[image,width=532,height=400] === Name the Driver in Driver Manager -Provide a name for the driver, and provide the URL format: `jdbc:solr://<zk_connection_string>/?collection=<collection>`. +Provide a name for the driver, and provide the URL format: `jdbc:solr://\{zkConnectionString}/?collection=\{collectionName}`. Do not fill in values for the variables "```zk_connection_string```" and "```collection```", those will be provided later when the connection to Solr is configured. The Driver Class will also be automatically added when the driver `.jar` s are added. diff --git a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-squirrel.adoc b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-squirrel.adoc index 2f7cdeb7dc3..3908f85cdb7 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-squirrel.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-squirrel.adoc @@ -43,7 +43,7 @@ image::jdbc-squirrel/squirrelsql_solrjdbc_2.png[image,width=892,height=400] === Name the Driver -Provide a name for the driver, and provide the URL format: `jdbc:solr://<zk_connection_string>/?collection=<collection>`. +Provide a name for the driver, and provide the URL format: `jdbc:solr://\{zkConnectionString}/?collection=\{collectionName}`. Do not fill in values for the variables "```zk_connection_string```" and "```collection```", those will be defined later when the connection to Solr is configured. image::jdbc-squirrel/squirrelsql_solrjdbc_3.png[image,width=467,height=400] diff --git a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-zeppelin.adoc b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-zeppelin.adoc index 3fd357c0d09..bde04d23f2a 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/jdbc-zeppelin.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/jdbc-zeppelin.adoc @@ -64,7 +64,7 @@ To facilitate easy copying the parameters mentioned in the screenshots, here is ---- Name : Solr Interpreter : jdbc -default.url : jdbc:solr://SOLR_ZK_CONNECTION_STRING?collection=<collection_name> +default.url : jdbc:solr://SOLR_ZK_CONNECTION_STRING?collection=\{collectionName} default.driver : org.apache.solr.client.solrj.io.sql.DriverImpl default.user : solr dependency : org.apache.solr:solr-solrj:{solr-full-version} diff --git a/solr/solr-ref-guide/modules/query-guide/pages/logs.adoc b/solr/solr-ref-guide/modules/query-guide/pages/logs.adoc index 0032994d211..6983720f754 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/logs.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/logs.adoc @@ -43,7 +43,7 @@ The `postlogs` command reads in Solr's log format and indexes it in a Solr colle |Required |Default: none |=== + -Address of the collection, example http://localhost:8983/solr/collection1/. +Address of the collection, example http://localhost:8983/solr/\{collectionName}/. + `-rootdir <directory>`:: diff --git a/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc b/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc index 14fc69134c1..30aaacc5f1d 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/response-writers.adoc @@ -348,7 +348,7 @@ import json import requests // replace 'coll1' with your own collection name. And use appropriate query params -url = "http://localhost:8983/solr/coll1/select?q=*:*&wt=cbor"; +url = "http://localhost:8983/solr/{collectionName}/select?q=*:*&wt=cbor"; # Make the HTTP request response = requests.get(url, headers={"Accept": "application/cbor"}) diff --git a/solr/solr-ref-guide/modules/query-guide/pages/stream-decorator-reference.adoc b/solr/solr-ref-guide/modules/query-guide/pages/stream-decorator-reference.adoc index 120f871f5f6..a7510adcedd 100644 --- a/solr/solr-ref-guide/modules/query-guide/pages/stream-decorator-reference.adoc +++ b/solr/solr-ref-guide/modules/query-guide/pages/stream-decorator-reference.adoc @@ -549,28 +549,28 @@ The `/stream` handler supports a small xref:stream-api.adoc#plugins[set of comma [source,text] ---- -http://localhost:8983/solr/collection/stream?action=list +http://localhost:8983/solr/{collectionName}/stream?action=list ---- This command will provide a listing of the current daemons running on the specific node along with their current state. [source,text] ---- -http://localhost:8983/solr/collection/stream?action=stop&id=daemonId +http://localhost:8983/solr/{collectionName}/stream?action=stop&id=daemonId ---- This command will stop a specific daemon function but leave it resident in memory. [source,text] ---- -http://localhost:8983/solr/collection/stream?action=start&id=daemonId +http://localhost:8983/solr/{collectionName}/stream?action=start&id=daemonId ---- This command will start a specific daemon function that has been stopped. [source,text] ---- -http://localhost:8983/solr/collection/stream?action=kill&id=daemonId +http://localhost:8983/solr/{collectionName}/stream?action=kill&id=daemonId ---- This command will stop a specific daemon function and remove it from memory.
