Skip to content

Commit 4695184

Browse files
docs: unify API query syntax with Spec canonical format
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>
1 parent c8dc320 commit 4695184

3 files changed

Lines changed: 655 additions & 783 deletions

File tree

CHANGELOG.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
77

88
## [Unreleased]
99

10+
### Documentation
11+
- **Unified API query syntax documentation with Spec canonical format** — Rewrote
12+
`content/docs/protocol/objectql/query-syntax.mdx` and
13+
`content/docs/guides/contracts/data-engine.mdx` to align all examples, interface
14+
definitions, and field names with the canonical `QuerySchema`, `FilterConditionSchema`,
15+
and `EngineQueryOptionsSchema` from `@objectstack/spec`. All query examples now use
16+
`where` + MongoDB-style `$op` object syntax (replacing legacy tuple/`filters`/三元组
17+
format), `orderBy` (replacing `sort`), `groupBy` (replacing `group_by`), and
18+
`aggregations` array (replacing `aggregate` object map). `IDataEngine` contract
19+
documentation updated to reflect the real interface (`find`/`findOne`/`insert`/
20+
`update`/`delete`/`count`/`aggregate`). Added legacy compatibility sections clearly
21+
marking tuple/array syntax as UI-builder input only, with migration guidance.
22+
1023
### Changed
1124
- **Studio Vercel deployment — switched from InMemoryDriver to TursoDriver** — The Studio serverless
1225
API entrypoint (`apps/studio/api/index.ts`) now uses `@objectstack/driver-turso` (TursoDriver)

0 commit comments

Comments
 (0)