Skip to content

Fixes #7170: docs(data-engine): add searchFields to EngineQueryOptions block - #7354

Merged
os-help merged 1 commit into
mainfrom
claude/issue-7170-data-engine-searchfields
Aug 10, 2026
Merged

Fixes #7170: docs(data-engine): add searchFields to EngineQueryOptions block#7354
os-help merged 1 commit into
mainfrom
claude/issue-7170-data-engine-searchfields

Conversation

@os-help

Copy link
Copy Markdown
Collaborator

Fixes#7170

What

content/docs/kernel/contracts/data-engine.mdx's hand-written EngineQueryOptions
interface block listed every member of EngineQueryOptionsSchemaexcept
searchFields, a real declared and enforced option since #4371. This adds the
missing line.

Verification of the card's claims (both checked, not assumed)

  • A1 (member-by-member diff):EngineQueryOptionsSchema (via BaseEngineOptionsSchema
    • its own .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 covered
      where, fields, orderBy, limit, offset, top, search, expand, context and handled
      cursor/distinct in a separate "Removed in protocol 17" subsection right below
      (deliberate, documented omission from the interface block — they're tombstoned,
      not live options). searchFields was the only member missing with no explanation
      anywhere on the page. Confirmed: one true gap, exactly as the card states.
  • A2 (suggested wording vs. runtime/ADR-0061): checked the card's line against
    (a) the schema's own doc comment (data-engine.zod.ts:142-148: "intersected with
    the 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 ("$searchFields is a validated override... the
    server 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 it
    was 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, searchFields
    row: 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.
  • Made sure the new line agrees with, rather than contradicts, the neighbouring
    search entry's already-updated prose (post-EngineQueryOptionsSchema.search rejects the bare query string that ADR-0061 D1 calls canonical — so every engine caller that wants it must as any, losing the whole query's checking #7178/8b06bba84, canonical bare-string
    contract) — no edit was needed there, searchFields is 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 reference
tree, or any gate; no changeset (skip-changeset, applied by the PM at accept time).


Generated by Claude Code

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
@vercel

vercelBot commented Aug 10, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
ProjectDeploymentActionsUpdated (UTC)
objectstackIgnoredIgnoredAug 10, 2026 7:54am

Request Review

@github-actionsgithub-actionsBot added size/xs documentation Improvements or additions to documentation labels Aug 10, 2026
@os-helpos-help added skip-changeset PR has no user-facing published change; bypasses the changeset gate and removed documentation Improvements or additions to documentation size/xs labels Aug 10, 2026 — with Claude
@os-help
os-help marked this pull request as ready for review August 10, 2026 08:01
@os-help
os-help added this pull request to the merge queueAug 10, 2026
Merged via the queue into main with commit 7900527Aug 10, 2026
31 checks passed
@os-help
os-help deleted the claude/issue-7170-data-engine-searchfields branch August 10, 2026 08:27
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changesetPR has no user-facing published change; bypasses the changeset gate

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: data-engine.mdxEngineQueryOptions block omits searchFields, declared on the schema since #4371

2 participants

@os-help@claude