Repository navigation
docs(snapshots): document the shard snapshot API - #3097
Open
inamdarmihir wants to merge 1 commit into
Open
inamdarmihir wants to merge 1 commit into
inamdarmihir wants to merge 1 commit into
Conversation
The Snapshots page covers collection and full storage snapshots but not the shard snapshot endpoints that exist since v1.5.0. Add a Shard snapshots section for creating, listing, downloading, streaming, deleting, and recovering a shard, including recovery from an uploaded file, and explain what each recovery priority does to the other replicas of the shard. The behavior is taken from the Qdrant REST handlers and the OpenAPI spec. The examples are snippet bundles, like the other snapshot examples. Fixes qdrant#306 Authored by Mihir
inamdarmihir
requested review from
Dylancouzon,
abdonpijpelink,
generall,
kanungle and
trean
as code owners
October 25, 2026 18:09
✅ Deploy Preview for condescending-goldwasser-91acf0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
kanungle
requested review from
bashofmann
and removed request for
Dylancouzon,
generall,
kanungle and
trean
October 31, 2026 10:23
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #306
Motivation
Shard snapshots, available since v1.5.0, have no documentation on the Snapshots page. Issue #306 has tracked that gap since 2023, and the page still covers only collection snapshots and full storage snapshots. Anyone who needs to back up, move, or repair a single shard has to piece the endpoints together from the API reference, with no explanation of how a recovery affects the other replicas of the shard. This PR adds that documentation.
What changed
snapshots.md: create, list, download, streaming download, delete, recover from a URL or a stored snapshot, recover from an uploaded file, and shard snapshot priority.headless/snippets/snapshots/(http.mdandbash.sh, with the generatedbash.md), in the same format as the existing snapshot examples.The partial snapshot endpoints (
/snapshot/partial/*) are not covered.How it was checked
wait=false), list, download by name, streaming download, recover by stored name and by URL,checksumaccepted and a wrong checksum rejected,api_keyaccepted, upload withpriorityandchecksumquery parameters, and delete. Recovery overwrote the shard, which went from 0 points back to its 4. Withenable_snapshot_url_recovery: false, recovery from a URL is refused (Forbidden), while recovery from a stored snapshot and from an upload still work.src/actix/api/snapshot_api.rs,src/common/snapshots.rs, and the OpenAPI spec. The default priority for shard recovery issnapshot, fromSnapshotPriority's default.automation/prompts/check-prompts.sh,automation/check-content-images.sh, andautomation/snippets/generate-md.pypass, and the generator reproduces the committedgenerated/files.AGENTS.md: no em dashes, no directional language, and code samples in snippet bundles.Not verified: the multi-replica behavior of each priority was read from
recover_shard_snapshot_impland not run on a cluster, and "Available as of v1.5.0" is taken from the wording of #306.AI disclosure
Commits:
Prompt, summarized from the instructions given to the AI tool: find a small documentation issue that no one has claimed, and for #306 add a "Shard snapshots" section to the Snapshots page covering the shard snapshot endpoints. Take every parameter and default from the REST handlers and the OpenAPI spec in qdrant/qdrant, follow this repository's
AGENTS.md(snippet bundles, style rules), and check the result against a running server and a full Hugo build before opening the PR.I reviewed the result and can answer questions about it.
Authored by Mihir