Skip to content

Commit 480eaab

Browse files
os-zhuangclaude
andcommitted
chore(spec): 合并 main(#6377)后从合并树整体重生成参考文档 (#5783)
`content/docs/references/**` 走 `merge=os-regen`,合并驱动只把 contract.mdx / metadata.mdx 记为 pending 而不做文本合并(AGENTS.md §11)。按其规定顺序重建 工作区后 `check:generated --fix`,产物现同时含 #6377 的新版式(顶层长枚举移入 Allowed Values 小节、联合变体印数量)与本单从 ledger 摘掉的那一个码。 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01JTSZAjgtL3oR6YcpNDhW3T
1 parent 13c1182 commit 480eaab

2 files changed

Lines changed: 294 additions & 2 deletions

File tree

content/docs/references/api/contract.mdx

Lines changed: 264 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,276 @@ const result = ApiErrorSchema.parse(data);
2727

2828
| Property | Type | Required | Description |
2929
| :--- | :--- | :--- | :--- |
30-
| **code** | `Enum<'VALIDATION_ERROR' \| 'INVALID_FIELD' \| 'MISSING_REQUIRED_FIELD' \| 'INVALID_FORMAT' \| 'VALUE_TOO_LONG' \| 'VALUE_TOO_SHORT' \| 'VALUE_OUT_OF_RANGE' \| 'INVALID_REFERENCE' \| 'DUPLICATE_VALUE' \| 'INVALID_QUERY' \| 'INVALID_FILTER' \| 'INVALID_SORT' \| 'MAX_RECORDS_EXCEEDED' \| 'UNAUTHENTICATED' \| 'INVALID_CREDENTIALS' \| 'EXPIRED_TOKEN' \| 'INVALID_TOKEN' \| 'SESSION_EXPIRED' \| 'MFA_REQUIRED' \| 'EMAIL_NOT_VERIFIED' \| 'PERMISSION_DENIED' \| 'INSUFFICIENT_PRIVILEGES' \| 'FIELD_NOT_ACCESSIBLE' \| 'RECORD_NOT_ACCESSIBLE' \| 'LICENSE_REQUIRED' \| 'IP_RESTRICTED' \| 'TIME_RESTRICTED' \| 'RESOURCE_NOT_FOUND' \| 'OBJECT_NOT_FOUND' \| 'RECORD_NOT_FOUND' \| 'FIELD_NOT_FOUND' \| 'ENDPOINT_NOT_FOUND' \| 'RESOURCE_CONFLICT' \| 'CONCURRENT_MODIFICATION' \| 'DELETE_RESTRICTED' \| 'DUPLICATE_RECORD' \| 'LOCK_CONFLICT' \| 'METHOD_NOT_ALLOWED' \| 'PRECONDITION_REQUIRED' \| 'RATE_LIMIT_EXCEEDED' \| 'QUOTA_EXCEEDED' \| 'CONCURRENT_LIMIT_EXCEEDED' \| 'INTERNAL_ERROR' \| 'DATABASE_ERROR' \| 'TIMEOUT' \| 'SERVICE_UNAVAILABLE' \| 'NOT_IMPLEMENTED' \| 'EXTERNAL_SERVICE_ERROR' \| 'INTEGRATION_ERROR' \| 'WEBHOOK_DELIVERY_FAILED' \| 'BATCH_PARTIAL_FAILURE' \| 'BATCH_COMPLETE_FAILURE' \| 'TRANSACTION_FAILED' \| 'ACCOUNT_LOCKED' \| 'ALREADY_REVERTED' \| 'AMBIGUOUS_MATCH' \| 'ANALYTICS_QUERY_FAILED' \| 'APPROVAL_ACTIONS_FAILED' \| 'APPROVAL_RECALL_FAILED' \| 'APPROVAL_REQUEST_GET_FAILED' \| 'APPROVAL_REQUEST_LIST_FAILED' \| 'ASYNC_NOT_SUPPORTED' \| 'ATTACHMENT_DELETE_DENIED' \| 'ATTACHMENT_DOWNLOAD_DENIED' \| 'ATTACHMENT_PARENT_ACCESS' \| 'AUDIENCE_NOT_ALLOWED' \| 'AUTH_CONFIG_ERROR' \| 'AUTH_REQUIRED' \| 'AUTOMATION_UNSCOPED_RUN_DATA_ACCESS' \| 'BATCH_ABORTED' \| 'BATCH_NOT_ATOMIC' \| 'BATCH_TOO_LARGE' \| 'BATCH_UNRESOLVED_REF' \| 'BLANK_MATCH_KEY' \| 'CLONE_DISABLED' \| 'CLOUD_FETCH_FAILED' \| 'CLOUD_UNCONFIGURED' \| 'COMMIT_NOT_FOUND' \| 'CONCURRENT_UPDATE' \| 'CONFLICTING_MAPPING' \| 'CONNECTOR_UPSTREAM_UNAVAILABLE' \| 'CREATE_FAILED' \| 'CUBE_NOT_FOUND' \| 'DATASET_INVALID' \| 'DATASOURCE_ADMIN_ERROR' \| 'DELEGABLE_SCOPE_FAILED' \| 'DELIVERY_NOT_ELIGIBLE' \| 'DESTRUCTIVE_CHANGE' \| 'DEVICE_CODE_FAILED' \| 'DOMAIN_VERIFICATION_DISABLED' \| 'DOMAIN_VERIFICATION_FAILED' \| 'DRIVER_UNAVAILABLE' \| 'DUPLICATE_REQUEST' \| 'EMAIL_SEND_FAILED' \| 'EMAIL_SERVICE_REQUIRED' \| 'ENQUEUE_FAILED' \| 'ENVIRONMENT_BIND_FAILED' \| 'ENVIRONMENT_NOT_FOUND' \| 'ENV_ACCESS_DENIED' \| 'ERR_BULK_RESULT_MISMATCH' \| 'ERR_DATASOURCE_UNAVAILABLE' \| 'ERR_DRIVER_CONNECT' \| 'ERR_FILE_CONSTRAINT' \| 'ERR_FILE_REFERENCE_COPY' \| 'ERR_READONLY_FIELD_REJECTED' \| 'ERR_SUMMARY_RECOMPUTE' \| 'EXECUTION_ERROR' \| 'EXPIRED_OR_REVOKED' \| 'EXPIRY_IN_PAST' \| 'EXPIRY_TOO_LONG' \| 'EXPLAIN_FAILED' \| 'EXPORT_NOT_PERMITTED' \| 'EXTERNAL_DATASOURCE_ERROR' \| 'EXTERNAL_IMPORT_ERROR' \| 'EXTERNAL_SCHEMA_MISMATCH' \| 'EXTERNAL_SCHEMA_MODE_VIOLATION' \| 'EXTERNAL_WRITE_FORBIDDEN' \| 'FEEDS_DISABLED' \| 'FILES_DISABLED' \| 'FILE_DOWNLOAD_DENIED' \| 'FILE_NOT_FOUND' \| 'FILTER_TOKEN_UNKNOWN' \| 'FILTER_TOKEN_UNRESOLVED' \| 'FORBIDDEN' \| 'FORM_NOT_FOUND' \| 'FORM_RESOLVE_FAILED' \| 'IMPORT_JOB_CREATE_FAILED' \| 'IMPORT_ROW_FAILED' \| 'INTERNAL' \| 'INVALID_EMAIL' \| 'INVALID_EXPIRY' \| 'INVALID_METADATA' \| 'INVALID_OR_EXPIRED' \| 'INVALID_PHONE' \| 'INVALID_REQUEST' \| 'INVALID_RESUME_TOKEN' \| 'INVALID_SIGNAL' \| 'INVALID_SIGNATURE' \| 'INVALID_STATE' \| 'INVITE_EMAIL_FAILED' \| 'INVITE_REQUIRES_EMAIL' \| 'INVITE_SMS_FAILED' \| 'IP_NOT_ALLOWED' \| 'ITEM_LOCKED' \| 'LAST_LOCAL_CREDENTIAL' \| 'LOOKUP_NOT_PUBLIC' \| 'LOOKUP_TARGET_MISSING' \| 'MANIFEST_CONFLICT' \| 'MAPPING_FORMAT_MISMATCH' \| 'MAPPING_FORMAT_UNSUPPORTED' \| 'MAPPING_NOT_FOUND' \| 'MAPPING_TARGET_MISMATCH' \| 'MARKETPLACE_PROXY_FAILED' \| 'MARKETPLACE_STORAGE_FAILED' \| 'MARKETPLACE_UNAVAILABLE' \| 'METADATA_BRANCH' \| 'METADATA_CONFLICT' \| 'METADATA_NOT_FOUND' \| 'METADATA_SCHEMA_INVALID' \| 'MONGODB_MULTI_TENANT_UNSUPPORTED' \| 'NAMESPACE_PREFIX' \| 'NEEDS_PASSWORD' \| 'NODE_FAILURE' \| 'NOTHING_TO_PURGE' \| 'NOT_ATTEMPTED' \| 'NOT_CREATABLE' \| 'NOT_FOUND' \| 'NOT_OVERRIDABLE' \| 'NOT_UNDOABLE' \| 'NO_DRAFT' \| 'NO_EXECUTOR' \| 'NO_IDENTITY' \| 'NO_MATCH' \| 'NO_PENDING_VERIFICATION' \| 'OAUTH_REGISTER_FAILED' \| 'OBJECT_API_DISABLED' \| 'OBJECT_API_METHOD_NOT_ALLOWED' \| 'OPENAPI_UNAVAILABLE' \| 'OS_PROTOCOL_INCOMPATIBLE' \| 'PACKAGE_DELETE_FAILED' \| 'PACKAGE_DELETE_PARTIAL' \| 'PACKAGE_MANIFEST_INVALID' \| 'PACKAGE_PUBLISH_FAILED' \| 'PASSWORD_ALREADY_SET' \| 'PASSWORD_EXPIRED' \| 'PASSWORD_POLICY_VIOLATION' \| 'PASSWORD_REUSE' \| 'PAYLOAD_TOO_LARGE' \| 'PERMISSION_NOT_ALLOWED' \| 'PHONE_NOT_ENABLED' \| 'PLUGIN_INSTALL_FAILED' \| 'PLUGIN_MANIFEST_INVALID' \| 'PLUGIN_REGISTER_FAILED' \| 'PROJECT_MEMBERSHIP_REQUIRED' \| 'PROJECT_NOT_FOUND' \| 'PROJECT_PROVISIONING' \| 'PROJECT_PROVISIONING_FAILED' \| 'RAW_SQL_UNSUPPORTED' \| 'READ_SCOPE_COMPILE_FAILED' \| 'RECORD_GONE' \| 'RECORD_LOCKED' \| 'REPORTS_LIST_FAILED' \| 'REPORT_DELETE_FAILED' \| 'REPORT_GET_FAILED' \| 'REPORT_NOT_FOUND' \| 'REPORT_RUN_FAILED' \| 'REPORT_SAVE_FAILED' \| 'REPORT_SCHEDULE_FAILED' \| 'REQUEST_NOT_FOUND' \| 'RESEED_NO_ROWS' \| 'RESEED_SKIPPED' \| 'RESUME_FAILED' \| 'RESUME_IN_PROGRESS' \| 'RESUME_TARGET_LOST' \| 'ROLLED_BACK' \| 'ROUTE_NOT_FOUND' \| 'RULE_DEFINE_FAILED' \| 'RULE_DELETE_FAILED' \| 'RULE_EVALUATE_FAILED' \| 'RULE_GET_FAILED' \| 'RULE_LIST_FAILED' \| 'RULE_NOT_FOUND' \| 'RUN_NOT_FOUND' \| 'SAML_REGISTER_FAILED' \| 'SCHEDULES_LIST_FAILED' \| 'SCHEDULE_DELETE_FAILED' \| 'SETTINGS_ACTION_FAILED' \| 'SETTINGS_FORBIDDEN' \| 'SETTINGS_LOCKED' \| 'SETTINGS_UNKNOWN_KEY' \| 'SETTINGS_UNKNOWN_NAMESPACE' \| 'SETTINGS_VALIDATION' \| 'SHARES_LIST_FAILED' \| 'SHARE_GRANT_FAILED' \| 'SHARE_REVOKE_FAILED' \| 'SHARING_NOT_ENABLED' \| 'SIGN_IN_REQUIRED' \| 'SSO_REGISTER_FAILED' \| 'SSO_REGISTER_FORBIDDEN' \| 'STORE_UNAVAILABLE' \| 'SUGGESTION_CONFIRM_FAILED' \| 'SUGGESTION_DISMISS_FAILED' \| 'SUGGESTION_LIST_FAILED' \| 'SUGGESTION_NOT_FOUND' \| 'SUGGESTION_STATE' \| 'SUMMARY_RECOMPUTE_FAILED' \| 'UNAUTHORIZED' \| 'UNIQUE_VIOLATION' \| 'UNKNOWN_KEY' \| 'UNKNOWN_NAMESPACE' \| 'UNSUPPORTED' \| 'UNSUPPORTED_QUERY_PARAM' \| 'UNSUPPORTED_TRANSFORM' \| 'UPLOAD_SESSION_NOT_FOUND' \| 'USER_ALREADY_EXISTS' \| 'VALIDATION_FAILED' \| 'VERSION_NOT_FOUND' \| 'VERSION_NOT_RESTORABLE' \| 'WRITABLE_PACKAGE_REQUIRED' \| 'WRONG_PASSWORD'>` | ✅ | Error code (e.g. VALIDATION_ERROR; StandardErrorCode ∪ ERROR_CODE_LEDGER) |
30+
| **code** | `Enum<'VALIDATION_ERROR' \| 'INVALID_FIELD' \| 'MISSING_REQUIRED_FIELD' \| 'INVALID_FORMAT' \| 'VALUE_TOO_LONG' \| 'VALUE_TOO_SHORT' \| 'VALUE_OUT_OF_RANGE' \| … +253 more>` || Error code (e.g. VALIDATION_ERROR; StandardErrorCode ∪ ERROR_CODE_LEDGER) |
3131
| **message** | `string` || Readable error message |
3232
| **category** | `string` | optional | Error category (e.g. validation, authorization) |
3333
| **httpStatus** | `integer` | optional | HTTP status of the response carrying this error |
3434
| **details** | `any` | optional | Additional error context (e.g. field validation errors) |
3535
| **requestId** | `string` | optional | Request ID for tracking |
3636

37+
### Allowed Values: `ApiError.code`
38+
39+
* `VALIDATION_ERROR`
40+
* `INVALID_FIELD`
41+
* `MISSING_REQUIRED_FIELD`
42+
* `INVALID_FORMAT`
43+
* `VALUE_TOO_LONG`
44+
* `VALUE_TOO_SHORT`
45+
* `VALUE_OUT_OF_RANGE`
46+
* `INVALID_REFERENCE`
47+
* `DUPLICATE_VALUE`
48+
* `INVALID_QUERY`
49+
* `INVALID_FILTER`
50+
* `INVALID_SORT`
51+
* `MAX_RECORDS_EXCEEDED`
52+
* `UNAUTHENTICATED`
53+
* `INVALID_CREDENTIALS`
54+
* `EXPIRED_TOKEN`
55+
* `INVALID_TOKEN`
56+
* `SESSION_EXPIRED`
57+
* `MFA_REQUIRED`
58+
* `EMAIL_NOT_VERIFIED`
59+
* `PERMISSION_DENIED`
60+
* `INSUFFICIENT_PRIVILEGES`
61+
* `FIELD_NOT_ACCESSIBLE`
62+
* `RECORD_NOT_ACCESSIBLE`
63+
* `LICENSE_REQUIRED`
64+
* `IP_RESTRICTED`
65+
* `TIME_RESTRICTED`
66+
* `RESOURCE_NOT_FOUND`
67+
* `OBJECT_NOT_FOUND`
68+
* `RECORD_NOT_FOUND`
69+
* `FIELD_NOT_FOUND`
70+
* `ENDPOINT_NOT_FOUND`
71+
* `RESOURCE_CONFLICT`
72+
* `CONCURRENT_MODIFICATION`
73+
* `DELETE_RESTRICTED`
74+
* `DUPLICATE_RECORD`
75+
* `LOCK_CONFLICT`
76+
* `METHOD_NOT_ALLOWED`
77+
* `PRECONDITION_REQUIRED`
78+
* `RATE_LIMIT_EXCEEDED`
79+
* `QUOTA_EXCEEDED`
80+
* `CONCURRENT_LIMIT_EXCEEDED`
81+
* `INTERNAL_ERROR`
82+
* `DATABASE_ERROR`
83+
* `TIMEOUT`
84+
* `SERVICE_UNAVAILABLE`
85+
* `NOT_IMPLEMENTED`
86+
* `EXTERNAL_SERVICE_ERROR`
87+
* `INTEGRATION_ERROR`
88+
* `WEBHOOK_DELIVERY_FAILED`
89+
* `BATCH_PARTIAL_FAILURE`
90+
* `BATCH_COMPLETE_FAILURE`
91+
* `TRANSACTION_FAILED`
92+
* `ACCOUNT_LOCKED`
93+
* `ALREADY_REVERTED`
94+
* `AMBIGUOUS_MATCH`
95+
* `ANALYTICS_QUERY_FAILED`
96+
* `APPROVAL_ACTIONS_FAILED`
97+
* `APPROVAL_RECALL_FAILED`
98+
* `APPROVAL_REQUEST_GET_FAILED`
99+
* `APPROVAL_REQUEST_LIST_FAILED`
100+
* `ASYNC_NOT_SUPPORTED`
101+
* `ATTACHMENT_DELETE_DENIED`
102+
* `ATTACHMENT_DOWNLOAD_DENIED`
103+
* `ATTACHMENT_PARENT_ACCESS`
104+
* `AUDIENCE_NOT_ALLOWED`
105+
* `AUTH_CONFIG_ERROR`
106+
* `AUTH_REQUIRED`
107+
* `AUTOMATION_UNSCOPED_RUN_DATA_ACCESS`
108+
* `BATCH_ABORTED`
109+
* `BATCH_NOT_ATOMIC`
110+
* `BATCH_TOO_LARGE`
111+
* `BATCH_UNRESOLVED_REF`
112+
* `BLANK_MATCH_KEY`
113+
* `CLONE_DISABLED`
114+
* `CLOUD_FETCH_FAILED`
115+
* `CLOUD_UNCONFIGURED`
116+
* `COMMIT_NOT_FOUND`
117+
* `CONCURRENT_UPDATE`
118+
* `CONFLICTING_MAPPING`
119+
* `CONNECTOR_UPSTREAM_UNAVAILABLE`
120+
* `CREATE_FAILED`
121+
* `CUBE_NOT_FOUND`
122+
* `DATASET_INVALID`
123+
* `DATASOURCE_ADMIN_ERROR`
124+
* `DELEGABLE_SCOPE_FAILED`
125+
* `DELIVERY_NOT_ELIGIBLE`
126+
* `DESTRUCTIVE_CHANGE`
127+
* `DEVICE_CODE_FAILED`
128+
* `DOMAIN_VERIFICATION_DISABLED`
129+
* `DOMAIN_VERIFICATION_FAILED`
130+
* `DRIVER_UNAVAILABLE`
131+
* `DUPLICATE_REQUEST`
132+
* `EMAIL_SEND_FAILED`
133+
* `EMAIL_SERVICE_REQUIRED`
134+
* `ENQUEUE_FAILED`
135+
* `ENVIRONMENT_BIND_FAILED`
136+
* `ENVIRONMENT_NOT_FOUND`
137+
* `ENV_ACCESS_DENIED`
138+
* `ERR_BULK_RESULT_MISMATCH`
139+
* `ERR_DATASOURCE_UNAVAILABLE`
140+
* `ERR_DRIVER_CONNECT`
141+
* `ERR_FILE_CONSTRAINT`
142+
* `ERR_FILE_REFERENCE_COPY`
143+
* `ERR_READONLY_FIELD_REJECTED`
144+
* `ERR_SUMMARY_RECOMPUTE`
145+
* `EXECUTION_ERROR`
146+
* `EXPIRED_OR_REVOKED`
147+
* `EXPIRY_IN_PAST`
148+
* `EXPIRY_TOO_LONG`
149+
* `EXPLAIN_FAILED`
150+
* `EXPORT_NOT_PERMITTED`
151+
* `EXTERNAL_DATASOURCE_ERROR`
152+
* `EXTERNAL_IMPORT_ERROR`
153+
* `EXTERNAL_SCHEMA_MISMATCH`
154+
* `EXTERNAL_SCHEMA_MODE_VIOLATION`
155+
* `EXTERNAL_WRITE_FORBIDDEN`
156+
* `FEEDS_DISABLED`
157+
* `FILES_DISABLED`
158+
* `FILE_DOWNLOAD_DENIED`
159+
* `FILE_NOT_FOUND`
160+
* `FILTER_TOKEN_UNKNOWN`
161+
* `FILTER_TOKEN_UNRESOLVED`
162+
* `FORBIDDEN`
163+
* `FORM_NOT_FOUND`
164+
* `FORM_RESOLVE_FAILED`
165+
* `IMPORT_JOB_CREATE_FAILED`
166+
* `IMPORT_ROW_FAILED`
167+
* `INTERNAL`
168+
* `INVALID_EMAIL`
169+
* `INVALID_EXPIRY`
170+
* `INVALID_METADATA`
171+
* `INVALID_OR_EXPIRED`
172+
* `INVALID_PHONE`
173+
* `INVALID_REQUEST`
174+
* `INVALID_RESUME_TOKEN`
175+
* `INVALID_SIGNAL`
176+
* `INVALID_SIGNATURE`
177+
* `INVALID_STATE`
178+
* `INVITE_EMAIL_FAILED`
179+
* `INVITE_REQUIRES_EMAIL`
180+
* `INVITE_SMS_FAILED`
181+
* `IP_NOT_ALLOWED`
182+
* `ITEM_LOCKED`
183+
* `LAST_LOCAL_CREDENTIAL`
184+
* `LOOKUP_NOT_PUBLIC`
185+
* `LOOKUP_TARGET_MISSING`
186+
* `MANIFEST_CONFLICT`
187+
* `MAPPING_FORMAT_MISMATCH`
188+
* `MAPPING_FORMAT_UNSUPPORTED`
189+
* `MAPPING_NOT_FOUND`
190+
* `MAPPING_TARGET_MISMATCH`
191+
* `MARKETPLACE_PROXY_FAILED`
192+
* `MARKETPLACE_STORAGE_FAILED`
193+
* `MARKETPLACE_UNAVAILABLE`
194+
* `METADATA_BRANCH`
195+
* `METADATA_CONFLICT`
196+
* `METADATA_NOT_FOUND`
197+
* `METADATA_SCHEMA_INVALID`
198+
* `MONGODB_MULTI_TENANT_UNSUPPORTED`
199+
* `NAMESPACE_PREFIX`
200+
* `NEEDS_PASSWORD`
201+
* `NODE_FAILURE`
202+
* `NOTHING_TO_PURGE`
203+
* `NOT_ATTEMPTED`
204+
* `NOT_CREATABLE`
205+
* `NOT_FOUND`
206+
* `NOT_OVERRIDABLE`
207+
* `NOT_UNDOABLE`
208+
* `NO_DRAFT`
209+
* `NO_EXECUTOR`
210+
* `NO_IDENTITY`
211+
* `NO_MATCH`
212+
* `NO_PENDING_VERIFICATION`
213+
* `OAUTH_REGISTER_FAILED`
214+
* `OBJECT_API_DISABLED`
215+
* `OBJECT_API_METHOD_NOT_ALLOWED`
216+
* `OPENAPI_UNAVAILABLE`
217+
* `OS_PROTOCOL_INCOMPATIBLE`
218+
* `PACKAGE_DELETE_FAILED`
219+
* `PACKAGE_DELETE_PARTIAL`
220+
* `PACKAGE_MANIFEST_INVALID`
221+
* `PACKAGE_PUBLISH_FAILED`
222+
* `PASSWORD_ALREADY_SET`
223+
* `PASSWORD_EXPIRED`
224+
* `PASSWORD_POLICY_VIOLATION`
225+
* `PASSWORD_REUSE`
226+
* `PAYLOAD_TOO_LARGE`
227+
* `PERMISSION_NOT_ALLOWED`
228+
* `PHONE_NOT_ENABLED`
229+
* `PLUGIN_INSTALL_FAILED`
230+
* `PLUGIN_MANIFEST_INVALID`
231+
* `PLUGIN_REGISTER_FAILED`
232+
* `PROJECT_MEMBERSHIP_REQUIRED`
233+
* `PROJECT_NOT_FOUND`
234+
* `PROJECT_PROVISIONING`
235+
* `PROJECT_PROVISIONING_FAILED`
236+
* `RAW_SQL_UNSUPPORTED`
237+
* `READ_SCOPE_COMPILE_FAILED`
238+
* `RECORD_GONE`
239+
* `RECORD_LOCKED`
240+
* `REPORTS_LIST_FAILED`
241+
* `REPORT_DELETE_FAILED`
242+
* `REPORT_GET_FAILED`
243+
* `REPORT_NOT_FOUND`
244+
* `REPORT_RUN_FAILED`
245+
* `REPORT_SAVE_FAILED`
246+
* `REPORT_SCHEDULE_FAILED`
247+
* `REQUEST_NOT_FOUND`
248+
* `RESEED_NO_ROWS`
249+
* `RESEED_SKIPPED`
250+
* `RESUME_FAILED`
251+
* `RESUME_IN_PROGRESS`
252+
* `RESUME_TARGET_LOST`
253+
* `ROLLED_BACK`
254+
* `ROUTE_NOT_FOUND`
255+
* `RULE_DEFINE_FAILED`
256+
* `RULE_DELETE_FAILED`
257+
* `RULE_EVALUATE_FAILED`
258+
* `RULE_GET_FAILED`
259+
* `RULE_LIST_FAILED`
260+
* `RULE_NOT_FOUND`
261+
* `RUN_NOT_FOUND`
262+
* `SAML_REGISTER_FAILED`
263+
* `SCHEDULES_LIST_FAILED`
264+
* `SCHEDULE_DELETE_FAILED`
265+
* `SETTINGS_ACTION_FAILED`
266+
* `SETTINGS_FORBIDDEN`
267+
* `SETTINGS_LOCKED`
268+
* `SETTINGS_UNKNOWN_KEY`
269+
* `SETTINGS_UNKNOWN_NAMESPACE`
270+
* `SETTINGS_VALIDATION`
271+
* `SHARES_LIST_FAILED`
272+
* `SHARE_GRANT_FAILED`
273+
* `SHARE_REVOKE_FAILED`
274+
* `SHARING_NOT_ENABLED`
275+
* `SIGN_IN_REQUIRED`
276+
* `SSO_REGISTER_FAILED`
277+
* `SSO_REGISTER_FORBIDDEN`
278+
* `STORE_UNAVAILABLE`
279+
* `SUGGESTION_CONFIRM_FAILED`
280+
* `SUGGESTION_DISMISS_FAILED`
281+
* `SUGGESTION_LIST_FAILED`
282+
* `SUGGESTION_NOT_FOUND`
283+
* `SUGGESTION_STATE`
284+
* `SUMMARY_RECOMPUTE_FAILED`
285+
* `UNAUTHORIZED`
286+
* `UNIQUE_VIOLATION`
287+
* `UNKNOWN_KEY`
288+
* `UNKNOWN_NAMESPACE`
289+
* `UNSUPPORTED`
290+
* `UNSUPPORTED_QUERY_PARAM`
291+
* `UNSUPPORTED_TRANSFORM`
292+
* `UPLOAD_SESSION_NOT_FOUND`
293+
* `USER_ALREADY_EXISTS`
294+
* `VALIDATION_FAILED`
295+
* `VERSION_NOT_FOUND`
296+
* `VERSION_NOT_RESTORABLE`
297+
* `WRITABLE_PACKAGE_REQUIRED`
298+
* `WRONG_PASSWORD`
299+
37300

38301
---
39302

content/docs/references/api/metadata.mdx

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -361,11 +361,40 @@ Metadata query with filtering, sorting, and pagination
361361

362362
| Property | Type | Required | Description |
363363
| :--- | :--- | :--- | :--- |
364-
| **type** | `Enum<'object' \| 'field' \| 'hook' \| 'seed' \| 'mapping' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| 'external_catalog' \| 'translation' \| 'api' \| 'email_template' \| 'doc' \| 'book' \| 'permission' \| 'position' \| 'agent' \| 'tool' \| 'skill'>` || Metadata type |
364+
| **type** | `Enum<'object' \| 'field' \| 'hook' \| 'seed' \| 'mapping' \| 'view' \| 'page' \| 'dashboard' \| 'app' \| 'action' \| 'report' \| 'dataset' \| 'flow' \| 'job' \| 'datasource' \| … +11 more>` || Metadata type |
365365
| **name** | `string` || Item name (snake_case) |
366366
| **data** | `Record<string, any>` || Metadata payload |
367367
| **namespace** | `string` | optional | Optional namespace |
368368

369+
### Allowed Values: `MetadataRegisterRequest.type`
370+
371+
* `object`
372+
* `field`
373+
* `hook`
374+
* `seed`
375+
* `mapping`
376+
* `view`
377+
* `page`
378+
* `dashboard`
379+
* `app`
380+
* `action`
381+
* `report`
382+
* `dataset`
383+
* `flow`
384+
* `job`
385+
* `datasource`
386+
* `external_catalog`
387+
* `translation`
388+
* `api`
389+
* `email_template`
390+
* `doc`
391+
* `book`
392+
* `permission`
393+
* `position`
394+
* `agent`
395+
* `tool`
396+
* `skill`
397+
369398

370399
---
371400

0 commit comments

Comments
 (0)