feat: update search API#2633
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the Ory Kratos identity search documentation and examples to match the current Search API and Console capabilities (collection naming, new facets/fields, and usage guidance).
Changes:
- Update Search API docs to use the
identitiescollection name and add stronger guidance about eventual consistency / non-correctness-critical usage. - Refresh Console search documentation to reflect updated facet/filter names (Status + Registration date).
- Extend search example data model / sample results with a
regionfield and adjust cURL example values.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/kratos/manage-identities/search/identity-search-console.mdx | Updates Console facet/filter wording for identity search. |
| docs/kratos/manage-identities/search/identity-search-api.mdx | Updates Search API data model/collection naming and adds usage guidance + tips. |
| code-examples/curl/search/model.jsonc | Adds region to the indexed identity document example. |
| code-examples/curl/search/advanced.sh | Updates the example project slug used in the advanced cURL snippet. |
| code-examples/curl/search/advanced-result.json | Updates the sample response to include region and refreshed example values/counts. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (2)
📒 Files selected for processing (3)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (2)
📝 WalkthroughWalkthroughThree files in the curl identity-search code examples are updated: ChangesSearch code example fixtures refresh
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
97ca6b8 to
6291c98
Compare
Summary by CodeRabbit
New Features
regionfield to the identity model to indicate where identity data is stored.Documentation
ORY_SLUGvalue.