@permute/sdk 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +139 -13
- package/dist/app.d.ts +8 -0
- package/dist/app.js +6 -0
- package/dist/auth/oauth.d.ts +64 -0
- package/dist/auth/oauth.js +221 -0
- package/dist/auth/store.d.ts +39 -0
- package/dist/auth/store.js +70 -0
- package/dist/auth.d.ts +1 -0
- package/dist/auth.js +1 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +127 -0
- package/dist/client.d.ts +40 -14
- package/dist/client.js +32 -3
- package/dist/deploy.d.ts +1 -1
- package/dist/generated/openapi.d.ts +401 -9
- package/dist/generated/runtime-contract.d.ts +34 -28
- package/dist/generated/runtime-contract.js +98 -75
- package/dist/index.d.ts +15 -15
- package/dist/types.d.ts +28 -1
- package/package.json +14 -3
|
@@ -1,66 +1,80 @@
|
|
|
1
1
|
// This file is generated by scripts/generate-contract.ts. Do not edit.
|
|
2
2
|
// prettier-ignore
|
|
3
3
|
export const publicApiRoutes = {
|
|
4
|
-
"
|
|
5
|
-
"
|
|
6
|
-
"
|
|
7
|
-
"
|
|
8
|
-
"
|
|
9
|
-
"
|
|
10
|
-
"
|
|
4
|
+
"emailsGet": { "operationId": "emailsGet", "method": "GET", "path": "/v1/emails", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^esnd_[a-z0-9]{24}$" }, "address": { "type": "string", "maxLength": 254, "allOf": [{ "type": "string", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "string", "pattern": "^[\\x21-\\x7e]+$" }] }, "status": { "type": "string", "enum": ["provisioning", "ready", "failed"] }, "error": { "nullable": true, "type": "string" } }, "required": ["id", "address", "status", "error"], "additionalProperties": false } },
|
|
5
|
+
"emailsSend": { "operationId": "emailsSend", "method": "POST", "path": "/v1/emails", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "to": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "string", "maxLength": 254, "allOf": [{ "type": "string", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "string", "pattern": "^[\\x21-\\x7e]+$" }] } }, "subject": { "type": "string", "minLength": 1, "maxLength": 255 }, "text": { "type": "string", "minLength": 1, "maxLength": 100000 }, "html": { "type": "string", "minLength": 1, "maxLength": 100000 } }, "required": ["to", "subject", "text"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["accepted"] } }, "required": ["id", "status"], "additionalProperties": false } },
|
|
6
|
+
"accessRequestsCreate": { "operationId": "accessRequestsCreate", "method": "POST", "path": "/v1/access-requests", "scope": "workspace", "bodySchema": { "anyOf": [{ "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": ["resourceId", "level", "reason"], "additionalProperties": false }, { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 } }, "required": ["resourceId", "operations", "reason"], "additionalProperties": false }] }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "resourceType": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "applicationId": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "approved", "resolved", "rejected", "cancelled", "expired"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "reason", "resourceType", "principalType", "principalId", "id", "status", "createdAt", "expiresAt"], "additionalProperties": false } },
|
|
7
|
+
"accessRequestsList": { "operationId": "accessRequestsList", "method": "GET", "path": "/v1/access-requests", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "view": { "default": "mine", "type": "string", "enum": ["mine", "review", "history"] }, "state": { "type": "string", "enum": ["pending", "closed"] }, "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "cursor": { "type": "string", "pattern": "^task_[a-z0-9]{24}$" } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "resourceType": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "applicationId": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "approved", "resolved", "rejected", "cancelled", "expired"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "reason", "resourceType", "principalType", "principalId", "id", "status", "createdAt", "expiresAt"], "additionalProperties": false } }, "nextCursor": { "nullable": true, "type": "string" }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["items", "nextCursor", "total"], "additionalProperties": false } },
|
|
8
|
+
"accessRequestsGet": { "operationId": "accessRequestsGet", "method": "GET", "path": "/v1/access-requests/{requestId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "resourceType": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "applicationId": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "approved", "resolved", "rejected", "cancelled", "expired"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "reason", "resourceType", "principalType", "principalId", "id", "status", "createdAt", "expiresAt"], "additionalProperties": false } },
|
|
9
|
+
"accessRequestsDecide": { "operationId": "accessRequestsDecide", "method": "POST", "path": "/v1/access-requests/{requestId}/decisions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "decision": { "type": "string", "enum": ["approved", "resolved", "rejected", "cancelled"] } }, "required": ["decision"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "reason": { "type": "string", "minLength": 1, "maxLength": 1000 }, "resourceType": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "applicationId": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "approved", "resolved", "rejected", "cancelled", "expired"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "reason", "resourceType", "principalType", "principalId", "id", "status", "createdAt", "expiresAt"], "additionalProperties": false } },
|
|
10
|
+
"permissionsUpdate": { "operationId": "permissionsUpdate", "method": "PATCH", "path": "/v1/permissions/{permissionId}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "expectedUpdatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["expectedUpdatedAt"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "principalType": { "type": "string" }, "principalId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "subResourceId": { "nullable": true, "type": "string" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "nullable": true, "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "grantedBy": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "principalType", "principalId", "resourceId", "resourceType", "subResourceId", "level", "operations", "organizationId", "workspaceId", "grantedBy", "expiresAt", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
11
|
+
"permissionsDelete": { "operationId": "permissionsDelete", "method": "DELETE", "path": "/v1/permissions/{permissionId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
12
|
+
"permissionsList": { "operationId": "permissionsList", "method": "GET", "path": "/v1/permissions", "scope": "organization", "bodySchema": null, "querySchema": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 128 }, "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "workspaceId": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "principalType": { "type": "string" }, "principalId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "subResourceId": { "nullable": true, "type": "string" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "nullable": true, "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "grantedBy": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "principalType", "principalId", "resourceId", "resourceType", "subResourceId", "level", "operations", "organizationId", "workspaceId", "grantedBy", "expiresAt", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
13
|
+
"permissionsCreate": { "operationId": "permissionsCreate", "method": "POST", "path": "/v1/permissions", "scope": "organization", "bodySchema": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 128 }, "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "subResourceId": { "description": "New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API.", "type": "string", "minLength": 1, "maxLength": 128 }, "principalType": { "type": "string", "enum": ["user", "workspace", "organization", "apiKey", "application"] }, "principalId": { "type": "string", "minLength": 1, "maxLength": 320 }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "operations": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } } }, "required": ["resourceId", "resourceType", "level", "principalType", "principalId"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "principalType": { "type": "string" }, "principalId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "subResourceId": { "nullable": true, "type": "string" }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "operations": { "nullable": true, "type": "array", "items": { "type": "string" } }, "organizationId": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "grantedBy": { "type": "string" }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "principalType", "principalId", "resourceId", "resourceType", "subResourceId", "level", "operations", "organizationId", "workspaceId", "grantedBy", "expiresAt", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
14
|
+
"permissionsInspect": { "operationId": "permissionsInspect", "method": "POST", "path": "/v1/permissions/inspect", "scope": "organization", "bodySchema": { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[a-zA-Z]+_[a-z0-9]{24}$" }, "principal": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "apiKey", "application"] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": ["type", "id"], "additionalProperties": false }, "applicationId": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" } }, "required": ["resourceId", "principal"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "principal": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "apiKey", "application"] }, "id": { "type": "string", "minLength": 1, "maxLength": 128 } }, "required": ["type", "id"], "additionalProperties": false }, "principalAccess": { "type": "object", "properties": { "level": { "nullable": true, "type": "string", "enum": ["read", "write", "admin", null] }, "sources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["owner", "creator", "organization_member", "grant", "service"] }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "grant": { "type": "object", "properties": { "id": { "type": "string" }, "principalType": { "type": "string" }, "principalId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "operations": { "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } } }, "required": ["id", "principalType", "principalId", "resourceId", "resourceType", "workspaceId", "expiresAt"], "additionalProperties": false } }, "required": ["kind", "level"], "additionalProperties": false } }, "restriction": { "nullable": true, "type": "string", "enum": ["identity_policy", "resource_scope", "no_grant", null] } }, "required": ["level", "sources", "restriction"], "additionalProperties": false }, "application": { "nullable": true, "type": "object", "properties": { "id": { "type": "string" }, "access": { "type": "object", "properties": { "level": { "nullable": true, "type": "string", "enum": ["read", "write", "admin", null] }, "sources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["owner", "creator", "organization_member", "grant", "service"] }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "grant": { "type": "object", "properties": { "id": { "type": "string" }, "principalType": { "type": "string" }, "principalId": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "workspaceId": { "nullable": true, "type": "string" }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "operations": { "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } } }, "required": ["id", "principalType", "principalId", "resourceId", "resourceType", "workspaceId", "expiresAt"], "additionalProperties": false } }, "required": ["kind", "level"], "additionalProperties": false } }, "restriction": { "nullable": true, "type": "string", "enum": ["identity_policy", "resource_scope", "no_grant", null] } }, "required": ["level", "sources", "restriction"], "additionalProperties": false } }, "required": ["id", "access"], "additionalProperties": false }, "effectiveLevel": { "nullable": true, "type": "string", "enum": ["read", "write", "admin", null] }, "effectiveOperations": { "type": "array", "items": { "type": "string", "enum": ["application.read_metadata", "application.update_metadata", "application.read_implementation", "application.update_draft", "application.publish", "application.manage_access", "application.manage_hosting", "application.delete", "business_action.read_metadata", "business_action.invoke", "business_action.read_implementation", "business_action.update_draft", "business_action.publish", "business_action.manage_access", "business_action.delegate_access", "business_action.delete"] } }, "restrictions": { "type": "array", "items": { "type": "string", "enum": ["workspace_access_required", "key_inactive", "key_expired", "key_scope"] } }, "evaluatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "resourceType", "workspaceId", "principal", "principalAccess", "application", "effectiveLevel", "restrictions", "evaluatedAt"], "additionalProperties": false } },
|
|
15
|
+
"connectorSessionsCreate": { "operationId": "connectorSessionsCreate", "method": "POST", "path": "/v1/connector-sessions", "scope": "workspace", "bodySchema": { "anyOf": [{ "type": "object", "properties": { "provider": { "type": "string", "enum": ["acumatica", "amazon_ads", "amazon_seller_central", "attio", "autodesk", "bigquery", "billcom", "brex", "double", "fireflies", "gmail", "googleads", "granola", "hubspot", "instantly", "klaviyo", "mercury", "meta_ads", "microsoft_advertising", "monday", "procore", "pylon", "quickbooks", "quo", "s3", "salesforce", "shopify", "stripe", "supabase", "tiktok_ads", "tiktok_shop", "xero", "yardi"] }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "connectorId": { "type": "string", "pattern": "^conn_[a-z0-9]{24}$" }, "config": { "type": "object", "additionalProperties": {} }, "returnUrl": { "type": "string", "maxLength": 2047, "format": "uri" } }, "required": ["provider"], "additionalProperties": false }, { "type": "object", "properties": { "provider": { "type": "string", "enum": ["acumatica", "amazon_ads", "amazon_seller_central", "attio", "autodesk", "bigquery", "billcom", "brex", "double", "fireflies", "gmail", "googleads", "granola", "hubspot", "instantly", "klaviyo", "mercury", "meta_ads", "microsoft_advertising", "monday", "procore", "pylon", "quickbooks", "quo", "s3", "salesforce", "shopify", "stripe", "supabase", "tiktok_ads", "tiktok_shop", "xero", "yardi"] }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "connectorId": { "type": "string", "pattern": "^conn_[a-z0-9]{24}$" }, "config": { "type": "object", "additionalProperties": {} }, "returnUrl": { "type": "string", "maxLength": 2047, "format": "uri" } }, "required": ["connectorId"], "additionalProperties": false }] }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "connectorId": { "type": "string" }, "provider": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "in_progress", "authorized", "completed", "expired"] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectorStatus": { "type": "string" }, "url": { "type": "string", "format": "uri" } }, "required": ["id", "connectorId", "provider", "status", "expiresAt", "connectorStatus", "url"], "additionalProperties": false } },
|
|
16
|
+
"connectorSessionsGet": { "operationId": "connectorSessionsGet", "method": "GET", "path": "/v1/connector-sessions/{sessionId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "connectorId": { "type": "string" }, "provider": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "in_progress", "authorized", "completed", "expired"] }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "connectorStatus": { "type": "string" } }, "required": ["id", "connectorId", "provider", "status", "expiresAt", "connectorStatus"], "additionalProperties": false } },
|
|
17
|
+
"resourceRevisionsList": { "operationId": "resourceRevisionsList", "method": "GET", "path": "/v1/resources/{resourceId}/revisions", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string" }, "version": { "type": "string" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "capabilities": { "type": "object", "properties": { "history": { "type": "boolean" }, "restore": { "type": "boolean" }, "publish": { "type": "boolean" } }, "required": ["history", "restore", "publish"], "additionalProperties": false }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "parentRevisionId": { "nullable": true, "type": "string" }, "dependencyRevisionIds": { "type": "array", "items": { "type": "string" } }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "apiKey", "system"] }, "id": { "nullable": true, "type": "string" } }, "required": ["type", "id"], "additionalProperties": false }, "message": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "parentRevisionId", "dependencyRevisionIds", "actor", "message", "createdAt"], "additionalProperties": false } } }, "required": ["resourceId", "version", "draft", "published", "capabilities", "items"], "additionalProperties": false } },
|
|
18
|
+
"resourceRevisionsGet": { "operationId": "resourceRevisionsGet", "method": "GET", "path": "/v1/resources/{resourceId}/revisions/{revisionId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "parentRevisionId": { "nullable": true, "type": "string" }, "dependencyRevisionIds": { "type": "array", "items": { "type": "string" } }, "actor": { "type": "object", "properties": { "type": { "type": "string", "enum": ["user", "apiKey", "system"] }, "id": { "nullable": true, "type": "string" } }, "required": ["type", "id"], "additionalProperties": false }, "message": { "nullable": true, "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "resourceId": { "type": "string" }, "value": { "type": "object", "additionalProperties": {} } }, "required": ["id", "parentRevisionId", "dependencyRevisionIds", "actor", "message", "createdAt", "resourceId", "value"], "additionalProperties": false } },
|
|
19
|
+
"resourceRevisionsRestore": { "operationId": "resourceRevisionsRestore", "method": "POST", "path": "/v1/resources/{resourceId}/revisions/{revisionId}/restore", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedVersion": { "type": "string", "minLength": 1 } }, "required": ["expectedVersion"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string" }, "version": { "type": "string" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "capabilities": { "type": "object", "properties": { "history": { "type": "boolean" }, "restore": { "type": "boolean" }, "publish": { "type": "boolean" } }, "required": ["history", "restore", "publish"], "additionalProperties": false } }, "required": ["resourceId", "version", "draft", "published", "capabilities"], "additionalProperties": false } },
|
|
20
|
+
"resourcesPublish": { "operationId": "resourcesPublish", "method": "POST", "path": "/v1/resources/{resourceId}/publish", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedVersion": { "type": "string", "minLength": 1 }, "runId": { "type": "string", "minLength": 1 } }, "required": ["expectedVersion"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "resourceId": { "type": "string" }, "version": { "type": "string" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "capabilities": { "type": "object", "properties": { "history": { "type": "boolean" }, "restore": { "type": "boolean" }, "publish": { "type": "boolean" } }, "required": ["history", "restore", "publish"], "additionalProperties": false } }, "required": ["resourceId", "version", "draft", "published", "capabilities"], "additionalProperties": false } },
|
|
21
|
+
"actionsPublicationRequestsCreate": { "operationId": "actionsPublicationRequestsCreate", "method": "POST", "path": "/v1/actions/{actionId}/publication-requests", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "revisionId": { "type": "string", "pattern": "^rvsn_[a-z0-9]{24}$" }, "expectedVersion": { "type": "string", "minLength": 1, "maxLength": 128 }, "reason": { "type": "string", "maxLength": 1000 } }, "required": ["revisionId", "expectedVersion"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "actionId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "actionId"], "additionalProperties": false } },
|
|
22
|
+
"actionsPublicationRequestsList": { "operationId": "actionsPublicationRequestsList", "method": "GET", "path": "/v1/actions/{actionId}/publication-requests", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "actionId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "actionId"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
23
|
+
"actionsPublicationRequestsDecide": { "operationId": "actionsPublicationRequestsDecide", "method": "POST", "path": "/v1/actions/{actionId}/publication-requests/{requestId}/decisions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "decision": { "type": "string", "enum": ["approved", "rejected", "cancelled"] } }, "required": ["decision"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "actionId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "actionId"], "additionalProperties": false } },
|
|
24
|
+
"actionsList": { "operationId": "actionsList", "method": "GET", "path": "/v1/actions", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revisionId": { "nullable": true, "type": "string" }, "contract": { "nullable": true, "type": "object", "properties": { "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"], "description": "Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold." }, "effects": { "type": "object", "properties": { "managedDataWrites": { "type": "boolean" }, "connectorCalls": { "type": "boolean" }, "platformMethods": { "type": "array", "items": { "type": "string" } } }, "required": ["managedDataWrites", "connectorCalls", "platformMethods"], "additionalProperties": false } }, "required": ["inputSchema", "outputSchema", "invokePermission", "effects"], "additionalProperties": false }, "canEditDraft": { "type": "boolean" }, "canPublish": { "type": "boolean" } }, "required": ["id", "workspaceId", "name", "createdAt", "updatedAt", "revisionId", "contract"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
11
25
|
"actionsCreate": { "operationId": "actionsCreate", "method": "POST", "path": "/v1/actions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
12
|
-
"actionsGet": { "operationId": "actionsGet", "method": "GET", "path": "/v1/actions/{actionId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
26
|
+
"actionsGet": { "operationId": "actionsGet", "method": "GET", "path": "/v1/actions/{actionId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "revisionId": { "nullable": true, "type": "string" }, "contract": { "nullable": true, "type": "object", "properties": { "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"], "description": "Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold." }, "effects": { "type": "object", "properties": { "managedDataWrites": { "type": "boolean" }, "connectorCalls": { "type": "boolean" }, "platformMethods": { "type": "array", "items": { "type": "string" } } }, "required": ["managedDataWrites", "connectorCalls", "platformMethods"], "additionalProperties": false } }, "required": ["inputSchema", "outputSchema", "invokePermission", "effects"], "additionalProperties": false }, "canEditDraft": { "type": "boolean" }, "canPublish": { "type": "boolean" } }, "required": ["id", "workspaceId", "name", "createdAt", "updatedAt", "revisionId", "contract"], "additionalProperties": false } },
|
|
13
27
|
"actionsDelete": { "operationId": "actionsDelete", "method": "DELETE", "path": "/v1/actions/{actionId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
14
|
-
"actionDefinitionGet": { "operationId": "actionDefinitionGet", "method": "GET", "path": "/v1/actions/{actionId}/definition", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 100000 }, "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"] }, "sources": { "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^dbas_[a-z0-9]{24}$" }, "revisionId": { "type": "string", "minLength": 1 }, "readTables": { "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "
|
|
15
|
-
"actionDefinitionSave": { "operationId": "actionDefinitionSave", "method": "PUT", "path": "/v1/actions/{actionId}/definition", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedDraft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false
|
|
16
|
-
"actionsInvoke": { "operationId": "actionsInvoke", "method": "POST", "path": "/v1/actions/{actionId}/invoke", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,128}$" }, "input": { "type": "object", "additionalProperties": {} } }, "required": ["requestId", "input"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "requestId": { "type": "string" }, "actionId": { "type": "string" }, "revisionId": { "type": "string" }, "versions": { "type": "array", "items": { "anyOf": [{ "type": "string", "pattern": "^rver_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid" }] } }, "output": {} }, "required": ["requestId", "actionId", "revisionId", "versions"], "additionalProperties": false } },
|
|
17
|
-
"chatsCreate": { "operationId": "chatsCreate", "method": "POST", "path": "/v1/chats", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "action": { "type": "string", "enum": ["send_message"] }, "clientRequestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "contexts": { "type": "array", "items": { "type": "string" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "mimeType": { "type": "string", "enum": ["image/png", "image/jpeg", "image/gif", "image/webp"] }, "s3Key": { "type": "string" } }, "required": ["id", "fileName", "mimeType", "s3Key"], "additionalProperties": false }
|
|
18
|
-
"chatsGet": { "operationId": "chatsGet", "method": "GET", "path": "/v1/chats/{chatId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "
|
|
19
|
-
"chatTurnsCreate": { "operationId": "chatTurnsCreate", "method": "POST", "path": "/v1/chats/{chatId}/turns", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "action": { "type": "string", "enum": ["send_message"] }, "clientRequestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "contexts": { "type": "array", "items": { "type": "string" } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "mimeType": { "type": "string", "enum": ["image/png", "image/jpeg", "image/gif", "image/webp"] }, "s3Key": { "type": "string" } }, "required": ["id", "fileName", "mimeType", "s3Key"], "additionalProperties": false }
|
|
20
|
-
"chatsStop": { "operationId": "chatsStop", "method": "POST", "path": "/v1/chats/{chatId}/stop", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "
|
|
21
|
-
"chatDecisionsCreate": { "operationId": "chatDecisionsCreate", "method": "POST", "path": "/v1/chats/{chatId}/decisions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid" }, "approve": { "type": "boolean" } }, "required": ["requestId", "approve"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "
|
|
28
|
+
"actionDefinitionGet": { "operationId": "actionDefinitionGet", "method": "GET", "path": "/v1/actions/{actionId}/definition", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 100000 }, "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"], "description": "Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold." }, "sources": { "maxItems": 100, "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^dbas_[a-z0-9]{24}$" }, "revisionId": { "type": "string", "minLength": 1 }, "readTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } }, "writeTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["sourceId", "revisionId", "readTables", "writeTables"], "additionalProperties": false }, { "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^(data|conn|oper|enty)_[a-z0-9]{24}$" } }, "required": ["sourceId"], "additionalProperties": false }] } }, "platform": { "type": "object", "properties": { "methods": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)?$" } }, "permissions": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1 }, "resourceType": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] } }, "required": ["resourceId", "resourceType", "level"], "additionalProperties": false } } }, "required": ["methods", "permissions"], "additionalProperties": false }, "connectors": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^conn_[a-z0-9]{24}$" } } }, "required": ["source", "inputSchema", "outputSchema", "invokePermission", "sources"], "additionalProperties": false } }, "required": ["revisionId", "sequence", "definition"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 100000 }, "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"], "description": "Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold." }, "sources": { "maxItems": 100, "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^dbas_[a-z0-9]{24}$" }, "revisionId": { "type": "string", "minLength": 1 }, "readTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } }, "writeTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["sourceId", "revisionId", "readTables", "writeTables"], "additionalProperties": false }, { "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^(data|conn|oper|enty)_[a-z0-9]{24}$" } }, "required": ["sourceId"], "additionalProperties": false }] } }, "platform": { "type": "object", "properties": { "methods": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)?$" } }, "permissions": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1 }, "resourceType": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] } }, "required": ["resourceId", "resourceType", "level"], "additionalProperties": false } } }, "required": ["methods", "permissions"], "additionalProperties": false }, "connectors": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^conn_[a-z0-9]{24}$" } } }, "required": ["source", "inputSchema", "outputSchema", "invokePermission", "sources"], "additionalProperties": false } }, "required": ["revisionId", "sequence", "definition"], "additionalProperties": false }, "version": { "type": "string" } }, "required": ["draft", "published", "version"], "additionalProperties": false } },
|
|
29
|
+
"actionDefinitionSave": { "operationId": "actionDefinitionSave", "method": "PUT", "path": "/v1/actions/{actionId}/definition", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedDraft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "definition": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 100000 }, "inputSchema": { "type": "object", "additionalProperties": {} }, "outputSchema": { "type": "object", "additionalProperties": {} }, "invokePermission": { "type": "string", "enum": ["read", "write", "admin"], "description": "Minimum level for existing level-based grants, checked against current and selected published revisions. Explicit business_action.invoke grants authorize Run independently of this legacy threshold." }, "sources": { "maxItems": 100, "type": "array", "items": { "anyOf": [{ "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^dbas_[a-z0-9]{24}$" }, "revisionId": { "type": "string", "minLength": 1 }, "readTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } }, "writeTables": { "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["sourceId", "revisionId", "readTables", "writeTables"], "additionalProperties": false }, { "type": "object", "properties": { "sourceId": { "type": "string", "pattern": "^(data|conn|oper|enty)_[a-z0-9]{24}$" } }, "required": ["sourceId"], "additionalProperties": false }] } }, "platform": { "type": "object", "properties": { "methods": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*(\\.[A-Za-z][A-Za-z0-9]*)?$" } }, "permissions": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1 }, "resourceType": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9]*$" }, "level": { "type": "string", "enum": ["read", "write", "admin"] } }, "required": ["resourceId", "resourceType", "level"], "additionalProperties": false } } }, "required": ["methods", "permissions"], "additionalProperties": false }, "connectors": { "type": "object", "additionalProperties": { "type": "string", "pattern": "^conn_[a-z0-9]{24}$" } } }, "required": ["source", "inputSchema", "outputSchema", "invokePermission", "sources"], "additionalProperties": false } }, "required": ["expectedDraft", "definition"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "revisionId": { "type": "string" } }, "required": ["revisionId"], "additionalProperties": false } },
|
|
30
|
+
"actionsInvoke": { "operationId": "actionsInvoke", "method": "POST", "path": "/v1/actions/{actionId}/invoke", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,128}$" }, "input": { "type": "object", "additionalProperties": {} } }, "required": ["requestId", "input"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "requestId": { "type": "string" }, "actionId": { "type": "string" }, "revisionId": { "type": "string" }, "versions": { "type": "array", "items": { "anyOf": [{ "type": "string", "pattern": "^rver_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] } }, "output": {} }, "required": ["requestId", "actionId", "revisionId", "versions"], "additionalProperties": false } },
|
|
31
|
+
"chatsCreate": { "operationId": "chatsCreate", "method": "POST", "path": "/v1/chats", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "action": { "type": "string", "enum": ["send_message"] }, "clientRequestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "contexts": { "type": "array", "items": { "type": "string" } }, "attachments": { "maxItems": 4, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "mimeType": { "type": "string", "enum": ["image/png", "image/jpeg", "image/gif", "image/webp"] }, "s3Key": { "type": "string" } }, "required": ["id", "fileName", "mimeType", "s3Key"], "additionalProperties": false } }, "timeZone": { "type": "string" } }, "required": ["action", "clientRequestId", "message"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "nullable": true, "type": "string" }, "conversation": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" }, "timestamp": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "datasetId": { "type": "string" }, "page": { "type": "number" }, "reason": { "type": "string" }, "quote": { "type": "string" } }, "required": ["datasetId", "page"], "additionalProperties": false } }, "tableCitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "datasetId": { "type": "string" }, "page": { "type": "string" }, "tableDescription": { "type": "string" }, "sampleData": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": ["columns", "rows"], "additionalProperties": false }, "queryDetails": { "type": "object", "properties": { "connectorId": { "type": "string" }, "provider": { "type": "string" }, "sql": { "type": "string" }, "detailSql": { "type": "string" }, "sourceTables": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "retrievedAt": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["connectorId", "provider", "sql"], "additionalProperties": false } }, "required": ["id", "datasetId", "page", "tableDescription"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "appAction": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "actionId": { "type": "string" }, "name": { "type": "string" }, "input": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": ["pending", "dismissed", "completed"] } }, "required": ["requestId", "actionId", "name", "input", "status"], "additionalProperties": false } }, "additionalProperties": {} } }, "required": ["role", "content"], "additionalProperties": {} } }, "pendingTask": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "open", "in_progress", "done", "cancelled"] }, "actionType": { "type": "string" }, "actionOutputId": { "nullable": true, "type": "string" }, "draft": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instructions": { "type": "string", "minLength": 1 }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string" } }, "schedule": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, "metadata": { "type": "object", "properties": { "subtype": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "wizardState": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} }, "chatHistory": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" } }, "required": ["role", "content"], "additionalProperties": false } }, "outputSchema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name", "type"], "additionalProperties": false } } }, "required": ["name", "columns"], "additionalProperties": false } }, "isDraft": { "type": "boolean" } }, "required": ["instructions"], "additionalProperties": false } }, "required": ["id", "kind", "title", "status", "actionType", "draft"], "additionalProperties": false }, "traceSteps": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["trace_step"] }, "id": { "type": "string" }, "step": { "type": "string" }, "details": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "failed"] } }, "required": ["kind", "id", "step", "status"], "additionalProperties": false } }, "startedAt": { "type": "string" } }, "required": ["id", "status", "error", "conversation"], "additionalProperties": false } },
|
|
32
|
+
"chatsGet": { "operationId": "chatsGet", "method": "GET", "path": "/v1/chats/{chatId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "nullable": true, "type": "string" }, "conversation": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" }, "timestamp": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "datasetId": { "type": "string" }, "page": { "type": "number" }, "reason": { "type": "string" }, "quote": { "type": "string" } }, "required": ["datasetId", "page"], "additionalProperties": false } }, "tableCitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "datasetId": { "type": "string" }, "page": { "type": "string" }, "tableDescription": { "type": "string" }, "sampleData": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": ["columns", "rows"], "additionalProperties": false }, "queryDetails": { "type": "object", "properties": { "connectorId": { "type": "string" }, "provider": { "type": "string" }, "sql": { "type": "string" }, "detailSql": { "type": "string" }, "sourceTables": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "retrievedAt": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["connectorId", "provider", "sql"], "additionalProperties": false } }, "required": ["id", "datasetId", "page", "tableDescription"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "appAction": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "actionId": { "type": "string" }, "name": { "type": "string" }, "input": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": ["pending", "dismissed", "completed"] } }, "required": ["requestId", "actionId", "name", "input", "status"], "additionalProperties": false } }, "additionalProperties": {} } }, "required": ["role", "content"], "additionalProperties": {} } }, "pendingTask": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "open", "in_progress", "done", "cancelled"] }, "actionType": { "type": "string" }, "actionOutputId": { "nullable": true, "type": "string" }, "draft": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instructions": { "type": "string", "minLength": 1 }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string" } }, "schedule": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, "metadata": { "type": "object", "properties": { "subtype": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "wizardState": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} }, "chatHistory": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" } }, "required": ["role", "content"], "additionalProperties": false } }, "outputSchema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name", "type"], "additionalProperties": false } } }, "required": ["name", "columns"], "additionalProperties": false } }, "isDraft": { "type": "boolean" } }, "required": ["instructions"], "additionalProperties": false } }, "required": ["id", "kind", "title", "status", "actionType", "draft"], "additionalProperties": false }, "traceSteps": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["trace_step"] }, "id": { "type": "string" }, "step": { "type": "string" }, "details": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "failed"] } }, "required": ["kind", "id", "step", "status"], "additionalProperties": false } }, "startedAt": { "type": "string" } }, "required": ["id", "status", "error", "conversation"], "additionalProperties": false } },
|
|
33
|
+
"chatTurnsCreate": { "operationId": "chatTurnsCreate", "method": "POST", "path": "/v1/chats/{chatId}/turns", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "action": { "type": "string", "enum": ["send_message"] }, "clientRequestId": { "type": "string", "minLength": 1, "maxLength": 200 }, "message": { "type": "string", "minLength": 1, "maxLength": 8000 }, "contexts": { "type": "array", "items": { "type": "string" } }, "attachments": { "maxItems": 4, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fileName": { "type": "string" }, "mimeType": { "type": "string", "enum": ["image/png", "image/jpeg", "image/gif", "image/webp"] }, "s3Key": { "type": "string" } }, "required": ["id", "fileName", "mimeType", "s3Key"], "additionalProperties": false } }, "timeZone": { "type": "string" } }, "required": ["action", "clientRequestId", "message"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "nullable": true, "type": "string" }, "conversation": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" }, "timestamp": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "datasetId": { "type": "string" }, "page": { "type": "number" }, "reason": { "type": "string" }, "quote": { "type": "string" } }, "required": ["datasetId", "page"], "additionalProperties": false } }, "tableCitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "datasetId": { "type": "string" }, "page": { "type": "string" }, "tableDescription": { "type": "string" }, "sampleData": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": ["columns", "rows"], "additionalProperties": false }, "queryDetails": { "type": "object", "properties": { "connectorId": { "type": "string" }, "provider": { "type": "string" }, "sql": { "type": "string" }, "detailSql": { "type": "string" }, "sourceTables": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "retrievedAt": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["connectorId", "provider", "sql"], "additionalProperties": false } }, "required": ["id", "datasetId", "page", "tableDescription"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "appAction": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "actionId": { "type": "string" }, "name": { "type": "string" }, "input": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": ["pending", "dismissed", "completed"] } }, "required": ["requestId", "actionId", "name", "input", "status"], "additionalProperties": false } }, "additionalProperties": {} } }, "required": ["role", "content"], "additionalProperties": {} } }, "pendingTask": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "open", "in_progress", "done", "cancelled"] }, "actionType": { "type": "string" }, "actionOutputId": { "nullable": true, "type": "string" }, "draft": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instructions": { "type": "string", "minLength": 1 }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string" } }, "schedule": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, "metadata": { "type": "object", "properties": { "subtype": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "wizardState": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} }, "chatHistory": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" } }, "required": ["role", "content"], "additionalProperties": false } }, "outputSchema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name", "type"], "additionalProperties": false } } }, "required": ["name", "columns"], "additionalProperties": false } }, "isDraft": { "type": "boolean" } }, "required": ["instructions"], "additionalProperties": false } }, "required": ["id", "kind", "title", "status", "actionType", "draft"], "additionalProperties": false }, "traceSteps": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["trace_step"] }, "id": { "type": "string" }, "step": { "type": "string" }, "details": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "failed"] } }, "required": ["kind", "id", "step", "status"], "additionalProperties": false } }, "startedAt": { "type": "string" } }, "required": ["id", "status", "error", "conversation"], "additionalProperties": false } },
|
|
34
|
+
"chatsStop": { "operationId": "chatsStop", "method": "POST", "path": "/v1/chats/{chatId}/stop", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "nullable": true, "type": "string" }, "conversation": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" }, "timestamp": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "datasetId": { "type": "string" }, "page": { "type": "number" }, "reason": { "type": "string" }, "quote": { "type": "string" } }, "required": ["datasetId", "page"], "additionalProperties": false } }, "tableCitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "datasetId": { "type": "string" }, "page": { "type": "string" }, "tableDescription": { "type": "string" }, "sampleData": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": ["columns", "rows"], "additionalProperties": false }, "queryDetails": { "type": "object", "properties": { "connectorId": { "type": "string" }, "provider": { "type": "string" }, "sql": { "type": "string" }, "detailSql": { "type": "string" }, "sourceTables": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "retrievedAt": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["connectorId", "provider", "sql"], "additionalProperties": false } }, "required": ["id", "datasetId", "page", "tableDescription"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "appAction": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "actionId": { "type": "string" }, "name": { "type": "string" }, "input": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": ["pending", "dismissed", "completed"] } }, "required": ["requestId", "actionId", "name", "input", "status"], "additionalProperties": false } }, "additionalProperties": {} } }, "required": ["role", "content"], "additionalProperties": {} } }, "pendingTask": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "open", "in_progress", "done", "cancelled"] }, "actionType": { "type": "string" }, "actionOutputId": { "nullable": true, "type": "string" }, "draft": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instructions": { "type": "string", "minLength": 1 }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string" } }, "schedule": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, "metadata": { "type": "object", "properties": { "subtype": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "wizardState": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} }, "chatHistory": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" } }, "required": ["role", "content"], "additionalProperties": false } }, "outputSchema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name", "type"], "additionalProperties": false } } }, "required": ["name", "columns"], "additionalProperties": false } }, "isDraft": { "type": "boolean" } }, "required": ["instructions"], "additionalProperties": false } }, "required": ["id", "kind", "title", "status", "actionType", "draft"], "additionalProperties": false }, "traceSteps": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["trace_step"] }, "id": { "type": "string" }, "step": { "type": "string" }, "details": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "failed"] } }, "required": ["kind", "id", "step", "status"], "additionalProperties": false } }, "startedAt": { "type": "string" } }, "required": ["id", "status", "error", "conversation"], "additionalProperties": false } },
|
|
35
|
+
"chatDecisionsCreate": { "operationId": "chatDecisionsCreate", "method": "POST", "path": "/v1/chats/{chatId}/decisions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "approve": { "type": "boolean" } }, "required": ["requestId", "approve"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["running", "waiting", "completed", "failed", "cancelled"] }, "error": { "nullable": true, "type": "string" }, "conversation": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" }, "timestamp": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "datasetId": { "type": "string" }, "page": { "type": "number" }, "reason": { "type": "string" }, "quote": { "type": "string" } }, "required": ["datasetId", "page"], "additionalProperties": false } }, "tableCitations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "datasetId": { "type": "string" }, "page": { "type": "string" }, "tableDescription": { "type": "string" }, "sampleData": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": {} } } }, "required": ["columns", "rows"], "additionalProperties": false }, "queryDetails": { "type": "object", "properties": { "connectorId": { "type": "string" }, "provider": { "type": "string" }, "sql": { "type": "string" }, "detailSql": { "type": "string" }, "sourceTables": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" } }, "required": ["id", "name"], "additionalProperties": false } }, "retrievedAt": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["connectorId", "provider", "sql"], "additionalProperties": false } }, "required": ["id", "datasetId", "page", "tableDescription"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "appAction": { "type": "object", "properties": { "requestId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "actionId": { "type": "string" }, "name": { "type": "string" }, "input": { "type": "object", "additionalProperties": {} }, "status": { "type": "string", "enum": ["pending", "dismissed", "completed"] } }, "required": ["requestId", "actionId", "name", "input", "status"], "additionalProperties": false } }, "additionalProperties": {} } }, "required": ["role", "content"], "additionalProperties": {} } }, "pendingTask": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "title": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "open", "in_progress", "done", "cancelled"] }, "actionType": { "type": "string" }, "actionOutputId": { "nullable": true, "type": "string" }, "draft": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instructions": { "type": "string", "minLength": 1 }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string" } }, "schedule": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, "metadata": { "type": "object", "properties": { "subtype": { "type": "string", "enum": ["report", "dashboard", "dataFlow", "dataTable"] }, "wizardState": { "type": "object", "additionalProperties": {} } }, "additionalProperties": {} }, "chatHistory": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string", "enum": ["user", "assistant"] }, "content": { "type": "string" } }, "required": ["role", "content"], "additionalProperties": false } }, "outputSchema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name", "type"], "additionalProperties": false } } }, "required": ["name", "columns"], "additionalProperties": false } }, "isDraft": { "type": "boolean" } }, "required": ["instructions"], "additionalProperties": false } }, "required": ["id", "kind", "title", "status", "actionType", "draft"], "additionalProperties": false }, "traceSteps": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["trace_step"] }, "id": { "type": "string" }, "step": { "type": "string" }, "details": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "failed"] } }, "required": ["kind", "id", "step", "status"], "additionalProperties": false } }, "startedAt": { "type": "string" } }, "required": ["id", "status", "error", "conversation"], "additionalProperties": false } },
|
|
22
36
|
"usersMe": { "operationId": "usersMe", "method": "GET", "path": "/v1/me", "scope": "none", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "email": { "type": "string" } }, "required": ["id", "name", "email"], "additionalProperties": false } },
|
|
23
|
-
"workspacesList": { "operationId": "workspacesList", "method": "GET", "path": "/v1/workspaces", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
24
|
-
"workspacesCreate": { "operationId": "workspacesCreate", "method": "POST", "path": "/v1/workspaces", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "context": { "type": "string", "maxLength": 10000 } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
25
|
-
"workspacesGet": { "operationId": "workspacesGet", "method": "GET", "path": "/v1/workspaces/{workspaceId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
26
|
-
"workspacesUpdate": { "operationId": "workspacesUpdate", "method": "PATCH", "path": "/v1/workspaces/{workspaceId}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "context": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
37
|
+
"workspacesList": { "operationId": "workspacesList", "method": "GET", "path": "/v1/workspaces", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
38
|
+
"workspacesCreate": { "operationId": "workspacesCreate", "method": "POST", "path": "/v1/workspaces", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "context": { "type": "string", "maxLength": 10000 } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
39
|
+
"workspacesGet": { "operationId": "workspacesGet", "method": "GET", "path": "/v1/workspaces/{workspaceId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
40
|
+
"workspacesUpdate": { "operationId": "workspacesUpdate", "method": "PATCH", "path": "/v1/workspaces/{workspaceId}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "context": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "string" }, "visibility": { "type": "string", "enum": ["private", "internal", "public", "unlisted"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "organizationId", "name", "context", "visibility", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
27
41
|
"workspacesDelete": { "operationId": "workspacesDelete", "method": "DELETE", "path": "/v1/workspaces/{workspaceId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [true] } }, "required": ["id", "deleted"], "additionalProperties": false } },
|
|
28
|
-
"sourcesList": { "operationId": "sourcesList", "method": "GET", "path": "/v1/sources", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": ["dataset", "connector", "database", "report", "dashboard", "dataFlow", "dataTable"] }, "name": { "type": "string" }, "provider": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "summary": { "
|
|
29
|
-
"sourcesGet": { "operationId": "sourcesGet", "method": "GET", "path": "/v1/sources/{sourceId}", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "includeFields": { "type": "string", "enum": ["true", "false"] }, "tableId": { "type": "string", "minLength": 1 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": ["dataset", "connector", "database", "report", "dashboard", "dataFlow", "dataTable"] }, "name": { "type": "string" }, "provider": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "summary": { "
|
|
30
|
-
"dashboardsSourceGet": { "operationId": "dashboardsSourceGet", "method": "GET", "path": "/v1/dashboards/{dashboardId}/source", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "dashboardId": { "type": "string" }, "resourceId": { "type": "string" }, "source": { "type": "string" }, "revision": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false
|
|
31
|
-
"dashboardsSourceUpdate": { "operationId": "dashboardsSourceUpdate", "method": "PUT", "path": "/v1/dashboards/{dashboardId}/source", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "string", "maxLength": 200000 }, "expectedRevision": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false
|
|
32
|
-
"datasetsCreate": { "operationId": "datasetsCreate", "method": "POST", "path": "/v1/datasets", "scope": "workspace", "bodySchema": { "
|
|
33
|
-
"datasetsGetByKey": { "operationId": "datasetsGetByKey", "method": "GET", "path": "/v1/datasets", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._:-]*$" } }, "required": ["key"], "additionalProperties": false }, "responseSchema": { "
|
|
34
|
-
"datasetsGet": { "operationId": "datasetsGet", "method": "GET", "path": "/v1/datasets/{datasetId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "
|
|
42
|
+
"sourcesList": { "operationId": "sourcesList", "method": "GET", "path": "/v1/sources", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": ["dataset", "connector", "database", "report", "dashboard", "dataFlow", "dataTable"] }, "name": { "type": "string" }, "provider": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "summary": { "nullable": true, "type": "string" }, "fileType": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": ["query"] } }, "availability": { "type": "object", "properties": { "status": { "type": "string", "enum": ["ready", "refreshing", "degraded", "preparing", "failed"] }, "lastSuccessfulAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "reason": { "type": "string" } }, "required": ["status"], "additionalProperties": false } }, "required": ["id", "type", "name", "capabilities", "availability"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
43
|
+
"sourcesGet": { "operationId": "sourcesGet", "method": "GET", "path": "/v1/sources/{sourceId}", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "includeFields": { "type": "string", "enum": ["true", "false"] }, "tableId": { "type": "string", "minLength": 1 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": ["dataset", "connector", "database", "report", "dashboard", "dataFlow", "dataTable"] }, "name": { "type": "string" }, "provider": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "summary": { "nullable": true, "type": "string" }, "fileType": { "type": "string" }, "capabilities": { "type": "array", "items": { "type": "string", "enum": ["query"] } }, "availability": { "type": "object", "properties": { "status": { "type": "string", "enum": ["ready", "refreshing", "degraded", "preparing", "failed"] }, "lastSuccessfulAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "reason": { "type": "string" } }, "required": ["status"], "additionalProperties": false } }, "required": ["id", "type", "name", "capabilities", "availability"], "additionalProperties": false }, "metadata": { "type": "object", "additionalProperties": {} }, "tables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "label": { "type": "string" }, "provider": { "type": "string" }, "fieldCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" }, "nullable": { "nullable": true, "type": "boolean" }, "isPrimaryKey": { "nullable": true, "type": "boolean" } }, "required": ["name"], "additionalProperties": false } } }, "required": ["id", "name"], "additionalProperties": false } } }, "required": ["source", "tables"], "additionalProperties": false } },
|
|
44
|
+
"dashboardsSourceGet": { "operationId": "dashboardsSourceGet", "method": "GET", "path": "/v1/dashboards/{dashboardId}/source", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "dashboardId": { "type": "string" }, "resourceId": { "type": "string" }, "source": { "type": "string" }, "revision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "dataRunId": { "nullable": true, "type": "string" } }, "required": ["dashboardId", "resourceId", "source", "revision", "dataRunId"], "additionalProperties": false } },
|
|
45
|
+
"dashboardsSourceUpdate": { "operationId": "dashboardsSourceUpdate", "method": "PUT", "path": "/v1/dashboards/{dashboardId}/source", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "string", "maxLength": 200000 }, "expectedRevision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "expectedDataRunId": { "nullable": true, "type": "string" } }, "required": ["source", "expectedRevision", "expectedDataRunId"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "dashboardId": { "type": "string" }, "resourceId": { "type": "string" }, "source": { "type": "string" }, "revision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "dataRunId": { "nullable": true, "type": "string" } }, "required": ["dashboardId", "resourceId", "source", "revision", "dataRunId"], "additionalProperties": false } },
|
|
46
|
+
"datasetsCreate": { "operationId": "datasetsCreate", "method": "POST", "path": "/v1/datasets", "scope": "workspace", "bodySchema": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["custom"] }, "key": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._:-]*$" }, "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "context": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } }, "required": ["type", "key"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["file"] }, "fileName": { "type": "string", "minLength": 1, "maxLength": 1024 }, "contentType": { "type": "string", "minLength": 1, "maxLength": 1024 }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["type", "fileName", "contentType", "sizeBytes"], "additionalProperties": false }] }, "querySchema": null, "responseSchema": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["custom"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "rowCount", "columnCount"], "additionalProperties": false } }, "write": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "processing", "completed", "failed"] }, "error": { "type": "string" } }, "required": ["id", "status"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["type", "id", "sourceId", "key", "name", "context", "status", "version", "tables", "createdAt", "updatedAt"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["file"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "contentType": { "type": "string" }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "progress": { "type": "object", "properties": { "percent": { "type": "number", "minimum": 0, "maximum": 100 }, "step": { "type": "string" }, "stepLabel": { "type": "string" }, "details": { "type": "string" } }, "required": ["percent"], "additionalProperties": false }, "error": { "type": "string" }, "upload": { "type": "object", "properties": { "method": { "type": "string", "enum": ["PUT"] }, "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["method", "url", "headers", "expiresAt"], "additionalProperties": false } }, "required": ["type", "id", "sourceId", "name", "status", "contentType", "sizeBytes", "createdAt", "updatedAt"], "additionalProperties": false }] } },
|
|
47
|
+
"datasetsGetByKey": { "operationId": "datasetsGetByKey", "method": "GET", "path": "/v1/datasets", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 128, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._:-]*$" } }, "required": ["key"], "additionalProperties": false }, "responseSchema": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["custom"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "rowCount", "columnCount"], "additionalProperties": false } }, "write": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "processing", "completed", "failed"] }, "error": { "type": "string" } }, "required": ["id", "status"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["type", "id", "sourceId", "key", "name", "context", "status", "version", "tables", "createdAt", "updatedAt"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["file"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "contentType": { "type": "string" }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "progress": { "type": "object", "properties": { "percent": { "type": "number", "minimum": 0, "maximum": 100 }, "step": { "type": "string" }, "stepLabel": { "type": "string" }, "details": { "type": "string" } }, "required": ["percent"], "additionalProperties": false }, "error": { "type": "string" }, "upload": { "type": "object", "properties": { "method": { "type": "string", "enum": ["PUT"] }, "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["method", "url", "headers", "expiresAt"], "additionalProperties": false } }, "required": ["type", "id", "sourceId", "name", "status", "contentType", "sizeBytes", "createdAt", "updatedAt"], "additionalProperties": false }] } },
|
|
48
|
+
"datasetsGet": { "operationId": "datasetsGet", "method": "GET", "path": "/v1/datasets/{datasetId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["custom"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "rowCount", "columnCount"], "additionalProperties": false } }, "write": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "processing", "completed", "failed"] }, "error": { "type": "string" } }, "required": ["id", "status"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["type", "id", "sourceId", "key", "name", "context", "status", "version", "tables", "createdAt", "updatedAt"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["file"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "contentType": { "type": "string" }, "sizeBytes": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "progress": { "type": "object", "properties": { "percent": { "type": "number", "minimum": 0, "maximum": 100 }, "step": { "type": "string" }, "stepLabel": { "type": "string" }, "details": { "type": "string" } }, "required": ["percent"], "additionalProperties": false }, "error": { "type": "string" }, "upload": { "type": "object", "properties": { "method": { "type": "string", "enum": ["PUT"] }, "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["method", "url", "headers", "expiresAt"], "additionalProperties": false } }, "required": ["type", "id", "sourceId", "name", "status", "contentType", "sizeBytes", "createdAt", "updatedAt"], "additionalProperties": false }] } },
|
|
35
49
|
"datasetsDelete": { "operationId": "datasetsDelete", "method": "DELETE", "path": "/v1/datasets/{datasetId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean", "enum": [true] } }, "required": ["id", "deleted"], "additionalProperties": false } },
|
|
36
50
|
"datasetsDownload": { "operationId": "datasetsDownload", "method": "GET", "path": "/v1/datasets/{datasetId}/download", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" } }, "required": ["url"], "additionalProperties": false } },
|
|
37
|
-
"datasetsWriteTables": { "operationId": "datasetsWriteTables", "method": "POST", "path": "/v1/datasets/{datasetId}/tables", "scope": "workspace", "bodySchema": { "
|
|
38
|
-
"searchCreate": { "operationId": "searchCreate", "method": "POST", "path": "/v1/search", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1 }, "sourceIds": { "type": "array", "items": { "type": "string", "minLength": 1 }
|
|
39
|
-
"answerJobsCreate": { "operationId": "answerJobsCreate", "method": "POST", "path": "/v1/answer-jobs", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1 }, "sourceIds": { "type": "array", "items": { "type": "string", "minLength": 1 }
|
|
40
|
-
"answerJobsGet": { "operationId": "answerJobsGet", "method": "GET", "path": "/v1/answer-jobs/{answerJobId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "answerJobId": { "type": "string" }, "status": { "type": "string", "enum": ["queued", "running", "completed", "failed", "cancelled"] }, "result": { "type": "object", "properties": { "answer": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["text", "table", "web", "fact"] }, "sourceId": { "type": "string" }, "ref": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": ["type"], "additionalProperties": false } }, "assumptions": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "charts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "followUps": { "type": "array", "items": { "type": "string" } }, "confidence": { "type": "object", "properties": { "score": { "type": "number", "minimum": 0, "maximum": 100 }, "queryComplexity": { "type": "string", "enum": ["high", "medium", "low"] }, "reason": { "type": "string" } }, "required": ["score", "queryComplexity", "reason"], "additionalProperties": false } }, "required": ["answer", "citations"], "additionalProperties": false }, "error": { "type": "string" }, "pollAfterMs": { "type": "integer", "exclusiveMinimum": 0 }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "startedAt": { "type": "string", "format": "date-time", "
|
|
41
|
-
"queriesCreate": { "operationId": "queriesCreate", "method": "POST", "path": "/v1/queries", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "sourceIds": { "type": "array", "items": { "type": "string", "minLength": 1 }
|
|
42
|
-
"operationRunsList": { "operationId": "operationRunsList", "method": "GET", "path": "/v1/operation-runs", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "workflowId": { "type": "string", "minLength": 1 } }, "required": ["workflowId"], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "workflowId": { "type": "string" }, "status": { "type": "string", "enum": ["running", "completed", "failed"] }, "completedRuns": { "type": "number" }, "failedRuns": { "type": "number" }, "pendingRuns": { "type": "number" }, "totalRuns": { "type": "number" }, "progressPct": { "type": "number" }, "startedAt": { "type": "string", "format": "date-time", "
|
|
43
|
-
"operationsList": { "operationId": "operationsList", "method": "GET", "path": "/v1/operations", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["dataFlow", "dataTable", "report", "dashboard"] }, "dataFlowId": { "type": "string", "minLength": 1 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "
|
|
44
|
-
"operationsGet": { "operationId": "operationsGet", "method": "GET", "path": "/v1/operations/{operationId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "
|
|
45
|
-
"operationsUpdate": { "operationId": "operationsUpdate", "method": "PATCH", "path": "/v1/operations/{operationId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "schedule": { "anyOf": [{ "
|
|
46
|
-
"operationsSourceGet": { "operationId": "operationsSourceGet", "method": "GET", "path": "/v1/operations/{operationId}/source", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operationId": { "type": "string" }, "source": { "type": "string" }, "revision": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false
|
|
47
|
-
"operationsSourceUpdate": { "operationId": "operationsSourceUpdate", "method": "PUT", "path": "/v1/operations/{operationId}/source", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 1000000 }, "expectedRevision": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false, "
|
|
48
|
-
"operationsRunsList": { "operationId": "operationsRunsList", "method": "GET", "path": "/v1/operations/{operationId}/runs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workflowId": { "type": "string" }, "revisionId": { "
|
|
51
|
+
"datasetsWriteTables": { "operationId": "datasetsWriteTables", "method": "POST", "path": "/v1/datasets/{datasetId}/tables", "scope": "workspace", "bodySchema": { "oneOf": [{ "type": "object", "properties": { "tables": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 128 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 10000000 } }, "required": ["name", "rowCount"], "additionalProperties": false } }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 1073741824 }, "contentHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mode": { "type": "string", "enum": ["replace"] } }, "required": ["tables", "sizeBytes", "contentHash", "mode"], "additionalProperties": false }, { "type": "object", "properties": { "tableName": { "type": "string", "minLength": 1, "maxLength": 128 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 10000000 }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 1073741824 }, "contentHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mode": { "type": "string", "enum": ["replaceTable"] } }, "required": ["tableName", "rowCount", "sizeBytes", "contentHash", "mode"], "additionalProperties": false }, { "type": "object", "properties": { "tableName": { "type": "string", "minLength": 1, "maxLength": 128 }, "rowCount": { "type": "integer", "minimum": 1, "maximum": 10000 }, "batchId": { "type": "string", "minLength": 1, "maxLength": 128 }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 1073741824 }, "contentHash": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mode": { "type": "string", "enum": ["appendTable"] } }, "required": ["tableName", "rowCount", "batchId", "sizeBytes", "contentHash", "mode"], "additionalProperties": false }] }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "dataset": { "type": "object", "properties": { "type": { "type": "string", "enum": ["custom"] }, "id": { "type": "string" }, "sourceId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "context": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": ["pending", "uploaded", "processing", "completed", "failed"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "columnCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["name", "rowCount", "columnCount"], "additionalProperties": false } }, "write": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "processing", "completed", "failed"] }, "error": { "type": "string" } }, "required": ["id", "status"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["type", "id", "sourceId", "key", "name", "context", "status", "version", "tables", "createdAt", "updatedAt"], "additionalProperties": false }, "write": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "processing", "completed", "failed"] }, "error": { "type": "string" } }, "required": ["id", "status"], "additionalProperties": false }, "upload": { "type": "object", "properties": { "method": { "type": "string", "enum": ["PUT"] }, "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["method", "url", "headers", "expiresAt"], "additionalProperties": false }, "pollAfterMs": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["dataset", "write", "pollAfterMs"], "additionalProperties": false } },
|
|
52
|
+
"searchCreate": { "operationId": "searchCreate", "method": "POST", "path": "/v1/search", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "query": { "type": "string", "minLength": 1 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "types": { "type": "array", "items": { "type": "string", "enum": ["records", "documents", "tables", "text_blocks"] } }, "limit": { "type": "integer", "minimum": 1, "maximum": 50 }, "rerank": { "type": "boolean" } }, "required": ["query"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["record", "document", "table", "text_block", "unknown"] }, "sourceId": { "type": "string" }, "title": { "type": "string" }, "content": { "type": "string" }, "score": { "type": "number" }, "citation": { "type": "object", "additionalProperties": {} }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": ["type", "content"], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "strategy": { "type": "string", "enum": ["semantic"] }, "reranked": { "type": "boolean" }, "candidateCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalMs": { "type": "number", "minimum": 0 } }, "required": ["strategy", "reranked"], "additionalProperties": false } }, "required": ["items", "meta"], "additionalProperties": false } },
|
|
53
|
+
"answerJobsCreate": { "operationId": "answerJobsCreate", "method": "POST", "path": "/v1/answer-jobs", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "question": { "type": "string", "minLength": 1 }, "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["question"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "answerJobId": { "type": "string" }, "status": { "type": "string", "enum": ["queued", "running", "completed", "failed", "cancelled"] }, "result": { "type": "object", "properties": { "answer": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["text", "table", "web", "fact"] }, "sourceId": { "type": "string" }, "ref": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": ["type"], "additionalProperties": false } }, "assumptions": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "charts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "followUps": { "type": "array", "items": { "type": "string" } }, "confidence": { "type": "object", "properties": { "score": { "type": "number", "minimum": 0, "maximum": 100 }, "queryComplexity": { "type": "string", "enum": ["high", "medium", "low"] }, "reason": { "type": "string" } }, "required": ["score", "queryComplexity", "reason"], "additionalProperties": false } }, "required": ["answer", "citations"], "additionalProperties": false }, "error": { "type": "string" }, "pollAfterMs": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "startedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["answerJobId", "status"], "additionalProperties": false } },
|
|
54
|
+
"answerJobsGet": { "operationId": "answerJobsGet", "method": "GET", "path": "/v1/answer-jobs/{answerJobId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "answerJobId": { "type": "string" }, "status": { "type": "string", "enum": ["queued", "running", "completed", "failed", "cancelled"] }, "result": { "type": "object", "properties": { "answer": { "type": "string" }, "citations": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["text", "table", "web", "fact"] }, "sourceId": { "type": "string" }, "ref": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": {} } }, "required": ["type"], "additionalProperties": false } }, "assumptions": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "charts": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "followUps": { "type": "array", "items": { "type": "string" } }, "confidence": { "type": "object", "properties": { "score": { "type": "number", "minimum": 0, "maximum": 100 }, "queryComplexity": { "type": "string", "enum": ["high", "medium", "low"] }, "reason": { "type": "string" } }, "required": ["score", "queryComplexity", "reason"], "additionalProperties": false } }, "required": ["answer", "citations"], "additionalProperties": false }, "error": { "type": "string" }, "pollAfterMs": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "startedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["answerJobId", "status"], "additionalProperties": false } },
|
|
55
|
+
"queriesCreate": { "operationId": "queriesCreate", "method": "POST", "path": "/v1/queries", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "sourceIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "sql": { "type": "string", "minLength": 1 }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": ["sourceIds", "sql"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "queryId": { "type": "string" }, "sourceIds": { "type": "array", "items": { "type": "string" } }, "sql": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": ["name"], "additionalProperties": false } }, "rows": { "type": "array", "items": { "type": "object", "additionalProperties": {} } }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" }, "executionMs": { "type": "number", "minimum": 0 }, "timings": { "type": "object", "properties": { "sourceValidationMs": { "type": "number", "minimum": 0 }, "initializationMs": { "type": "number", "minimum": 0 }, "sourceLoadMs": { "type": "number", "minimum": 0 }, "sqlExecutionMs": { "type": "number", "minimum": 0 }, "totalMs": { "type": "number", "minimum": 0 } }, "required": ["sourceValidationMs", "initializationMs", "sourceLoadMs", "sqlExecutionMs", "totalMs"], "additionalProperties": false } }, "required": ["queryId", "sourceIds", "sql", "columns", "rows", "rowCount", "truncated", "executionMs"], "additionalProperties": false } },
|
|
56
|
+
"operationRunsList": { "operationId": "operationRunsList", "method": "GET", "path": "/v1/operation-runs", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "workflowId": { "type": "string", "minLength": 1 } }, "required": ["workflowId"], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "workflowId": { "type": "string" }, "status": { "type": "string", "enum": ["running", "completed", "failed"] }, "completedRuns": { "type": "number" }, "failedRuns": { "type": "number" }, "pendingRuns": { "type": "number" }, "totalRuns": { "type": "number" }, "progressPct": { "type": "number" }, "startedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workflowId": { "type": "string" }, "revisionId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "error": { "nullable": true, "type": "string" }, "outputDocId": { "nullable": true, "type": "string" }, "operationId": { "type": "string" } }, "required": ["id", "workflowId", "revisionId", "status", "createdAt", "completedAt", "error", "outputDocId", "operationId"], "additionalProperties": false } } }, "required": ["workflowId", "status", "completedRuns", "failedRuns", "pendingRuns", "totalRuns", "progressPct", "startedAt", "completedAt", "items"], "additionalProperties": false } },
|
|
57
|
+
"operationsList": { "operationId": "operationsList", "method": "GET", "path": "/v1/operations", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "kind": { "type": "string", "enum": ["dataFlow", "dataTable", "report", "dashboard"] }, "dataFlowId": { "type": "string", "minLength": 1 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "codeStale": { "type": "boolean" }, "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" }, "nextRunAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["id", "name", "kind", "instructions", "dataSourceIds", "parentDataFlowId", "status", "codeStale", "schedule", "isEnabled", "nextRunAt", "draft", "published"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
58
|
+
"operationsGet": { "operationId": "operationsGet", "method": "GET", "path": "/v1/operations/{operationId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "codeStale": { "type": "boolean" }, "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" }, "nextRunAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["id", "name", "kind", "instructions", "dataSourceIds", "parentDataFlowId", "status", "codeStale", "schedule", "isEnabled", "nextRunAt", "draft", "published"], "additionalProperties": false } },
|
|
59
|
+
"operationsUpdate": { "operationId": "operationsUpdate", "method": "PATCH", "path": "/v1/operations/{operationId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" } }, "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "codeStale": { "type": "boolean" }, "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" }, "nextRunAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["id", "name", "kind", "instructions", "dataSourceIds", "parentDataFlowId", "status", "codeStale", "schedule", "isEnabled", "nextRunAt", "draft", "published"], "additionalProperties": false } },
|
|
60
|
+
"operationsSourceGet": { "operationId": "operationsSourceGet", "method": "GET", "path": "/v1/operations/{operationId}/source", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operationId": { "type": "string" }, "source": { "type": "string" }, "revision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "dependencyOperationIds": { "type": "array", "items": { "type": "string" } }, "dataFlowRevision": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["operationId", "source", "revision", "instructions", "dataSourceIds", "dependencyOperationIds", "dataFlowRevision", "updatedAt"], "additionalProperties": false } },
|
|
61
|
+
"operationsSourceUpdate": { "operationId": "operationsSourceUpdate", "method": "PUT", "path": "/v1/operations/{operationId}/source", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "string", "minLength": 1, "maxLength": 1000000 }, "expectedRevision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "expectedDataFlowRevision": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "expectedUpdatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["source", "expectedRevision", "expectedDataFlowRevision", "expectedUpdatedAt"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operationId": { "type": "string" }, "source": { "type": "string" }, "revision": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "dependencyOperationIds": { "type": "array", "items": { "type": "string" } }, "dataFlowRevision": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["operationId", "source", "revision", "instructions", "dataSourceIds", "dependencyOperationIds", "dataFlowRevision", "updatedAt"], "additionalProperties": false } },
|
|
62
|
+
"operationsRunsList": { "operationId": "operationsRunsList", "method": "GET", "path": "/v1/operations/{operationId}/runs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "workflowId": { "type": "string" }, "revisionId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "error": { "nullable": true, "type": "string" }, "outputDocId": { "nullable": true, "type": "string" } }, "required": ["id", "workflowId", "revisionId", "status", "createdAt", "completedAt", "error", "outputDocId"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
49
63
|
"operationsRun": { "operationId": "operationsRun", "method": "POST", "path": "/v1/operations/{operationId}/runs", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "version": { "type": "string", "enum": ["draft", "published"] } }, "required": ["version"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "workflowId": { "type": "string" }, "runId": { "type": "string" } }, "required": ["workflowId"], "additionalProperties": false } },
|
|
50
|
-
"operationsRunOutput": { "operationId": "operationsRunOutput", "method": "GET", "path": "/v1/operations/{operationId}/runs/{runId}/output", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "
|
|
51
|
-
"dataFlowsCreate": { "operationId": "dataFlowsCreate", "method": "POST", "path": "/v1/data-flows", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "
|
|
52
|
-
"dataFlowsGet": { "operationId": "dataFlowsGet", "method": "GET", "path": "/v1/data-flows/{dataFlowId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "
|
|
53
|
-
"dataFlowsCommand": { "operationId": "dataFlowsCommand", "method": "POST", "path": "/v1/data-flows/{dataFlowId}/commands", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "command": { "
|
|
54
|
-
"factsList": { "operationId": "factsList", "method": "GET", "path": "/v1/facts", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "type": "string", "maxLength": 2000, "
|
|
55
|
-
"factsCreate": { "operationId": "factsCreate", "method": "POST", "path": "/v1/facts", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "type": "string", "maxLength": 2000, "
|
|
56
|
-
"factsGet": { "operationId": "factsGet", "method": "GET", "path": "/v1/facts/{factId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "type": "string", "maxLength": 2000, "
|
|
57
|
-
"factsUpdate": { "operationId": "factsUpdate", "method": "PUT", "path": "/v1/facts/{factId}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "type": "string", "maxLength": 2000, "
|
|
64
|
+
"operationsRunOutput": { "operationId": "operationsRunOutput", "method": "GET", "path": "/v1/operations/{operationId}/runs/{runId}/output", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "nullable": true, "type": "string" }, "rowLimitPerTable": { "type": "number", "enum": [1000] }, "tables": { "type": "object", "additionalProperties": { "type": "array", "items": {} } }, "names": { "type": "object", "additionalProperties": { "type": "string" } }, "schemas": { "type": "object", "additionalProperties": {} } }, "required": ["runId", "revisionId", "rowLimitPerTable", "tables", "names", "schemas"], "additionalProperties": false } },
|
|
65
|
+
"dataFlowsCreate": { "operationId": "dataFlowsCreate", "method": "POST", "path": "/v1/data-flows", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "default": "", "type": "string" }, "dataSourceIds": { "default": [], "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "codeStale": { "type": "boolean" }, "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" }, "nextRunAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["id", "name", "kind", "instructions", "dataSourceIds", "parentDataFlowId", "status", "codeStale", "schedule", "isEnabled", "nextRunAt", "draft", "published"], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "draftVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "publishedVersion": { "nullable": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "operationIds": { "type": "array", "items": { "type": "string" } }, "sourceIds": { "type": "array", "items": { "type": "string" } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fromNodeId": { "type": "string" }, "toNodeId": { "type": "string" } }, "required": ["id", "fromNodeId", "toNodeId"], "additionalProperties": false } } }, "required": ["operation", "revision", "draftVersion", "publishedVersion", "operationIds", "sourceIds", "edges"], "additionalProperties": false } },
|
|
66
|
+
"dataFlowsGet": { "operationId": "dataFlowsGet", "method": "GET", "path": "/v1/data-flows/{dataFlowId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "operation": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "instructions": { "type": "string" }, "dataSourceIds": { "type": "array", "items": { "type": "string" } }, "parentDataFlowId": { "nullable": true, "type": "string" }, "status": { "type": "string" }, "codeStale": { "type": "boolean" }, "schedule": { "anyOf": [{ "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["manual"] } }, "required": ["type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["hourly"] }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["daily"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 } }, "required": ["type", "hour", "minute"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["weekly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfWeek": { "type": "number", "minimum": 0, "maximum": 6 } }, "required": ["type", "hour", "minute", "dayOfWeek"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["monthly"] }, "hour": { "type": "number", "minimum": 0, "maximum": 23 }, "minute": { "type": "number", "minimum": 0, "maximum": 59 }, "dayOfMonth": { "type": "number", "minimum": 1, "maximum": 31 } }, "required": ["type", "hour", "minute", "dayOfMonth"], "additionalProperties": false }] }, { "type": "object", "nullable": true, "enum": [null] }] }, "isEnabled": { "type": "boolean" }, "nextRunAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["id", "name", "kind", "instructions", "dataSourceIds", "parentDataFlowId", "status", "codeStale", "schedule", "isEnabled", "nextRunAt", "draft", "published"], "additionalProperties": false }, "revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "draftVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "publishedVersion": { "nullable": true, "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "operationIds": { "type": "array", "items": { "type": "string" } }, "sourceIds": { "type": "array", "items": { "type": "string" } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "fromNodeId": { "type": "string" }, "toNodeId": { "type": "string" } }, "required": ["id", "fromNodeId", "toNodeId"], "additionalProperties": false } } }, "required": ["operation", "revision", "draftVersion", "publishedVersion", "operationIds", "sourceIds", "edges"], "additionalProperties": false } },
|
|
67
|
+
"dataFlowsCommand": { "operationId": "dataFlowsCommand", "method": "POST", "path": "/v1/data-flows/{dataFlowId}/commands", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "command": { "oneOf": [{ "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["updateFlow"] }, "patch": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" } }, "additionalProperties": false } }, "required": ["expectedRevision", "type", "patch"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["addTransform"] }, "input": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instruction": { "type": "string", "minLength": 1 }, "inputIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": ["x", "y"], "additionalProperties": false } }, "required": ["name", "instruction", "inputIds"], "additionalProperties": false } }, "required": ["expectedRevision", "type", "input"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["updateNode"] }, "nodeId": { "type": "string", "minLength": 1 }, "patch": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "instruction": { "type": "string", "minLength": 1 }, "locked": { "type": "boolean" }, "position": { "type": "object", "properties": { "x": { "type": "number" }, "y": { "type": "number" } }, "required": ["x", "y"], "additionalProperties": false } }, "additionalProperties": false } }, "required": ["expectedRevision", "type", "nodeId", "patch"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["deleteNode"] }, "nodeId": { "type": "string", "minLength": 1 } }, "required": ["expectedRevision", "type", "nodeId"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["connectNodes"] }, "fromNodeId": { "type": "string", "minLength": 1 }, "toNodeId": { "type": "string", "minLength": 1 } }, "required": ["expectedRevision", "type", "fromNodeId", "toNodeId"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["disconnectNodes"] }, "edgeId": { "type": "string", "minLength": 1 } }, "required": ["expectedRevision", "type", "edgeId"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["publish"] } }, "required": ["expectedRevision", "type"], "additionalProperties": false }, { "type": "object", "properties": { "expectedRevision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "type": { "type": "string", "enum": ["deleteFlow"] } }, "required": ["expectedRevision", "type"], "additionalProperties": false }] } }, "required": ["command"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "dataFlowId": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": ["dataFlowId", "deleted"], "additionalProperties": false } },
|
|
68
|
+
"factsList": { "operationId": "factsList", "method": "GET", "path": "/v1/facts", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["definition", "alias", "formula", "baseline"] }, "ownerId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["name", "id", "organizationId", "key", "type", "ownerId", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
69
|
+
"factsCreate": { "operationId": "factsCreate", "method": "POST", "path": "/v1/facts", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["definition", "alias", "formula", "baseline"] }, "ownerId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["name", "id", "organizationId", "key", "type", "ownerId", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
70
|
+
"factsGet": { "operationId": "factsGet", "method": "GET", "path": "/v1/facts/{factId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["definition", "alias", "formula", "baseline"] }, "ownerId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["name", "id", "organizationId", "key", "type", "ownerId", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
71
|
+
"factsUpdate": { "operationId": "factsUpdate", "method": "PUT", "path": "/v1/facts/{factId}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "definition": { "nullable": true, "type": "string", "maxLength": 2000 }, "aliases": { "nullable": true, "type": "string", "maxLength": 1000 }, "formula": { "nullable": true, "type": "string", "maxLength": 2000 }, "formulaType": { "nullable": true, "type": "string", "enum": ["math", "sql", null] }, "usualValue": { "nullable": true, "type": "number" }, "usualValueMin": { "nullable": true, "type": "number" }, "usualValueMax": { "nullable": true, "type": "number" }, "unit": { "nullable": true, "type": "string", "maxLength": 255 }, "startDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "endDate": { "nullable": true, "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "scope": { "nullable": true, "type": "string", "maxLength": 255 }, "metadata": { "nullable": true, "type": "object", "additionalProperties": {} }, "id": { "type": "string" }, "organizationId": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string", "enum": ["definition", "alias", "formula", "baseline"] }, "ownerId": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["name", "id", "organizationId", "key", "type", "ownerId", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
58
72
|
"factsDelete": { "operationId": "factsDelete", "method": "DELETE", "path": "/v1/facts/{factId}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
59
|
-
"skillsList": { "operationId": "skillsList", "method": "GET", "path": "/v1/skills", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "file": { "type": "string" }, "lastModified": { "
|
|
73
|
+
"skillsList": { "operationId": "skillsList", "method": "GET", "path": "/v1/skills", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "file": { "type": "string" }, "lastModified": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" } }, "required": ["file", "lastModified", "description"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
60
74
|
"skillsGet": { "operationId": "skillsGet", "method": "GET", "path": "/v1/skills/{path}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "content": { "type": "string" } }, "required": ["content"], "additionalProperties": false } },
|
|
61
75
|
"skillsUpdate": { "operationId": "skillsUpdate", "method": "PUT", "path": "/v1/skills/{path}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "content": { "type": "string" } }, "required": ["content"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
62
76
|
"skillsDelete": { "operationId": "skillsDelete", "method": "DELETE", "path": "/v1/skills/{path}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
63
|
-
"organizationSkillsList": { "operationId": "organizationSkillsList", "method": "GET", "path": "/v1/organization/skills", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "file": { "type": "string" }, "lastModified": { "
|
|
77
|
+
"organizationSkillsList": { "operationId": "organizationSkillsList", "method": "GET", "path": "/v1/organization/skills", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "file": { "type": "string" }, "lastModified": { "nullable": true, "type": "string" }, "description": { "nullable": true, "type": "string" } }, "required": ["file", "lastModified", "description"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
64
78
|
"organizationSkillsGet": { "operationId": "organizationSkillsGet", "method": "GET", "path": "/v1/organization/skills/{path}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "content": { "type": "string" } }, "required": ["content"], "additionalProperties": false } },
|
|
65
79
|
"organizationSkillsUpdate": { "operationId": "organizationSkillsUpdate", "method": "PUT", "path": "/v1/organization/skills/{path}", "scope": "organization", "bodySchema": { "type": "object", "properties": { "content": { "type": "string" } }, "required": ["content"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
66
80
|
"organizationSkillsDelete": { "operationId": "organizationSkillsDelete", "method": "DELETE", "path": "/v1/organization/skills/{path}", "scope": "organization", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": ["success", "message"], "additionalProperties": false } },
|
|
@@ -68,40 +82,44 @@ export const publicApiRoutes = {
|
|
|
68
82
|
"databasesCreate": { "operationId": "databasesCreate", "method": "POST", "path": "/v1/databases", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "key": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,128}$" } }, "required": ["name", "key"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "status": { "type": "string", "enum": ["provisioning", "ready", "deleting", "failed", "deleted"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "key", "status", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
69
83
|
"databasesGet": { "operationId": "databasesGet", "method": "GET", "path": "/v1/databases/{databaseId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "status": { "type": "string", "enum": ["provisioning", "ready", "deleting", "failed", "deleted"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "key", "status", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
70
84
|
"databasesDelete": { "operationId": "databasesDelete", "method": "DELETE", "path": "/v1/databases/{databaseId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "key": { "type": "string" }, "status": { "type": "string", "enum": ["provisioning", "ready", "deleting", "failed", "deleted"] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "key", "status", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
71
|
-
"databaseDefinitionGet": { "operationId": "databaseDefinitionGet", "method": "GET", "path": "/v1/databases/{databaseId}/definition", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "tables": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "
|
|
72
|
-
"databaseDefinitionSave": { "operationId": "databaseDefinitionSave", "method": "PUT", "path": "/v1/databases/{databaseId}/definition", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedDraft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0 } }, "required": ["revisionId", "sequence"], "additionalProperties": false
|
|
85
|
+
"databaseDefinitionGet": { "operationId": "databaseDefinitionGet", "method": "GET", "path": "/v1/databases/{databaseId}/definition", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "draft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "tables": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "default": false, "type": "boolean" } }, "required": ["name", "type"], "additionalProperties": false } }, "primaryKey": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["name", "columns", "primaryKey"], "additionalProperties": false } } }, "required": ["tables"], "additionalProperties": false } }, "required": ["revisionId", "sequence", "definition"], "additionalProperties": false }, "published": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "number" }, "definition": { "type": "object", "properties": { "tables": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "default": false, "type": "boolean" } }, "required": ["name", "type"], "additionalProperties": false } }, "primaryKey": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["name", "columns", "primaryKey"], "additionalProperties": false } } }, "required": ["tables"], "additionalProperties": false } }, "required": ["revisionId", "sequence", "definition"], "additionalProperties": false } }, "required": ["draft", "published"], "additionalProperties": false } },
|
|
86
|
+
"databaseDefinitionSave": { "operationId": "databaseDefinitionSave", "method": "PUT", "path": "/v1/databases/{databaseId}/definition", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "expectedDraft": { "nullable": true, "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "definition": { "type": "object", "properties": { "tables": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "default": false, "type": "boolean" } }, "required": ["name", "type"], "additionalProperties": false } }, "primaryKey": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["name", "columns", "primaryKey"], "additionalProperties": false } } }, "required": ["tables"], "additionalProperties": false } }, "required": ["expectedDraft", "definition"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "revisionId": { "type": "string" } }, "required": ["revisionId"], "additionalProperties": false } },
|
|
73
87
|
"databaseTablesList": { "operationId": "databaseTablesList", "method": "GET", "path": "/v1/databases/{databaseId}/tables", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "schema": { "type": "string" }, "name": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "nullable": { "type": "boolean" } }, "required": ["name", "type", "nullable"], "additionalProperties": false } }, "primaryKey": { "type": "array", "items": { "type": "string" } } }, "required": ["schema", "name", "columns", "primaryKey"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
74
|
-
"databaseTablesCreate": { "operationId": "databaseTablesCreate", "method": "POST", "path": "/v1/databases/{databaseId}/tables", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "
|
|
75
|
-
"databaseRecordsList": { "operationId": "databaseRecordsList", "method": "GET", "path": "/v1/databases/{databaseId}/tables/{table}/records", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "schema": { "type": "string", "minLength": 1, "maxLength": 63 }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000, "
|
|
76
|
-
"databaseTransactionsCreate": { "operationId": "databaseTransactionsCreate", "method": "POST", "path": "/v1/databases/{databaseId}/transactions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,128}$" }, "mutations": { "type": "array", "items": { "
|
|
88
|
+
"databaseTablesCreate": { "operationId": "databaseTablesCreate", "method": "POST", "path": "/v1/databases/{databaseId}/tables", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "columns": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "type": { "type": "string", "enum": ["text", "boolean", "bigint", "numeric", "uuid", "date", "timestamptz", "jsonb"] }, "nullable": { "default": false, "type": "boolean" } }, "required": ["name", "type"], "additionalProperties": false } }, "primaryKey": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" } } }, "required": ["name", "columns", "primaryKey"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "name": { "type": "string" }, "revisionId": { "type": "string" } }, "required": ["name", "revisionId"], "additionalProperties": false } },
|
|
89
|
+
"databaseRecordsList": { "operationId": "databaseRecordsList", "method": "GET", "path": "/v1/databases/{databaseId}/tables/{table}/records", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "schema": { "type": "string", "minLength": 1, "maxLength": 63 }, "limit": { "default": 100, "type": "integer", "minimum": 1, "maximum": 1000 }, "offset": { "default": 0, "type": "integer", "minimum": 0, "maximum": 100000 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": ["items"], "additionalProperties": false } },
|
|
90
|
+
"databaseTransactionsCreate": { "operationId": "databaseTransactionsCreate", "method": "POST", "path": "/v1/databases/{databaseId}/transactions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "requestId": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,128}$" }, "mutations": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["insert"] }, "table": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "values": { "type": "object", "additionalProperties": {} } }, "required": ["type", "table", "values"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["update"] }, "table": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "key": { "type": "object", "additionalProperties": {} }, "expectedVersion": { "anyOf": [{ "type": "string", "pattern": "^rver_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] }, "values": { "type": "object", "additionalProperties": {} } }, "required": ["type", "table", "key", "expectedVersion", "values"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["delete"] }, "table": { "type": "string", "pattern": "^[a-z][a-z0-9_]{0,62}$" }, "key": { "type": "object", "additionalProperties": {} }, "expectedVersion": { "anyOf": [{ "type": "string", "pattern": "^rver_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] } }, "required": ["type", "table", "key", "expectedVersion"], "additionalProperties": false }] } } }, "required": ["requestId", "mutations"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "requestId": { "type": "string" }, "versions": { "type": "array", "items": { "anyOf": [{ "type": "string", "pattern": "^rver_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] } } }, "required": ["requestId", "versions"], "additionalProperties": false } },
|
|
91
|
+
"appsPublicationRequestsCreate": { "operationId": "appsPublicationRequestsCreate", "method": "POST", "path": "/v1/apps/{applicationId}/publication-requests", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "revisionId": { "type": "string", "pattern": "^rvsn_[a-z0-9]{24}$" }, "expectedVersion": { "type": "string", "minLength": 1, "maxLength": 128 }, "reason": { "type": "string", "maxLength": 1000 } }, "required": ["revisionId", "expectedVersion"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "applicationId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "applicationId"], "additionalProperties": false } },
|
|
92
|
+
"appsPublicationRequestsList": { "operationId": "appsPublicationRequestsList", "method": "GET", "path": "/v1/apps/{applicationId}/publication-requests", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "applicationId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "applicationId"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
93
|
+
"appsPublicationRequestsDecide": { "operationId": "appsPublicationRequestsDecide", "method": "POST", "path": "/v1/apps/{applicationId}/publication-requests/{requestId}/decisions", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "decision": { "type": "string", "enum": ["approved", "rejected", "cancelled"] } }, "required": ["decision"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "revisionId": { "type": "string" }, "expectedVersion": { "type": "string" }, "principalType": { "type": "string", "enum": ["user", "apiKey"] }, "principalId": { "type": "string" }, "reason": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "published", "rejected", "cancelled", "expired", "stale"] }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "expiresAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "canPublish": { "type": "boolean" }, "canCancel": { "type": "boolean" }, "applicationId": { "type": "string" } }, "required": ["id", "revisionId", "expectedVersion", "principalType", "principalId", "reason", "status", "createdAt", "expiresAt", "canPublish", "canCancel", "applicationId"], "additionalProperties": false } },
|
|
77
94
|
"appsSourceFileGet": { "operationId": "appsSourceFileGet", "method": "GET", "path": "/v1/apps/{applicationId}/source-file", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" } }, "required": ["revisionId", "path"], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "data": { "type": "string" } }, "required": ["data"], "additionalProperties": false } },
|
|
78
|
-
"appsAddressGet": { "operationId": "appsAddressGet", "method": "GET", "path": "/v1/apps/{applicationId}/address", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "address": { "type": "object", "properties": { "namespaceId": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "label": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "url": { "type": "string", "format": "uri" } }, "required": ["namespaceId", "label", "url"], "additionalProperties": false
|
|
79
|
-
"appsAddressSet": { "operationId": "appsAddressSet", "method": "PUT", "path": "/v1/apps/{applicationId}/address", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "address": { "type": "object", "properties": { "namespaceId": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "label": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" } }, "required": ["namespaceId", "label"], "additionalProperties": false, "
|
|
80
|
-
"appsAccessGet": { "operationId": "appsAccessGet", "method": "GET", "path": "/v1/apps/{applicationId}/access", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["permute", "password"] }, "version": { "type": "integer", "minimum": 0 }, "canManage": { "type": "boolean" } }, "required": ["mode", "version", "canManage"], "additionalProperties": false } },
|
|
81
|
-
"appsAccessSet": { "operationId": "appsAccessSet", "method": "PUT", "path": "/v1/apps/{applicationId}/access", "scope": "workspace", "bodySchema": { "
|
|
82
|
-
"appsGrantsList": { "operationId": "appsGrantsList", "method": "GET", "path": "/v1/apps/{applicationId}/grants", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 128 }, "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "subResourceId": { "
|
|
83
|
-
"appsGrantsSet": { "operationId": "appsGrantsSet", "method": "PUT", "path": "/v1/apps/{applicationId}/grants/{resourceId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "type": "string", "enum": ["read", "write", "admin", null]
|
|
84
|
-
"appsList": { "operationId": "appsList", "method": "GET", "path": "/v1/apps", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false, "
|
|
85
|
-
"appsCreate": { "operationId": "appsCreate", "method": "POST", "path": "/v1/apps", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "key": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "
|
|
86
|
-
"appsGet": { "operationId": "appsGet", "method": "GET", "path": "/v1/apps/{applicationId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false, "
|
|
87
|
-
"appsUpdate": { "operationId": "appsUpdate", "method": "PATCH", "path": "/v1/apps/{applicationId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "maxLength": 2000 }, "login": { "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false, "
|
|
95
|
+
"appsAddressGet": { "operationId": "appsAddressGet", "method": "GET", "path": "/v1/apps/{applicationId}/address", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "address": { "nullable": true, "type": "object", "properties": { "namespaceId": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "label": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "url": { "type": "string", "format": "uri" } }, "required": ["namespaceId", "label", "url"], "additionalProperties": false }, "canManage": { "type": "boolean" }, "namespaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "hostname": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "live", "failed", "deleting", "deleted"] } }, "required": ["id", "hostname", "status"], "additionalProperties": false } } }, "required": ["address", "canManage", "namespaces"], "additionalProperties": false } },
|
|
96
|
+
"appsAddressSet": { "operationId": "appsAddressSet", "method": "PUT", "path": "/v1/apps/{applicationId}/address", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "address": { "nullable": true, "type": "object", "properties": { "namespaceId": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "label": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" } }, "required": ["namespaceId", "label"], "additionalProperties": false }, "expectedUrl": { "nullable": true, "type": "string", "format": "uri" } }, "required": ["address", "expectedUrl"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "address": { "nullable": true, "type": "object", "properties": { "namespaceId": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "label": { "type": "string", "pattern": "^[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$" }, "url": { "type": "string", "format": "uri" } }, "required": ["namespaceId", "label", "url"], "additionalProperties": false }, "canManage": { "type": "boolean" }, "namespaces": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^domn_[a-z0-9]{24}$" }, "hostname": { "type": "string" }, "status": { "type": "string", "enum": ["pending", "live", "failed", "deleting", "deleted"] } }, "required": ["id", "hostname", "status"], "additionalProperties": false } } }, "required": ["address", "canManage", "namespaces"], "additionalProperties": false } },
|
|
97
|
+
"appsAccessGet": { "operationId": "appsAccessGet", "method": "GET", "path": "/v1/apps/{applicationId}/access", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["permute", "password"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canManage": { "type": "boolean" } }, "required": ["mode", "version", "canManage"], "additionalProperties": false } },
|
|
98
|
+
"appsAccessSet": { "operationId": "appsAccessSet", "method": "PUT", "path": "/v1/apps/{applicationId}/access", "scope": "workspace", "bodySchema": { "oneOf": [{ "type": "object", "properties": { "mode": { "type": "string", "enum": ["permute"] }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["mode", "expectedVersion"], "additionalProperties": false }, { "type": "object", "properties": { "mode": { "type": "string", "enum": ["password"] }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "password": { "type": "string", "minLength": 8, "maxLength": 256 } }, "required": ["mode", "expectedVersion", "password"], "additionalProperties": false }] }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "mode": { "type": "string", "enum": ["permute", "password"] }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "canManage": { "type": "boolean" } }, "required": ["mode", "version", "canManage"], "additionalProperties": false } },
|
|
99
|
+
"appsGrantsList": { "operationId": "appsGrantsList", "method": "GET", "path": "/v1/apps/{applicationId}/grants", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 128 }, "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "subResourceId": { "description": "New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API.", "type": "string", "minLength": 1, "maxLength": 128 }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "level"], "additionalProperties": false } }, "canManage": { "type": "boolean" } }, "required": ["items", "canManage"], "additionalProperties": false } },
|
|
100
|
+
"appsGrantsSet": { "operationId": "appsGrantsSet", "method": "PUT", "path": "/v1/apps/{applicationId}/grants/{resourceId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "nullable": true, "type": "string", "enum": ["read", "write", "admin", null] }, "subResourceId": { "description": "New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API.", "type": "string", "minLength": 1, "maxLength": 128 }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["level"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 128 }, "resourceType": { "type": "string", "minLength": 1, "maxLength": 128 }, "level": { "type": "string", "enum": ["read", "write", "admin"] }, "subResourceId": { "description": "New grants support whole resources and resource-type wildcards, with optional expiry. Table, row, and column scopes within a shared source are not supported by current source query APIs, including databases, datasets, connectors, and operation outputs. For narrower reads, share separately filtered Data Table or Data Flow outputs while keeping broader sources restricted, or use an approved caller-filtered Business Action. Existing scoped app grants can be revoked with level: null and their original subResourceId; other scoped grants use the permission deletion API.", "type": "string", "minLength": 1, "maxLength": 128 }, "expiresAt": { "nullable": true, "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["resourceId", "level"], "additionalProperties": false } }, "canManage": { "type": "boolean" } }, "required": ["items", "canManage"], "additionalProperties": false } },
|
|
101
|
+
"appsList": { "operationId": "appsList", "method": "GET", "path": "/v1/apps", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "deployment": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": ["deploying", "live", "deleting", "failed", "deleted"] }, "url": { "type": "string", "format": "uri" }, "revisionId": { "type": "string" }, "error": { "nullable": true, "type": "string" } }, "required": ["status", "url", "revisionId", "error"], "additionalProperties": false }, "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "description", "deployment", "draft", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
102
|
+
"appsCreate": { "operationId": "appsCreate", "method": "POST", "path": "/v1/apps", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "key": { "type": "string", "minLength": 1, "maxLength": 128 }, "description": { "default": "", "type": "string", "maxLength": 2000 } }, "required": ["name"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "deployment": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": ["deploying", "live", "deleting", "failed", "deleted"] }, "url": { "type": "string", "format": "uri" }, "revisionId": { "type": "string" }, "error": { "nullable": true, "type": "string" } }, "required": ["status", "url", "revisionId", "error"], "additionalProperties": false }, "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "description", "deployment", "draft", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
103
|
+
"appsGet": { "operationId": "appsGet", "method": "GET", "path": "/v1/apps/{applicationId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "deployment": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": ["deploying", "live", "deleting", "failed", "deleted"] }, "url": { "type": "string", "format": "uri" }, "revisionId": { "type": "string" }, "error": { "nullable": true, "type": "string" } }, "required": ["status", "url", "revisionId", "error"], "additionalProperties": false }, "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "description", "deployment", "draft", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
104
|
+
"appsUpdate": { "operationId": "appsUpdate", "method": "PATCH", "path": "/v1/apps/{applicationId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "type": "string", "maxLength": 2000 }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "expectedDraft": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["expectedDraft"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "deployment": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": ["deploying", "live", "deleting", "failed", "deleted"] }, "url": { "type": "string", "format": "uri" }, "revisionId": { "type": "string" }, "error": { "nullable": true, "type": "string" } }, "required": ["status", "url", "revisionId", "error"], "additionalProperties": false }, "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "description", "deployment", "draft", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
88
105
|
"appsDelete": { "operationId": "appsDelete", "method": "DELETE", "path": "/v1/apps/{applicationId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": ["id", "deleted"], "additionalProperties": false } },
|
|
89
|
-
"appsUploadsCreate": { "operationId": "appsUploadsCreate", "method": "POST", "path": "/v1/apps/{applicationId}/uploads", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "minimum": 0, "maximum": 4194304 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }
|
|
90
|
-
"appsSiteUpdate": { "operationId": "appsSiteUpdate", "method": "PUT", "path": "/v1/apps/{applicationId}/site", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "files": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "minimum": 0, "maximum": 4194304 }, "executable": { "type": "boolean" } }, "required": ["path", "sha256", "size"], "additionalProperties": false }
|
|
91
|
-
"writeSyncsList": { "operationId": "writeSyncsList", "method": "GET", "path": "/v1/write-syncs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "
|
|
92
|
-
"writeSyncsCreate": { "operationId": "writeSyncsCreate", "method": "POST", "path": "/v1/write-syncs", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "
|
|
106
|
+
"appsUploadsCreate": { "operationId": "appsUploadsCreate", "method": "POST", "path": "/v1/apps/{applicationId}/uploads", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "files": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "minimum": 0, "maximum": 4194304 } }, "required": ["path", "sha256", "size"], "additionalProperties": false } } }, "required": ["files"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "uploads": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } } }, "required": ["path", "url", "headers"], "additionalProperties": false } } }, "required": ["uploads"], "additionalProperties": false } },
|
|
107
|
+
"appsSiteUpdate": { "operationId": "appsSiteUpdate", "method": "PUT", "path": "/v1/apps/{applicationId}/site", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "files": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "minimum": 0, "maximum": 4194304 }, "executable": { "type": "boolean" } }, "required": ["path", "sha256", "size"], "additionalProperties": false } }, "build": { "type": "object", "properties": { "command": { "type": "string", "minLength": 1, "maxLength": 1000 }, "outputDirectory": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?=[\\x20-\\x7e\\x80-\\uffff]+$)[^\\\\/:<>\"|?*]+(?:\\/[^\\\\/:<>\"|?*]+)*$" }, "runtime": { "type": "string", "pattern": "^(?:bun|node)@\\d+\\.\\d+\\.\\d+$" } }, "required": ["command", "outputDirectory", "runtime"], "additionalProperties": false } }, "required": ["files", "build"], "additionalProperties": false }, "site": { "type": "object", "properties": { "files": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "minimum": 0, "maximum": 4194304 } }, "required": ["path", "sha256", "size"], "additionalProperties": false } }, "spa": { "type": "boolean" } }, "required": ["files", "spa"], "additionalProperties": false }, "actions": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "actionId": { "type": "string", "pattern": "^actn_[a-z0-9]{24}$" }, "revisionId": { "type": "string", "minLength": 1 } }, "required": ["actionId", "revisionId"], "additionalProperties": false } }, "expectedDraft": { "type": "object", "properties": { "revisionId": { "type": "string", "minLength": 1 }, "sequence": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false } }, "required": ["source", "expectedDraft"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^appl_[a-z0-9]{24}$" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "login": { "nullable": true, "type": "object", "properties": { "sidePanelImage": { "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 2097152 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "header": { "type": "string", "maxLength": 160 }, "subheader": { "type": "string", "maxLength": 300 }, "title": { "type": "string", "maxLength": 100 }, "subtitle": { "type": "string", "maxLength": 100 }, "primaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" }, "secondaryColor": { "type": "string", "pattern": "^#[a-fA-F0-9]{6}$" } }, "additionalProperties": false }, "favicon": { "nullable": true, "type": "object", "properties": { "path": { "type": "string", "minLength": 1, "maxLength": 240, "pattern": "^(?!__)(?!v1(?:\\/|$))(?!.*(?:^|\\/)\\.{1,2}(?:\\/|$))[a-zA-Z0-9_-][a-zA-Z0-9_./-]*$" }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "size": { "type": "integer", "exclusiveMinimum": 0, "maximum": 262144 } }, "required": ["path", "sha256", "size"], "additionalProperties": false }, "chat": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "additionalProperties": false }, "deployment": { "nullable": true, "type": "object", "properties": { "status": { "type": "string", "enum": ["deploying", "live", "deleting", "failed", "deleted"] }, "url": { "type": "string", "format": "uri" }, "revisionId": { "type": "string" }, "error": { "nullable": true, "type": "string" } }, "required": ["status", "url", "revisionId", "error"], "additionalProperties": false }, "draft": { "type": "object", "properties": { "revisionId": { "type": "string" }, "sequence": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["revisionId", "sequence"], "additionalProperties": false }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": ["id", "workspaceId", "name", "description", "deployment", "draft", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
108
|
+
"writeSyncsList": { "operationId": "writeSyncsList", "method": "GET", "path": "/v1/write-syncs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "nullable": true, "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "name", "definition", "version", "isEnabled", "createdAt", "updatedAt"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
109
|
+
"writeSyncsCreate": { "operationId": "writeSyncsCreate", "method": "POST", "path": "/v1/write-syncs", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false } }, "required": ["definition"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "nullable": true, "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "name", "definition", "version", "isEnabled", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
93
110
|
"writeSyncsDestinations": { "operationId": "writeSyncsDestinations", "method": "GET", "path": "/v1/write-syncs/destinations", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "objects": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string" }, "scope": { "type": "string" }, "label": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": ["string", "array"] } }, "required": ["name", "label", "type"], "additionalProperties": false } } }, "required": ["object", "scope", "label", "fields"], "additionalProperties": false } } }, "required": ["id", "name", "provider", "objects"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
94
|
-
"writeSyncsGet": { "operationId": "writeSyncsGet", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "
|
|
95
|
-
"writeSyncsUpdate": { "operationId": "writeSyncsUpdate", "method": "PUT", "path": "/v1/write-syncs/{writeSyncId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "
|
|
111
|
+
"writeSyncsGet": { "operationId": "writeSyncsGet", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "nullable": true, "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "automaticEnabled": { "type": "boolean" }, "identityLocked": { "type": "boolean" } }, "required": ["id", "name", "definition", "version", "isEnabled", "createdAt", "updatedAt", "automaticEnabled", "identityLocked"], "additionalProperties": false } },
|
|
112
|
+
"writeSyncsUpdate": { "operationId": "writeSyncsUpdate", "method": "PUT", "path": "/v1/write-syncs/{writeSyncId}", "scope": "workspace", "bodySchema": { "type": "object", "properties": { "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "expectedVersion": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["definition", "expectedVersion"], "additionalProperties": false }, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "nullable": true, "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "name", "definition", "version", "isEnabled", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
96
113
|
"writeSyncsDelete": { "operationId": "writeSyncsDelete", "method": "DELETE", "path": "/v1/write-syncs/{writeSyncId}", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": ["deleted"], "additionalProperties": false } },
|
|
97
|
-
"writeSyncsPreview": { "operationId": "writeSyncsPreview", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/preview", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "writeSyncId": { "type": "string" }, "definitionVersion": { "type": "integer", "exclusiveMinimum": 0 }, "definitionRevisionId": { "type": "string" }, "sourceOperation": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "type": "string" } }, "required": ["runId", "revisionId"], "additionalProperties": false }, "recordCount": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 0 }, "pageCount": { "type": "integer", "minimum": 0 }, "records": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "values": { "type": "object", "additionalProperties": {} }, "action": { "type": "string", "enum": ["create", "unchanged", "blocked"] }, "status": { "type": "string", "enum": ["pending", "sending", "applied", "rejected", "unknown", "skipped"] }, "reason": { "type": "string" }, "destinationId": { "type": "string" } }, "required": ["key", "values"], "additionalProperties": false } } }, "required": ["id", "previewComplete", "writeSyncId", "definitionVersion", "recordCount", "page", "pageCount", "records"], "additionalProperties": false } },
|
|
98
|
-
"writeSyncsPause": { "operationId": "writeSyncsPause", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/pause", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "
|
|
99
|
-
"writeSyncsListRuns": { "operationId": "writeSyncsListRuns", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}/runs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" }, "recordCount": { "type": "integer", "minimum": 0 } }, "required": ["id", "previewComplete", "createdAt", "recordCount"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
100
|
-
"writeSyncsGetRun": { "operationId": "writeSyncsGetRun", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}/runs/{runId}", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": "string", "format": "date-time" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "writeSyncId": { "type": "string" }, "definitionVersion": { "type": "integer", "exclusiveMinimum": 0 }, "definitionRevisionId": { "type": "string" }, "sourceOperation": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "type": "string" } }, "required": ["runId", "revisionId"], "additionalProperties": false }, "recordCount": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 0 }, "pageCount": { "type": "integer", "minimum": 0 }, "records": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "values": { "type": "object", "additionalProperties": {} }, "action": { "type": "string", "enum": ["create", "unchanged", "blocked"] }, "status": { "type": "string", "enum": ["pending", "sending", "applied", "rejected", "unknown", "skipped"] }, "reason": { "type": "string" }, "destinationId": { "type": "string" } }, "required": ["key", "values"], "additionalProperties": false } } }, "required": ["id", "previewComplete", "writeSyncId", "definitionVersion", "recordCount", "page", "pageCount", "records"], "additionalProperties": false } },
|
|
101
|
-
"writeSyncsExecute": { "operationId": "writeSyncsExecute", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/runs/{runId}/execute", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "runId": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid" }] }, "queued": { "type": "boolean" } }, "required": ["runId", "queued"], "additionalProperties": false } },
|
|
114
|
+
"writeSyncsPreview": { "operationId": "writeSyncsPreview", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/preview", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "writeSyncId": { "type": "string" }, "definitionVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "definitionRevisionId": { "type": "string" }, "sourceOperation": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "type": "string" } }, "required": ["runId", "revisionId"], "additionalProperties": false }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "values": { "type": "object", "additionalProperties": {} }, "action": { "type": "string", "enum": ["create", "unchanged", "blocked"] }, "status": { "type": "string", "enum": ["pending", "sending", "applied", "rejected", "unknown", "skipped"] }, "reason": { "type": "string" }, "destinationId": { "type": "string" } }, "required": ["key", "values"], "additionalProperties": false } } }, "required": ["id", "previewComplete", "writeSyncId", "definitionVersion", "recordCount", "page", "pageCount", "records"], "additionalProperties": false } },
|
|
115
|
+
"writeSyncsPause": { "operationId": "writeSyncsPause", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/pause", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "definition": { "nullable": true, "type": "object", "properties": { "source": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "destination": { "type": "object", "properties": { "resourceId": { "type": "string", "minLength": 1, "maxLength": 512 }, "object": { "type": "string", "minLength": 1, "maxLength": 512 }, "scope": { "type": "string" } }, "required": ["resourceId", "object", "scope"], "additionalProperties": false }, "input": { "oneOf": [{ "type": "object", "properties": { "type": { "type": "string", "enum": ["source"] }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "table"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": ["operation"] }, "operationId": { "type": "string", "minLength": 1, "maxLength": 512 }, "revisionId": { "type": "string", "minLength": 1, "maxLength": 512 }, "table": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["type", "operationId", "revisionId", "table"], "additionalProperties": false }] }, "keyColumn": { "type": "string", "minLength": 1, "maxLength": 512 }, "fields": { "type": "object", "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 512 } } }, "required": ["source", "destination", "input", "keyColumn", "fields"], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "updatedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["id", "name", "definition", "version", "isEnabled", "createdAt", "updatedAt"], "additionalProperties": false } },
|
|
116
|
+
"writeSyncsListRuns": { "operationId": "writeSyncsListRuns", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}/runs", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": ["id", "previewComplete", "createdAt", "recordCount"], "additionalProperties": false } } }, "required": ["items"], "additionalProperties": false } },
|
|
117
|
+
"writeSyncsGetRun": { "operationId": "writeSyncsGetRun", "method": "GET", "path": "/v1/write-syncs/{writeSyncId}/runs/{runId}", "scope": "workspace", "bodySchema": null, "querySchema": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [], "additionalProperties": false }, "responseSchema": { "type": "object", "properties": { "id": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] }, "previewComplete": { "type": "boolean" }, "previewError": { "type": "string" }, "automatic": { "type": "object", "properties": { "approvedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" } }, "required": ["approvedAt"], "additionalProperties": false }, "execution": { "type": "object", "properties": { "requestedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "completedAt": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$" }, "error": { "type": "string" } }, "required": ["requestedAt"], "additionalProperties": false }, "writeSyncId": { "type": "string" }, "definitionVersion": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "definitionRevisionId": { "type": "string" }, "sourceOperation": { "type": "object", "properties": { "runId": { "type": "string" }, "revisionId": { "type": "string" } }, "required": ["runId", "revisionId"], "additionalProperties": false }, "recordCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "page": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pageCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "records": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "values": { "type": "object", "additionalProperties": {} }, "action": { "type": "string", "enum": ["create", "unchanged", "blocked"] }, "status": { "type": "string", "enum": ["pending", "sending", "applied", "rejected", "unknown", "skipped"] }, "reason": { "type": "string" }, "destinationId": { "type": "string" } }, "required": ["key", "values"], "additionalProperties": false } } }, "required": ["id", "previewComplete", "writeSyncId", "definitionVersion", "recordCount", "page", "pageCount", "records"], "additionalProperties": false } },
|
|
118
|
+
"writeSyncsExecute": { "operationId": "writeSyncsExecute", "method": "POST", "path": "/v1/write-syncs/{writeSyncId}/runs/{runId}/execute", "scope": "workspace", "bodySchema": null, "querySchema": null, "responseSchema": { "type": "object", "properties": { "runId": { "anyOf": [{ "type": "string", "pattern": "^wsrn_[a-z0-9]{24}$" }, { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }] }, "queued": { "type": "boolean" } }, "required": ["runId", "queued"], "additionalProperties": false } },
|
|
102
119
|
};
|
|
103
120
|
export const Providers = {
|
|
104
121
|
ACUMATICA: 'acumatica',
|
|
122
|
+
AMAZON_ADS: 'amazon_ads',
|
|
105
123
|
AMAZON_SELLER_CENTRAL: 'amazon_seller_central',
|
|
106
124
|
ATTIO: 'attio',
|
|
107
125
|
AUTODESK: 'autodesk',
|
|
@@ -110,15 +128,18 @@ export const Providers = {
|
|
|
110
128
|
BREX: 'brex',
|
|
111
129
|
DOUBLE: 'double',
|
|
112
130
|
FIREFLIES: 'fireflies',
|
|
131
|
+
GMAIL: 'gmail',
|
|
113
132
|
GOOGLEADS: 'googleads',
|
|
114
133
|
GRANOLA: 'granola',
|
|
115
134
|
HUBSPOT: 'hubspot',
|
|
135
|
+
INSTANTLY: 'instantly',
|
|
116
136
|
KLAVIYO: 'klaviyo',
|
|
117
137
|
MERCURY: 'mercury',
|
|
118
138
|
META_ADS: 'meta_ads',
|
|
119
139
|
MICROSOFT_ADVERTISING: 'microsoft_advertising',
|
|
120
140
|
MONDAY: 'monday',
|
|
121
141
|
PROCORE: 'procore',
|
|
142
|
+
PYLON: 'pylon',
|
|
122
143
|
QUICKBOOKS: 'quickbooks',
|
|
123
144
|
QUO: 'quo',
|
|
124
145
|
S3: 's3',
|
|
@@ -127,5 +148,7 @@ export const Providers = {
|
|
|
127
148
|
STRIPE: 'stripe',
|
|
128
149
|
SUPABASE: 'supabase',
|
|
129
150
|
TIKTOK_ADS: 'tiktok_ads',
|
|
151
|
+
TIKTOK_SHOP: 'tiktok_shop',
|
|
130
152
|
XERO: 'xero',
|
|
153
|
+
YARDI: 'yardi',
|
|
131
154
|
};
|