This is an automated email from the ASF dual-hosted git repository.
psalagnac pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new d49d2a4793b Fixes to the non-cloud documentation for snapshots (#5164)
d49d2a4793b is described below
commit d49d2a4793b7ed9a36bdc4d9ff06a8ded7f6a400
Author: Pierre Salagnac <[email protected]>
AuthorDate: Wed Oct 21 11:04:46 2026 +0200
Fixes to the non-cloud documentation for snapshots (#5164)
---
.../deployment-guide/pages/backup-restore.adoc | 75 +++++++++++++++++-----
1 file changed, 60 insertions(+), 15 deletions(-)
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc
index e243e15a7b3..a0158af5a73 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/backup-restore.adoc
@@ -267,12 +267,12 @@ The status value can be "In Progress", "success" or
"failed".
If it failed then an "exception" will also be sent in the response.
[[create-snapshot-api]]
-== CREATE: Create a Snapshot
+== CREATESNAPSHOT: Create a Snapshot
The snapshot functionality is different from the backup functionality as the
index files aren't copied anywhere.
The index files are snapshotted in the same index directory and can be
referenced while taking backups.
-You can trigger a snapshot command with an HTTP command like this (replace
"techproducts" with the name of the core you are working with):
+You can trigger a CREATESNAPSHOT command with an HTTP request like this
(replace "techproducts" with the name of the core you are working with):
[tabs#createsnapshot]
======
@@ -298,9 +298,27 @@ curl -X POST
http://localhost:8983/api/cores/techproducts/snapshots/commit1
====
======
-=== CREATE Parameters
+=== CREATESNAPSHOT Parameters
-The CREATE action allows the following parameters:
+The CREATESNAPSHOT action allows the following parameters:
+
+`core`::
++
+[%autowidth,frame=none]
+|===
+s|Required |Default: none
+|===
++
+The name of the core to perform the snapshot on.
+
+`commitName`::
++
+[%autowidth,frame=none]
+|===
+s|Required |Default: none
+|===
++
+The name to store the snapshot as.
`async`::
+
@@ -311,15 +329,15 @@ The CREATE action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.
-=== CREATE Response
+=== CREATESNAPSHOT Response
The response will include the status of the request, the core name, snapshot
name, index directory path, snapshot generation, and a list of file names.
If the status is anything other than "success", an error message will explain
why the request failed.
[[list-snapshot-api]]
-== List: List All Snapshots for a Particular Core
+== LISTSNAPSHOTS: List All Snapshots for a Particular Core
-You can trigger a list snapshot command with an HTTP command like this
(replace "techproducts" with the name of the core you are working with):
+You can trigger a LISTSNAPSHOTS command with an HTTP request like this
(replace "techproducts" with the name of the core you are working with):
[tabs#listsnapshots]
======
@@ -345,9 +363,18 @@ curl http://localhost:8983/api/cores/techproducts/snapshots
====
======
-=== LIST Parameters
+=== LISTSNAPSHOTS Parameters
+
+The LISTSNAPSHOTS action allows the following parameters:
-The LIST action allows the following parameters:
+`core`::
++
+[%autowidth,frame=none]
+|===
+s|Required |Default: none
+|===
++
+The name of the core to whose snapshots we want to list.
`async`::
+
@@ -358,15 +385,15 @@ The LIST action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.
-=== LIST Response
+=== LISTSNAPSHOTS Response
The response will include the status of the request and all existing snapshots
for the core.
If the status is anything other than "success", an error message will explain
why the request failed.
[[delete-snapshot-api]]
-== DELETE: Delete a Snapshot
+== DELETESNAPSHOT: Delete a Snapshot
-You can trigger a delete snapshot with an HTTP command like this (replace
"techproducts" with the name of the core you are working with):
+You can trigger a DELETESNAPSHOT command with an HTTP request like this
(replace "techproducts" with the name of the core you are working with):
[tabs#deletesnapshot]
======
@@ -392,9 +419,27 @@ curl -X DELETE
http://localhost:8983/api/cores/techproducts/snapshots/commit1
====
======
-=== DELETE Parameters
+=== DELETESNAPSHOT Parameters
+
+The DELETESNAPSHOT action allows the following parameters:
+
+`commitName`::
++
+[%autowidth,frame=none]
+|===
+s|Required |Default: none
+|===
++
+The commit name to be deleted.
-The DELETE action allows the following parameters:
+`core`::
++
+[%autowidth,frame=none]
+|===
+s|Required |Default: none
+|===
++
+The name of the core whose snapshot we want to delete.
`async`::
+
@@ -405,7 +450,7 @@ The DELETE action allows the following parameters:
+
Request ID to track this action which will be processed asynchronously.
-=== DELETE Response
+=== DELETESNAPSHOT Response
The response will include the status of the request, the core name, and the
name of the snapshot that was deleted.
If the status is anything other than "success", an error message will explain
why the request failed.
