Uh oh!
There was an error while loading. Please reload this page.
Fixes #7170: docs(data-engine): add searchFields to EngineQueryOptions block - #7354
Merged
Merged
Conversation
The hand-written EngineQueryOptions interface block on content/docs/kernel/contracts/data-engine.mdx listed every member of EngineQueryOptionsSchema except searchFields, a real declared and enforced option since #4371. Add the missing line, worded to match the schema's own doc comment and ADR-0061 D1 (validated override, intersected with the object's declared/derived searchable set). Docs-only, no behaviour change. Fixes#7170 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01KJATVrh6V2ysutYUJigh3B
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
os-help
marked this pull request as ready for review
August 10, 2026 08:01
Uh oh!
There was an error while loading. Please reload this page.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes#7170
What
content/docs/kernel/contracts/data-engine.mdx's hand-writtenEngineQueryOptionsinterface block listed every member of
EngineQueryOptionsSchemaexceptsearchFields, a real declared and enforced option since #4371. This adds themissing line.
Verification of the card's claims (both checked, not assumed)
EngineQueryOptionsSchema(viaBaseEngineOptionsSchema.extend(),packages/spec/src/data/data-engine.zod.ts) declares:context, where, fields, orderBy, limit, offset, top, cursor (retired), search, searchFields, expand, distinct (retired). The hand-written block coveredwhere, fields, orderBy, limit, offset, top, search, expand, contextand handledcursor/distinctin a separate "Removed in protocol 17" subsection right below(deliberate, documented omission from the interface block — they're tombstoned,
not live options).
searchFieldswas the only member missing with no explanationanywhere on the page. Confirmed: one true gap, exactly as the card states.
(a) the schema's own doc comment (
data-engine.zod.ts:142-148: "intersected withthe object's declared/derived searchable set (ADR-0061)... enforced but undeclared
until [P2] A direct engine call silently drops
sort/select/skip/populate— declared query contract, zero enforcement #4371"), (b) ADR-0061 D1 ("$searchFieldsis a validated override... theserver intersects it with the object's allowed searchable set, silently dropping
disallowed fields"), and (c) the runtime (
packages/objectql/src/search-filter.ts→
resolveSearchFields). All three agree with the card's suggested prose, so itwas used essentially verbatim (reworded to fit the block's inline-comment style).
Also cross-checked the generated reference table
(
content/docs/references/data/data-engine.mdx## EngineQueryOptions,searchFieldsrow:
string[], optional) — type matches; that table carries no prose beyond type,so it corroborates the type but not the description, which the ADR + schema comment
supply instead.
searchentry's already-updated prose (post-EngineQueryOptionsSchema.searchrejects the bare query string that ADR-0061 D1 calls canonical — so every engine caller that wants it mustas any, losing the whole query's checking #7178/8b06bba84, canonical bare-stringcontract) — no edit was needed there,
searchFieldsis additive to it.Scope
Docs-only, one file, one line (plus its wrapped inline comment), no behaviour change.
Per the ruling on this card: no changes to
packages/spec/**, the generated referencetree, or any gate; no changeset (
skip-changeset, applied by the PM at accept time).Generated by Claude Code