Skip to content

Commit d7f303a

Browse files
julianrichieclaude
andcommitted
docs: fix stale README API reference
Correct the search_read keyword (sort -> order), document read's positional field list, and fix fields_get's return type (object keyed by field name, not an array). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 5964441 commit d7f303a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,15 +149,15 @@ Each data function also accepts an optional trailing `opts?: OdxRequestOptions`
149149

150150
- search_read<T = any>(model, params, keyword, id?)
151151
- params: domain array
152-
- keyword: can include fields, limit, offset, sort, and context
152+
- keyword: can include fields, limit, offset, order, and context
153153
- returns: result?: T[] (records)
154154

155155
- read<T = any>(model, params, keyword, id?)
156-
- params: array of record IDs wrapped (e.g., [[1,2,3]])
157-
- returns: result?: T
156+
- params: record IDs, with the field list passed positionally (e.g., [[1,2,3], ["name","email"]]); fields in `keyword` are ignored for read
157+
- returns: result?: T (array of records)
158158

159159
- fields_get<T = any>(model, keyword, id?)
160-
- returns: result?: T[] (field metadata)
160+
- returns: result?: T (object keyed by field name → field metadata)
161161

162162
- search_count<T = number>(model, params, keyword, id?)
163163
- returns: result?: T (count)

0 commit comments

Comments
 (0)