docs: unify API query syntax with Spec canonical format#988
Merged
xuyushun441-sys merged 2 commits intomainfrom Mar 27, 2026
Merged
docs: unify API query syntax with Spec canonical format#988xuyushun441-sys merged 2 commits intomainfrom
xuyushun441-sys merged 2 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Rewrote query-syntax.mdx and data-engine.mdx to align all examples, interface definitions, and field names with canonical QuerySchema, FilterConditionSchema, and EngineQueryOptionsSchema from @objectstack/spec. - where + MongoDB-style $op object syntax (replaces filters/tuple/三元组) - orderBy (replaces sort), groupBy (replaces group_by) - aggregations array (replaces aggregate object map) - expand as Record<string, QueryAST> (replaces string array) - IDataEngine contract matches real interface (find/findOne/insert/update/delete/count/aggregate) - Added legacy compatibility sections with migration guidance - Updated CHANGELOG.md Agent-Logs-Url: https://github.com/objectstack-ai/spec/sessions/fc216716-2629-4ab4-821b-479aa8d48b3f Co-authored-by: xuyushun441-sys <255036401+xuyushun441-sys@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update API query syntax documentation to align with Spec standards
docs: unify API query syntax with Spec canonical format
Mar 27, 2026
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 free
to 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.
Documentation for query syntax and IDataEngine contract diverged from the canonical
@objectstack/specschemas — using legacyfilters/tuple/sort/group_by/aggregatenaming instead of the actualQuerySchemaandEngineQueryOptionsSchemadefinitions.query-syntax.mdx— full rewritewhere+$opobject syntax, replacing tuple/三元组 formatsort→orderBy,group_by→groupBy,aggregate→aggregationsarray,expand→Record<string, QueryAST>QueryASTtypesearch,joins,windowFunctions,cursor,distinctdata-engine.mdx— full rewriteIDataEngine:find/findOne/insert/update/delete/count/aggregateEngineQueryOptions,EngineUpdateOptions, etc.)vectorFind,batch,executeLegacy compatibility sections
Both docs now include explicit callouts: tuple/
filterssyntax is UI-builder input only — must be converted viaparseFilterAST()before entering the protocol.💬 Send tasks to Copilot coding agent from Slack and Teams to turn conversations into code. Copilot posts an update in your thread when it's finished.