Skip to content

feat: update search API#2633

Open
alnr wants to merge 1 commit into
masterfrom
alnr/lift-search-limitations
Open

feat: update search API#2633
alnr wants to merge 1 commit into
masterfrom
alnr/lift-search-limitations

Conversation

@alnr

@alnr alnr commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features

    • Added a region field to the identity model to indicate where identity data is stored.
  • Documentation

    • Refreshed the advanced search API response example fixture with updated sample results and facet data.
    • Updated the advanced curl script’s configuration example to use a new ORY_SLUG value.

@alnr alnr self-assigned this Jun 17, 2026
Copilot AI review requested due to automatic review settings June 17, 2026 15:45

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 identities collection 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 region field 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.

Comment thread docs/kratos/manage-identities/search/identity-search-api.mdx
Comment thread docs/kratos/manage-identities/search/identity-search-api.mdx Outdated
Comment thread docs/kratos/manage-identities/search/identity-search-api.mdx Outdated
Comment thread docs/kratos/manage-identities/search/identity-search-console.mdx
Comment thread code-examples/curl/search/advanced.sh
@coderabbitai

coderabbitai Bot commented Jun 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 6bb89197-ad21-4e63-87dc-91176993bd41

📥 Commits

Reviewing files that changed from the base of the PR and between 97ca6b8 and 6291c98.

⛔ Files ignored due to path filters (2)
  • docs/kratos/manage-identities/search/identity-search-api.mdx is excluded by !**/*.mdx
  • docs/kratos/manage-identities/search/identity-search-console.mdx is excluded by !**/*.mdx
📒 Files selected for processing (3)
  • code-examples/curl/search/advanced-result.json
  • code-examples/curl/search/advanced.sh
  • code-examples/curl/search/model.jsonc
✅ Files skipped from review due to trivial changes (1)
  • code-examples/curl/search/advanced.sh
🚧 Files skipped from review as they are similar to previous changes (2)
  • code-examples/curl/search/model.jsonc
  • code-examples/curl/search/advanced-result.json

📝 Walkthrough

Walkthrough

Three files in the curl identity-search code examples are updated: model.jsonc gains a region field set to eu-central, advanced.sh replaces the ORY_SLUG value, and advanced-result.json refreshes the response fixture with new document records, facet UUIDs, and updated found/out_of counts.

Changes

Search code example fixtures refresh

Layer / File(s) Summary
Identity model and script slug update
code-examples/curl/search/model.jsonc, code-examples/curl/search/advanced.sh
model.jsonc adds a region property (eu-central); advanced.sh replaces ORY_SLUG with a new slug value.
Response fixture data refresh
code-examples/curl/search/advanced-result.json
Replaces facet UUIDs and counts, updates found/out_of from 2163 to 56, and swaps the hits array with 5 new document records containing updated IDs, organization IDs, regions, and trait fields.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 A region was born, eu-central its name,
The slug got refreshed, nothing looks the same!
Fifty-six found where two thousand once stood,
New UUIDs sparkle, as fixtures all should.
Hippity-hop, the examples look good! 🌍

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (1 warning, 1 inconclusive)

Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request has no description provided by the author despite a detailed template requiring issue references, checklist completion, and change rationale. Add a comprehensive description following the template, including a reference to the related issue/design document and a completed checklist.
Title check ❓ Inconclusive The title 'feat: update search API' is vague and overly generic, lacking specificity about what aspect of the search API was updated or why. Provide a more specific title that describes the concrete changes, such as 'feat: add region field to identity model and update search example fixtures'.
✅ Passed checks (3 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch alnr/lift-search-limitations

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants