Update sharding feature compatibility page - #3650
Conversation
Explicitly add the support of the Foreign filters, the hydration, and the fetching of documents.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
📝 WalkthroughWalkthroughThe sharding compatibility table now documents foreign filtering, hydration, and network-enabled document fetching through ChangesSharding compatibility
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@resources/self_hosting/sharding/overview.mdx`:
- Line 123: Update the “Documents fetch” table entry to use the full
index-scoped endpoint path, POST /indexes/{index_uid}/documents/fetch, while
preserving the existing useNetwork description.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: 4842fe4c-0dff-4075-bcaf-8b49bf938d51
📒 Files selected for processing (1)
resources/self_hosting/sharding/overview.mdx
| | Filtering and sorting | Yes | Filters applied on each remote before merging | | ||
| | Foreign filtering and hydration | Yes | Foreign documents will be retrieved from each remote | | ||
| | Faceted search | Yes | Facet distribution in search results works across remotes, and the `/facet-search` endpoint supports `useNetwork` | | ||
| | Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` | |
There was a problem hiding this comment.
🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win
Use the full index-scoped document-fetch path.
Line 123 lists POST /documents/fetch, but the canonical guide defines the endpoint as POST /indexes/{index_uid}/documents/fetch. The shortened path can send users to an invalid route. Update this table entry.
The canonical guide at capabilities/indexing/how_to/add_and_update_documents.mdx:192-223 uses the full path.
Proposed fix
-| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` |
+| Documents fetch | Yes | Documents fetch works across remotes, and the `POST /indexes/{index_uid}/documents/fetch` endpoint supports `useNetwork` |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Documents fetch | Yes | Documents fetch works across remotes, and the `POST /documents/fetch` endpoint supports `useNetwork` | | |
| | Documents fetch | Yes | Documents fetch works across remotes, and the `POST /indexes/{index_uid}/documents/fetch` endpoint supports `useNetwork` | |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@resources/self_hosting/sharding/overview.mdx` at line 123, Update the
“Documents fetch” table entry to use the full index-scoped endpoint path, POST
/indexes/{index_uid}/documents/fetch, while preserving the existing useNetwork
description.
Explicitly add the support of the Foreign filters, the hydration, and the fetching of documents.
Description
Checklist
For internal Meilisearch team member only:
For external maintainers
Summary by CodeRabbit
useNetworksupport.