Repository navigation
fix(search): one title rule for indexing, prefix and exact search (ENG-3299) - #336
adityamishra-hydradb wants to merge 1 commit into
Conversation
✅ Mintlify HygieneNo issues found. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
|
@greptileai review |
|
/devin review |
✅ OpenHack SummarySecurity review of fix(search): one title rule for indexing, prefix and exact search (ENG-3299). 3 changed files; 0 findings at or above the low reporting threshold. Confidence Score: 5/5No reportable security findings were detected in this scan. Security merge-readiness rubric: 1 = critical, 2 = high, 3 = medium, 4 = low, 5 = no reportable findings. This score reflects scan findings, not a guarantee of correctness or complete coverage. Files Needing Attention: None Important Files Changed
Last reviewed commit: b8dac9c · View review on OpenHack
|
There was a problem hiding this comment.
Devin Review found 1 potential issue.
2 flags not posted on this PR by your GitHub settings — view them in Devin Review. (Configure)
| | <Field name="collections" type="string[] or object" /> | Multi-collection scope. Send a list of collection IDs for equal weighting, or an object mapping collection ID to a positive relative weight (at most one decimal place, e.g. `{"finance": 1.5, "legal": 0.8}`) to bias ranking. Up to 100 collections. Do not combine with `collection`. | | ||
| | <Field name="query" type="string" required /> | Query terms or natural-language question. Cannot be empty. Maximum 5,000 words. | | ||
| | <Field name="titles" type="string[]" /> | Exact source titles, matched case-insensitively. Matches any listed title, then intersects with `ids` if both are sent. | | ||
| | <Field name="titles" type="string[]" /> | Exact normalized source titles. Normalization applies Unicode NFKC, removes invisible marks and decoration, lowercases, collapses spaces, and removes one final known file extension (`md`, `markdown`, `txt`, `pdf`, `doc`, `docx`, `rtf`, `odt`, `ppt`, `pptx`, `xls`, `xlsx`, `csv`, `tsv`, `json`, `html`, or `htm`) when text remains before it. Matches any listed title, then intersects with `ids` if both are sent. Use `ids` for source IDs and `titles` for titles; HydraDB never guesses from the input format. | |
There was a problem hiding this comment.
🟡 Unsigned commit blocks the DCO check
The commit adding this title contract lacks a Signed-off-by trailer. The required DCO check fails, blocking the PR.
Learn more
Every PR commit must carry a Developer Certificate of Origin sign-off. The only commit in this PR has no Signed-off-by trailer, and the DCO check rejects any unsigned commit. Editing documentation text cannot fix the commit metadata.
Example: The check scans b8dac9c, finds no trailer, and exits with an error even if documentation validation passes.
Recommended fix: Amend the commit with git commit --amend -s --no-edit using a valid signing identity, then push the updated commit.
Was this helpful? React with 👍 or 👎 to provide feedback.
[Low impact] The PR updates documentation for three title-search inputs. The documentation appears safe to merge after the stated application rollout, with two non-blocking documentation gaps. FindingsSummaryDocuments one normalized title rule across list, query, and MCP search.
Reviews (1) · Last reviewed commit: "docs(search): define normalized title ma..." · Reviewed by Greptile |
| | <Field name="collections" type="string[] or object" /> | Multi-collection scope. Send a list of collection IDs for equal weighting, or an object mapping collection ID to a positive relative weight (at most one decimal place, e.g. `{"finance": 1.5, "legal": 0.8}`) to bias ranking. Up to 100 collections. Do not combine with `collection`. | | ||
| | <Field name="query" type="string" required /> | Query terms or natural-language question. Cannot be empty. Maximum 5,000 words. | | ||
| | <Field name="titles" type="string[]" /> | Exact source titles, matched case-insensitively. Matches any listed title, then intersects with `ids` if both are sent. | | ||
| | <Field name="titles" type="string[]" /> | Exact normalized source titles. Normalization applies Unicode NFKC, removes invisible marks and decoration, lowercases, collapses spaces, and removes one final known file extension (`md`, `markdown`, `txt`, `pdf`, `doc`, `docx`, `rtf`, `odt`, `ppt`, `pptx`, `xls`, `xlsx`, `csv`, `tsv`, `json`, `html`, or `htm`) when text remains before it. Matches any listed title, then intersects with `ids` if both are sent. Use `ids` for source IDs and `titles` for titles; HydraDB never guesses from the input format. | |
There was a problem hiding this comment.
The new title rule is missing from api-reference/v2/openapi.json. Its titles description still mentions only case-insensitive matching, and its list-title description mentions only case-insensitive prefix matching. Readers of that contract miss how extensions, Unicode, and spacing affect matches. Update those descriptions alongside these pages.
| Source IDs and titles are separate inputs. Use `ids` for source IDs and `titles` | ||
| for titles. HydraDB never guesses from the input format. |
There was a problem hiding this comment.
Source-ID guidance leaves users guessing
This new instruction tells users to pass ids inside the hydradb_query section, but that tool's parameter table does not list ids, and its example only shows titles. Document the supported source-ID input here, or name the tool users should call instead. Otherwise users must guess how to follow the new guidance.
|
Replaced by #337 because the original pushed commit lacked the required DCO sign-off. The replacement branch preserves the changes with a signed-off commit and avoids a force-push. |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
For humans
Documents the normalized title contract from https://linear.app/hydradb/issue/ENG-3299.
What changed
Merge order
Merge after the app change reaches prod.
Related PRs
For agents
Check that all three surfaces describe the same extension allow-list and the same source-ID-versus-title rule.
Local validation:
Decisions taken without review
notes.v2and.mdas explicit non-stripping examples to define dotted-title edge cases.Session Details
(aside)to your comment to have me ignore it.Need help on this PR? Tag
@codesmith-botwith what you need.