Skip to content

Commit 01b3199

Browse files
committed
docs(api): name the read-path case in the INVALID_FIELD catalog entry (#4134)
The entry already said "a field name in the request does not exist on the target object", which covers a list read too — but the FIX it prescribed (inspect the schema, use a valid field name) is the wrong advice for the case that will now hit it most: a caller who meant `pageSize` as a parameter, not a field. Point those at `top`/`$top`/`limit` and at the Data API page. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01CKsxtrsCwSL3uAcxAdVj83
1 parent b373e13 commit 01b3199

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

‎content/docs/api/error-catalog.mdx‎

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,14 @@ ObjectStack uses a structured error system with **9 error categories** and **53
7171
```
7272

7373
### `INVALID_FIELD`
74-
**Cause:** A field name in the request does not exist on the target object.
75-
**Fix:** Check the object schema for valid field names. Use `os meta get object <name>` to inspect the object's fields.
74+
**Cause:** A field name in the request does not exist on the target object. On a
75+
list read this also covers an unreserved query parameter — `GET /data/:object`
76+
reads those as field filters, so one naming no field could only match zero
77+
records and is rejected rather than answered with an empty page.
78+
**Fix:** Check the object schema for valid field names. Use `os meta get object <name>` to inspect the object's fields. If the name was meant as a
79+
*parameter* rather than a field, use the real one — page size is `top` / `$top`
80+
/ `limit`, not `pageSize` / `perPage`; the response's `error` names the
81+
substitute. See the [Data API](/docs/api/data-api).
7682
**Retry:** `no_retry`
7783

7884
### `MISSING_REQUIRED_FIELD`

0 commit comments

Comments
 (0)