Add external_user_id to semantic search docs and update its desc in a…

[aralyekta]

…sk question

Summary by CodeRabbit

• Documentation

  • Clarified that external_user_id parameter must be in UUID format for the Ask Question endpoint.

• New Features

  • Added external_user_id parameter to the Semantic Search endpoint for per-user analytics tracking.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Two API endpoint documentation files are updated to clarify external_user_id parameter requirements. The ask-question endpoint's existing parameter description is refined to explicitly require UUID format, and the semantic-search endpoint receives a new external_user_id parameter with the same UUID requirement for per-user analytics.

Changes

Cohort / File(s)	Summary
API Documentation Updates api-reference/endpoints/ask-question.mdx, api-reference/endpoints/semantic-search.mdx	Updated external_user_id parameter description to require UUID format on ask-question endpoint; added new external_user_id parameter to semantic-search endpoint for per-user analytics tracking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Documentation-only changes with no logic or code modifications
• Straightforward parameter documentation clarifications and additions

Possibly related PRs

• Task/api external user #32: Adds the initial external_user_id parameter and session-mismatch behavior to the ask-question endpoint; this PR tightens the format requirement to UUID.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title partially addresses the changeset by mentioning 'semantic search docs' and updating description, but is truncated (ends with 'in a…') and lacks specificity about the full scope of changes.	Complete the truncated title and be more specific about both changes: e.g., 'Add external_user_id parameter to semantic search and clarify UUID requirement in ask question endpoint.'

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

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

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

api-reference/endpoints/semantic-search.mdx (1)

31-33: Align UUID requirement phrasing with ask-question endpoint.

The description uses "It should be UUID" which is informal and grammatically incomplete. For consistency with the ask-question endpoint and professional API documentation standards, use more prescriptive phrasing with proper grammar.

  <ParamField body="external_user_id" type="string">
-   External user identifier. This allows you to track search queries per user in your analytics. It should be UUID.
+   External user identifier. This allows you to track search queries per user in your analytics. It must be a UUID.
  </ParamField>

This aligns with the ask-question endpoint (with the grammar correction noted separately).

api-reference/endpoints/ask-question.mdx (1)

39-41: Correct grammar and align UUID requirement phrasing across endpoints.

Line 40 has a grammatical error: "It needs to be UUID" should include the article "a." Additionally, align the phrasing with the semantic-search endpoint for consistency across the API documentation.

  <ParamField body="external_user_id" type="string">
-   External user identifier for tracking user-specific conversation sessions. When provided, this ID is stored in the session. If a session already exists with a different external_user_id, the request will be rejected. It needs to be UUID.
+   External user identifier for tracking user-specific conversation sessions. When provided, this ID is stored in the session. If a session already exists with a different external_user_id, the request will be rejected. It must be a UUID.
  </ParamField>

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7122bb6 and 0ce75be.

📒 Files selected for processing (2)

• api-reference/endpoints/ask-question.mdx (1 hunks)
• api-reference/endpoints/semantic-search.mdx (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

**/*.mdx: Use MDX format for all documentation files
Use Mintlify components like , , for rich content
Include practical examples and code snippets in documentation
Use images from /images/ directory for visual guides

Files:

• api-reference/endpoints/ask-question.mdx
• api-reference/endpoints/semantic-search.mdx

api-reference/endpoints/**/*.mdx

📄 CodeRabbit inference engine (CLAUDE.md)

API endpoint docs follow the structure in /api-reference/endpoints/

Files:

• api-reference/endpoints/ask-question.mdx
• api-reference/endpoints/semantic-search.mdx