{ "openapi": "3.1.0", "info": { "title": "Adminium REST API", "version": "v1", "description": "The `/api/v1` surface of a self-hosted Adminium instance. Generated from the live route tree and its zod schemas — see apps/server/scripts/openapi.mjs.", "license": { "name": "AGPL-3.0-only", "url": "https://www.gnu.org/licenses/agpl-3.0.html" } }, "components": { "securitySchemes": { "sessionCookie": { "type": "apiKey", "in": "cookie", "name": "adminium_session", "description": "Browser session cookie, set by `POST /auth/login`. HttpOnly." }, "apiKey": { "type": "http", "scheme": "bearer", "description": "Workspace API key: `Authorization: Bearer adm_sk_…` (§2.16)." } }, "schemas": {} }, "paths": { "/api/v1/healthz": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "string" }, "uptime": { "type": "number", "minimum": 0 } }, "required": [ "ok", "version", "uptime" ], "additionalProperties": false } } } } } } }, "/api/v1/readyz": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "version": { "type": "string" }, "checks": { "type": "object", "properties": { "meta": { "type": "string", "enum": [ "ok", "unreachable", "not-configured" ] } }, "required": [ "meta" ], "additionalProperties": false } }, "required": [ "ok", "version", "checks" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "version": { "type": "string" }, "checks": { "type": "object", "properties": { "meta": { "type": "string", "enum": [ "ok", "unreachable", "not-configured" ] } }, "required": [ "meta" ], "additionalProperties": false } }, "required": [ "ok", "version", "checks" ], "additionalProperties": false } } } } } } }, "/api/v1/system/info": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "node": { "type": "string" }, "dialect": { "anyOf": [ { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, { "type": "null" } ] }, "runtime": { "type": "string", "enum": [ "self-host", "desktop" ] }, "smtpConfigured": { "type": "boolean" }, "networkFeaturesAllowed": { "type": "boolean" }, "lanShare": { "type": "boolean" }, "desktopDemo": { "type": "boolean" } }, "required": [ "version", "node", "dialect", "runtime", "smtpConfigured", "networkFeaturesAllowed", "lanShare", "desktopDemo" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/login": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 320 }, "password": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "email", "password" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "twoFactorSetupRequired": { "type": "boolean", "enum": [ true ] } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } }, "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "twoFactorRequired": { "type": "boolean", "enum": [ true ] }, "challengeToken": { "type": "string" } }, "required": [ "twoFactorRequired", "challengeToken" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/2fa/verify": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "challengeToken": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 6, "maxLength": 20 } }, "required": [ "challengeToken", "code" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "twoFactorSetupRequired": { "type": "boolean", "enum": [ true ] } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/logout": { "post": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/session": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "roles": { "type": "array", "items": { "type": "string" } }, "twoFactorSetupRequired": { "type": "boolean" } }, "required": [ "user", "roles", "twoFactorSetupRequired" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/sessions": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userAgent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "lastSeenAt": { "type": "number" }, "expiresAt": { "type": "number" }, "current": { "type": "boolean" } }, "required": [ "id", "ip", "userAgent", "createdAt", "lastSeenAt", "expiresAt", "current" ], "additionalProperties": false } } }, "required": [ "sessions" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/sessions/{id}": { "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/password/change": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currentPassword": { "type": "string", "minLength": 1, "maxLength": 200 }, "newPassword": { "type": "string", "minLength": 8, "maxLength": 200 } }, "required": [ "currentPassword", "newPassword" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/password/forgot": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 320 } }, "required": [ "email" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/password/reset": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "minLength": 1 }, "newPassword": { "type": "string", "minLength": 8, "maxLength": 200 } }, "required": [ "token", "newPassword" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/2fa/enroll": { "post": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "secret": { "type": "string" }, "otpauthUrl": { "type": "string" } }, "required": [ "secret", "otpauthUrl" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/2fa/activate": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "minLength": 6, "maxLength": 20 } }, "required": [ "code" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "recoveryCodes": { "type": "array", "items": { "type": "string" } } }, "required": [ "recoveryCodes" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/auth/2fa/disable": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "minLength": 1, "maxLength": 200 }, "code": { "type": "string", "minLength": 6, "maxLength": 20 } }, "required": [ "password" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "minLength": 3, "maxLength": 320 }, "password": { "type": "string", "minLength": 1, "maxLength": 200 } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "user" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me/prefs": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "prefs": { "type": "object", "properties": { "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "system" ] }, { "type": "null" } ] }, "accent": { "anyOf": [ { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, { "type": "null" } ] }, "density": { "anyOf": [ { "type": "string", "enum": [ "comfortable", "compact" ] }, { "type": "null" } ] }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, { "type": "null" } ] }, "dir": { "anyOf": [ { "type": "string", "enum": [ "ltr", "rtl" ] }, { "type": "null" } ] } }, "required": [ "theme", "accent", "density", "locale", "dir" ], "additionalProperties": false }, "resolved": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "source": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "system", "global", "user" ] }, "accent": { "type": "string", "enum": [ "system", "global", "user" ] }, "density": { "type": "string", "enum": [ "system", "global", "user" ] }, "locale": { "type": "string", "enum": [ "system", "global", "user" ] }, "dir": { "type": "string", "enum": [ "system", "global", "user" ] } }, "required": [ "theme", "accent", "density", "locale", "dir" ], "additionalProperties": false } }, "required": [ "theme", "accent", "density", "locale", "dir", "source" ], "additionalProperties": false } }, "required": [ "prefs", "resolved" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "system" ] }, { "type": "null" } ] }, "accent": { "anyOf": [ { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, { "type": "null" } ] }, "density": { "anyOf": [ { "type": "string", "enum": [ "comfortable", "compact" ] }, { "type": "null" } ] }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, { "type": "null" } ] }, "dir": { "anyOf": [ { "type": "string", "enum": [ "ltr", "rtl" ] }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "prefs": { "type": "object", "properties": { "theme": { "anyOf": [ { "type": "string", "enum": [ "light", "dark", "system" ] }, { "type": "null" } ] }, "accent": { "anyOf": [ { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, { "type": "null" } ] }, "density": { "anyOf": [ { "type": "string", "enum": [ "comfortable", "compact" ] }, { "type": "null" } ] }, "locale": { "anyOf": [ { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, { "type": "null" } ] }, "dir": { "anyOf": [ { "type": "string", "enum": [ "ltr", "rtl" ] }, { "type": "null" } ] } }, "required": [ "theme", "accent", "density", "locale", "dir" ], "additionalProperties": false }, "resolved": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "source": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "system", "global", "user" ] }, "accent": { "type": "string", "enum": [ "system", "global", "user" ] }, "density": { "type": "string", "enum": [ "system", "global", "user" ] }, "locale": { "type": "string", "enum": [ "system", "global", "user" ] }, "dir": { "type": "string", "enum": [ "system", "global", "user" ] } }, "required": [ "theme", "accent", "density", "locale", "dir" ], "additionalProperties": false } }, "required": [ "theme", "accent", "density", "locale", "dir", "source" ], "additionalProperties": false } }, "required": [ "prefs", "resolved" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/bootstrap": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "roles": { "type": "array", "items": { "type": "string" } }, "prefs": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "source": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "system", "global", "user" ] }, "accent": { "type": "string", "enum": [ "system", "global", "user" ] }, "density": { "type": "string", "enum": [ "system", "global", "user" ] }, "locale": { "type": "string", "enum": [ "system", "global", "user" ] }, "dir": { "type": "string", "enum": [ "system", "global", "user" ] } }, "required": [ "theme", "accent", "density", "locale", "dir" ], "additionalProperties": false } }, "required": [ "theme", "accent", "density", "locale", "dir", "source" ], "additionalProperties": false }, "nav": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "workspace", "library", "planning", "people", "account" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "slug": { "type": "string" }, "labelKey": { "type": "string" }, "fallback": { "type": "string" }, "icon": { "type": "string" }, "badge": { "type": "string", "enum": [ "unread-count", "pending-count" ] }, "order": { "type": "number" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "connectionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sourceTable": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "slug", "labelKey", "fallback", "icon", "order", "connectionId", "connectionName", "sourceTable" ], "additionalProperties": false } } }, "required": [ "key", "items" ], "additionalProperties": false } } }, "required": [ "groups" ], "additionalProperties": false }, "version": { "type": "string" }, "configVersion": { "type": "number" }, "llm": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false }, "csrfToken": { "type": "string" }, "hostedApps": { "type": "array", "items": { "type": "object", "properties": { "appKey": { "type": "string" }, "instance": { "type": "string" }, "label": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "path": { "type": "string" }, "label": { "type": "string" }, "icon": { "type": "string" }, "persona": { "type": "string" } }, "required": [ "id", "path", "label" ], "additionalProperties": false } } }, "required": [ "appKey", "label", "items" ], "additionalProperties": false } }, "hiddenPages": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "slug": { "type": "string" }, "labelKey": { "type": "string" }, "fallback": { "type": "string" }, "icon": { "type": "string" }, "badge": { "type": "string", "enum": [ "unread-count", "pending-count" ] }, "order": { "type": "number" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "connectionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sourceTable": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "slug", "labelKey", "fallback", "icon", "order", "connectionId", "connectionName", "sourceTable" ], "additionalProperties": false } }, "pausedPages": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "slug": { "type": "string" }, "labelKey": { "type": "string" }, "fallback": { "type": "string" }, "icon": { "type": "string" }, "badge": { "type": "string", "enum": [ "unread-count", "pending-count" ] }, "order": { "type": "number" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "connectionName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sourceTable": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "slug", "labelKey", "fallback", "icon", "order", "connectionId", "connectionName", "sourceTable" ], "additionalProperties": false } } }, "required": [ "user", "roles", "prefs", "nav", "version", "configVersion", "llm", "csrfToken", "hostedApps", "hiddenPages", "pausedPages" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/setup/state": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "required": { "type": "boolean" }, "passwordMinLength": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "required", "passwordMinLength" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/setup/super-admin": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 320, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "password": { "type": "string", "minLength": 1, "maxLength": 200 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "consent": { "type": "object", "properties": { "telemetry": { "type": "boolean" }, "updateCheck": { "type": "boolean" } }, "required": [ "telemetry", "updateCheck" ], "additionalProperties": false } }, "required": [ "email", "password" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt" ], "additionalProperties": false }, "csrfToken": { "type": "string" } }, "required": [ "user", "csrfToken" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/about": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "string" }, "license": { "type": "string" }, "sourceUrl": { "type": "string" }, "licenseUrl": { "type": "string" }, "metaEngine": { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, "metaMigrationVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "node": { "type": "string" }, "telemetry": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false }, "updates": { "type": "object", "properties": { "checkEnabled": { "type": "boolean" } }, "required": [ "checkEnabled" ], "additionalProperties": false } }, "required": [ "version", "license", "sourceUrl", "licenseUrl", "metaEngine", "metaMigrationVersion", "node", "telemetry", "updates" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/about/update-check": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "enum": [ "disabled" ] } }, "required": [ "status" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "current" ] }, "current": { "type": "string" } }, "required": [ "status", "current" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "unknown" ] }, "current": { "type": "string" } }, "required": [ "status", "current" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "update-available" ] }, "current": { "type": "string" }, "latest": { "type": "string" }, "url": { "type": "string" } }, "required": [ "status", "current", "latest", "url" ], "additionalProperties": false } ] } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/events": { "get": { "parameters": [ { "schema": { "type": "string", "maxLength": 4096 }, "in": "query", "name": "channels", "required": false }, { "schema": { "type": "string", "maxLength": 4096 }, "in": "query", "name": "topics", "required": false } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/jobs": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "minLength": 1, "maxLength": 60 }, "payload": { "default": {}, "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "priority": { "type": "integer", "minimum": -100, "maximum": 100 }, "runAt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": 1, "maximum": 10 }, "dedupeKey": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "kind" ] } } } }, "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "jobId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] } }, "required": [ "jobId", "status" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 60 }, "in": "query", "name": "kind", "required": false }, { "schema": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "default": 25, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "cursor", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "runAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "pct": { "type": "integer", "minimum": 0, "maximum": 100 }, "step": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pct" ], "additionalProperties": false }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "startedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "priority", "runAt", "attempts", "maxAttempts", "progress", "lastError", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } }, "cursor": { "type": "object", "properties": { "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "next" ], "additionalProperties": false } }, "required": [ "data", "cursor" ], "additionalProperties": false } } } } } } }, "/api/v1/jobs/{id}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "runAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "pct": { "type": "integer", "minimum": 0, "maximum": 100 }, "step": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pct" ], "additionalProperties": false }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "startedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "priority", "runAt", "attempts", "maxAttempts", "progress", "lastError", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/jobs/{id}/cancel": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "cancelled" ] }, "priority": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "runAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "attempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "maxAttempts": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "progress": { "anyOf": [ { "type": "object", "properties": { "pct": { "type": "integer", "minimum": 0, "maximum": 100 }, "step": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pct" ], "additionalProperties": false }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "startedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "id", "kind", "status", "priority", "runAt", "attempts", "maxAttempts", "progress", "lastError", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/meta/placement": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "env", "bootstrap", "embedded" ] }, "engine": { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, "embedded": { "type": "boolean" }, "canRelocate": { "type": "boolean" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "source", "engine", "embedded", "canRelocate", "reason" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/meta/relocate": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dsn": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "dsn" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, "rowsCopied": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "restarting": { "type": "boolean" }, "healthPath": { "type": "string" } }, "required": [ "engine", "rowsCopied", "restarting", "healthPath" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/connections": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "connections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "sourceKind": { "type": "string" }, "dsnMasked": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "status": { "type": "string" }, "lastTestedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastLatencyMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastErrorHint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezoneSource": { "anyOf": [ { "type": "string", "enum": [ "host", "operator" ] }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "disabled": { "type": "boolean" }, "disabledAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "snapshot": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "checksum": { "type": "string" } }, "required": [ "id", "createdAt", "checksum" ], "additionalProperties": false }, { "type": "null" } ] }, "tableCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "engine", "sourceKind", "dsnMasked", "readOnly", "status", "lastTestedAt", "lastLatencyMs", "lastError", "lastErrorHint", "timezone", "timezoneSource", "currency", "disabled", "disabledAt", "snapshot", "tableCount", "pageCount", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "connections" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "engine": { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, "dsn": { "type": "string", "minLength": 1 }, "roles": { "type": "object", "properties": { "introspect": { "type": "string", "minLength": 1 }, "data": { "type": "string", "minLength": 1 } } }, "settings": { "type": "object", "properties": { "includedTables": { "type": "array", "items": { "type": "string" } }, "intent": { "type": "string", "enum": [ "full-admin", "read-only-analytics", "crud", "support-console" ] } } } }, "required": [ "name", "engine" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "sourceKind": { "type": "string" }, "dsnMasked": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "status": { "type": "string" }, "lastTestedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastLatencyMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastErrorHint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezoneSource": { "anyOf": [ { "type": "string", "enum": [ "host", "operator" ] }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "disabled": { "type": "boolean" }, "disabledAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "snapshot": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "checksum": { "type": "string" } }, "required": [ "id", "createdAt", "checksum" ], "additionalProperties": false }, { "type": "null" } ] }, "tableCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "engine", "sourceKind", "dsnMasked", "readOnly", "status", "lastTestedAt", "lastLatencyMs", "lastError", "lastErrorHint", "timezone", "timezoneSource", "currency", "disabled", "disabledAt", "snapshot", "tableCount", "pageCount", "createdAt", "updatedAt" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/test": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "engine": { "type": "string", "enum": [ "postgres", "mysql", "sqlite" ] }, "dsn": { "type": "string", "minLength": 1 } }, "required": [ "engine", "dsn" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "latencyMs": { "type": "number" }, "serverVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "privileges": { "anyOf": [ { "type": "object", "properties": { "canReadSchema": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" }, "canDDL": { "type": "boolean" } }, "required": [ "canReadSchema", "canRead", "canWrite", "canDDL" ], "additionalProperties": false }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "code", "message", "hint" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "latencyMs", "serverVersion", "readOnly", "privileges", "error" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "sourceKind": { "type": "string" }, "dsnMasked": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "status": { "type": "string" }, "lastTestedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastLatencyMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastErrorHint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezoneSource": { "anyOf": [ { "type": "string", "enum": [ "host", "operator" ] }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "disabled": { "type": "boolean" }, "disabledAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "snapshot": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "checksum": { "type": "string" } }, "required": [ "id", "createdAt", "checksum" ], "additionalProperties": false }, { "type": "null" } ] }, "tableCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "engine", "sourceKind", "dsnMasked", "readOnly", "status", "lastTestedAt", "lastLatencyMs", "lastError", "lastErrorHint", "timezone", "timezoneSource", "currency", "disabled", "disabledAt", "snapshot", "tableCount", "pageCount", "createdAt", "updatedAt" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "settings": { "type": "object", "properties": { "includedTables": { "type": "array", "items": { "type": "string" } }, "intent": { "type": "string", "enum": [ "full-admin", "read-only-analytics", "crud", "support-console" ] } } }, "timezone": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 64 }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string", "minLength": 3, "maxLength": 3, "pattern": "^[A-Z]{3}$" }, { "type": "null" } ] }, "disabled": { "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "sourceKind": { "type": "string" }, "dsnMasked": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "status": { "type": "string" }, "lastTestedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastLatencyMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastError": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastErrorHint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezoneSource": { "anyOf": [ { "type": "string", "enum": [ "host", "operator" ] }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "disabled": { "type": "boolean" }, "disabledAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "snapshot": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "checksum": { "type": "string" } }, "required": [ "id", "createdAt", "checksum" ], "additionalProperties": false }, { "type": "null" } ] }, "tableCount": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "pageCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "engine", "sourceKind", "dsnMasked", "readOnly", "status", "lastTestedAt", "lastLatencyMs", "lastError", "lastErrorHint", "timezone", "timezoneSource", "currency", "disabled", "disabledAt", "snapshot", "tableCount", "pageCount", "createdAt", "updatedAt" ], "additionalProperties": false } } } } } }, "delete": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "confirmName": { "type": "string" }, "force": { "type": "boolean" } }, "required": [ "confirmName" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/test": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "latencyMs": { "type": "number" }, "serverVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readOnly": { "type": "boolean" }, "privileges": { "anyOf": [ { "type": "object", "properties": { "canReadSchema": { "type": "boolean" }, "canRead": { "type": "boolean" }, "canWrite": { "type": "boolean" }, "canDDL": { "type": "boolean" } }, "required": [ "canReadSchema", "canRead", "canWrite", "canDDL" ], "additionalProperties": false }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "code", "message", "hint" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "latencyMs", "serverVersion", "readOnly", "privileges", "error" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/introspect": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshotId": { "type": "string" }, "noop": { "type": "boolean" }, "proposedMasks": { "type": "number" }, "checksum": { "type": "string" } }, "required": [ "snapshotId", "noop", "proposedMasks", "checksum" ], "additionalProperties": false } } } }, "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } }, "required": [ "jobId" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/schema": { "get": { "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "raw", "required": false }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "query", "name": "locale", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "checksum": { "type": "string" }, "createdAt": { "type": "number" }, "source": { "type": "string" }, "model": {}, "appliedOverrides": { "type": "number" } }, "required": [ "connectionId", "snapshotId", "checksum", "createdAt", "source", "model", "appliedOverrides" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/schema/snapshots": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "snapshots": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "source": { "type": "string" }, "engineVersion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "checksum": { "type": "string" }, "isActive": { "type": "boolean" }, "createdAt": { "type": "number" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "source", "engineVersion", "checksum", "isActive", "createdAt", "createdBy" ], "additionalProperties": false } } }, "required": [ "snapshots" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/schema/snapshots/{snapshotId}": { "get": { "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "raw", "required": false }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "query", "name": "locale", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "snapshotId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "checksum": { "type": "string" }, "createdAt": { "type": "number" }, "source": { "type": "string" }, "model": {}, "appliedOverrides": { "type": "number" } }, "required": [ "connectionId", "snapshotId", "checksum", "createdAt", "source", "model", "appliedOverrides" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/schema/diff": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "diff": {} }, "required": [ "from", "to", "diff" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/schema/overrides": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string" }, "tableName": { "type": "string" }, "columnName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "origin": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "op", "tableName", "columnName", "value", "origin", "status", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "overrides" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "minLength": 1 }, "tableName": { "type": "string", "minLength": 1 }, "columnName": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "status": { "type": "string", "enum": [ "active", "disabled" ] } }, "required": [ "op", "tableName", "value" ] } } }, "required": [ "overrides" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string" }, "tableName": { "type": "string" }, "columnName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "origin": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "op", "tableName", "columnName", "value", "origin", "status", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "overrides" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/overrides": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string" }, "tableName": { "type": "string" }, "columnName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "origin": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "op", "tableName", "columnName", "value", "origin", "status", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "overrides" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "minLength": 1 }, "tableName": { "type": "string", "minLength": 1 }, "columnName": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "status": { "type": "string", "enum": [ "active", "disabled" ] } }, "required": [ "op", "tableName", "value" ] } } }, "required": [ "overrides" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "op": { "type": "string" }, "tableName": { "type": "string" }, "columnName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "origin": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "op", "tableName", "columnName", "value", "origin", "status", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "overrides" ], "additionalProperties": false } } } } } } }, "/api/v1/data/{connectionId}/{table}": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "select", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "where", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "lookup", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agg", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "enum": [ "exact", "estimated", "none" ] }, "in": "query", "name": "count", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "page": { "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "total": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "limit", "offset", "total" ], "additionalProperties": false }, "cursor": { "type": "object", "properties": { "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "next" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "values" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "undoToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "undoToken" ], "additionalProperties": false } } } } } } }, "/api/v1/data/undo/{token}": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "token", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "restoredIds": { "type": "array", "items": {} } }, "required": [ "restoredIds" ], "additionalProperties": false } } } } } } }, "/api/v1/data/{connectionId}/{table}/bulk": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "update", "delete" ] }, "ids": { "minItems": 1, "maxItems": 1000, "type": "array", "items": {} }, "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "action", "ids" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "array", "items": { "type": "object", "properties": { "id": {}, "ok": { "type": "boolean" }, "error": { "type": "string" } }, "required": [ "id", "ok" ], "additionalProperties": false } }, "undoToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "results", "undoToken" ], "additionalProperties": false } } } } } } }, "/api/v1/data/{connectionId}/{table}/{recordId}/references": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "recordId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "references": { "type": "array", "items": { "type": "object", "properties": { "relationId": { "type": "string" }, "table": { "type": "string" }, "column": { "type": "string" }, "count": { "type": "number" } }, "required": [ "relationId", "table", "column", "count" ], "additionalProperties": false } } }, "required": [ "references" ], "additionalProperties": false } } } } } } }, "/api/v1/data/{connectionId}/{table}/{recordId}": { "get": { "parameters": [ { "schema": { "type": "string", "enum": [ "inboundCounts" ] }, "in": "query", "name": "include", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "lookup", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "agg", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "recordId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "inboundCounts": { "type": "array", "items": { "type": "object", "properties": { "relationId": { "type": "string" }, "table": { "type": "string" }, "column": { "type": "string" }, "count": { "type": "number" } }, "required": [ "relationId", "table", "column", "count" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "values" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "recordId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "undoToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "undoToken" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "dryRun", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "confirm", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "connectionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "table", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "recordId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "data": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "undoToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "data", "undoToken" ], "additionalProperties": false }, { "type": "object", "properties": { "references": { "type": "array", "items": { "type": "object", "properties": { "relationId": { "type": "string" }, "table": { "type": "string" }, "column": { "type": "string" }, "count": { "type": "number" } }, "required": [ "relationId", "table", "column", "count" ], "additionalProperties": false } }, "requiresConfirm": { "type": "boolean" } }, "required": [ "references", "requiresConfirm" ], "additionalProperties": false } ] } } } } } } }, "/api/v1/exports": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1 }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "table", "view", "page" ] }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "viewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filters": { "type": "array", "items": {} } }, "required": [ "kind" ] }, "format": { "type": "string", "enum": [ "csv", "json", "xlsx" ] } }, "required": [ "connectionId", "source", "format" ] } } } }, "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestedBy": { "type": "string" }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "table", "view", "page" ] }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "viewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filters": { "type": "array", "items": {} } }, "required": [ "kind" ], "additionalProperties": false }, "format": { "type": "string", "enum": [ "csv", "json", "xlsx" ] }, "status": { "type": "string", "enum": [ "processing", "ready", "failed", "cancelled", "expired" ] }, "fileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rowCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "completedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "requestedBy", "source", "format", "status", "fileId", "filename", "sizeBytes", "rowCount", "error", "jobId", "createdAt", "completedAt", "expiresAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "get": { "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestedBy": { "type": "string" }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "table", "view", "page" ] }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "viewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filters": { "type": "array", "items": {} } }, "required": [ "kind" ], "additionalProperties": false }, "format": { "type": "string", "enum": [ "csv", "json", "xlsx" ] }, "status": { "type": "string", "enum": [ "processing", "ready", "failed", "cancelled", "expired" ] }, "fileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rowCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "completedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "requestedBy", "source", "format", "status", "fileId", "filename", "sizeBytes", "rowCount", "error", "jobId", "createdAt", "completedAt", "expiresAt" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/exports/{id}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestedBy": { "type": "string" }, "source": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "table", "view", "page" ] }, "table": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "viewId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filters": { "type": "array", "items": {} } }, "required": [ "kind" ], "additionalProperties": false }, "format": { "type": "string", "enum": [ "csv", "json", "xlsx" ] }, "status": { "type": "string", "enum": [ "processing", "ready", "failed", "cancelled", "expired" ] }, "fileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filename": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sizeBytes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rowCount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jobId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "completedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "requestedBy", "source", "format", "status", "fileId", "filename", "sizeBytes", "rowCount", "error", "jobId", "createdAt", "completedAt", "expiresAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/exports/{id}/download": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/imports/upload": { "post": { "parameters": [ { "schema": { "default": "upload.csv", "type": "string", "minLength": 1, "maxLength": 260 }, "in": "query", "name": "filename", "required": false } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "fileId": { "type": "string" }, "filename": { "type": "string" }, "sizeBytes": { "type": "number" }, "sha256": { "type": "string" }, "columns": { "type": "array", "items": { "type": "string" } }, "sampleRows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "totalRows": { "type": "number" } }, "required": [ "fileId", "filename", "sizeBytes", "sha256", "columns", "sampleRows", "totalRows" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/imports": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fileId": { "type": "string", "minLength": 1 }, "connectionId": { "type": "string", "minLength": 1 }, "table": { "type": "string", "minLength": 1 }, "mapping": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "from", "to" ] } } }, "required": [ "columns" ] }, "options": { "default": {}, "type": "object", "properties": { "mode": { "type": "string", "enum": [ "insert", "upsert" ] }, "matchColumn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "skipInvalid": { "type": "boolean" } } } }, "required": [ "fileId", "connectionId", "table", "mapping" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "import": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "tableName": { "type": "string" }, "requestedBy": { "type": "string" }, "fileId": { "type": "string" }, "mapping": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "columns" ], "additionalProperties": false }, "options": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "insert", "upsert" ] }, "matchColumn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "skipInvalid": { "type": "boolean" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "validating", "ready", "running", "succeeded", "failed", "cancelled" ] }, "stats": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "total" ], "additionalProperties": false }, { "type": "null" } ] }, "errorReportFileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "tableName", "requestedBy", "fileId", "mapping", "options", "status", "stats", "errorReportFileId", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false }, "report": { "type": "object", "properties": { "total": { "type": "number" }, "valid": { "type": "number" }, "invalid": { "type": "number" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "number" }, "column": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "value": { "type": "string" } }, "required": [ "row", "column", "code", "message", "value" ], "additionalProperties": false } } }, "required": [ "total", "valid", "invalid", "issues" ], "additionalProperties": false } }, "required": [ "import", "report" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "get": { "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "tableName": { "type": "string" }, "requestedBy": { "type": "string" }, "fileId": { "type": "string" }, "mapping": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "columns" ], "additionalProperties": false }, "options": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "insert", "upsert" ] }, "matchColumn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "skipInvalid": { "type": "boolean" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "validating", "ready", "running", "succeeded", "failed", "cancelled" ] }, "stats": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "total" ], "additionalProperties": false }, { "type": "null" } ] }, "errorReportFileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "tableName", "requestedBy", "fileId", "mapping", "options", "status", "stats", "errorReportFileId", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/imports/{id}/run": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "import": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "tableName": { "type": "string" }, "requestedBy": { "type": "string" }, "fileId": { "type": "string" }, "mapping": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "columns" ], "additionalProperties": false }, "options": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "insert", "upsert" ] }, "matchColumn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "skipInvalid": { "type": "boolean" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "validating", "ready", "running", "succeeded", "failed", "cancelled" ] }, "stats": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "total" ], "additionalProperties": false }, { "type": "null" } ] }, "errorReportFileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "tableName", "requestedBy", "fileId", "mapping", "options", "status", "stats", "errorReportFileId", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false }, "jobId": { "type": "string" } }, "required": [ "import", "jobId" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/imports/{id}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "tableName": { "type": "string" }, "requestedBy": { "type": "string" }, "fileId": { "type": "string" }, "mapping": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "from", "to" ], "additionalProperties": false } } }, "required": [ "columns" ], "additionalProperties": false }, "options": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "insert", "upsert" ] }, "matchColumn": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "skipInvalid": { "type": "boolean" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "validating", "ready", "running", "succeeded", "failed", "cancelled" ] }, "stats": { "anyOf": [ { "type": "object", "properties": { "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "inserted": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "skipped": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "total" ], "additionalProperties": false }, { "type": "null" } ] }, "errorReportFileId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "startedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "finishedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "tableName", "requestedBy", "fileId", "mapping", "options", "status", "stats", "errorReportFileId", "createdAt", "startedAt", "finishedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/imports/{id}/error-report": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/me/notifications": { "get": { "parameters": [ { "schema": { "default": "false", "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "unread", "required": false }, { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "pattern": "^(\\d+):(.+)$" }, "in": "query", "name": "before", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "actorLabel": { "type": "string" }, "title": { "type": "string" }, "body": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "entity": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "actionUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "readAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "kind", "actorLabel", "title", "body", "entity", "actionUrl", "readAt", "createdAt" ], "additionalProperties": false } }, "unreadCount": { "type": "number" }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "items", "unreadCount", "nextCursor" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me/notifications/{id}/read": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updated": { "type": "boolean" }, "unreadCount": { "type": "number" } }, "required": [ "updated", "unreadCount" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me/notifications/read-all": { "post": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updated": { "type": "number" }, "unreadCount": { "type": "number" } }, "required": [ "updated", "unreadCount" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me/notification-prefs": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "inApp", "email", "push" ] }, "available": { "type": "boolean" }, "reason": { "type": "string" } }, "required": [ "id", "available" ], "additionalProperties": false } }, "events": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$" }, "channels": { "type": "object", "properties": { "inApp": { "type": "boolean" }, "email": { "type": "boolean" }, "push": { "type": "boolean" } }, "required": [ "inApp", "email", "push" ], "additionalProperties": false }, "custom": { "type": "boolean" } }, "required": [ "key", "channels", "custom" ], "additionalProperties": false } } }, "required": [ "channels", "events" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$" }, "channels": { "type": "object", "properties": { "inApp": { "type": "boolean" }, "email": { "type": "boolean" }, "push": { "type": "boolean" } }, "required": [ "inApp", "email", "push" ] } }, "required": [ "key", "channels" ] } } }, "required": [ "events" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "channels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "inApp", "email", "push" ] }, "available": { "type": "boolean" }, "reason": { "type": "string" } }, "required": [ "id", "available" ], "additionalProperties": false } }, "events": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 80, "pattern": "^[a-z0-9]+(?:[.-][a-z0-9]+)*$" }, "channels": { "type": "object", "properties": { "inApp": { "type": "boolean" }, "email": { "type": "boolean" }, "push": { "type": "boolean" } }, "required": [ "inApp", "email", "push" ], "additionalProperties": false }, "custom": { "type": "boolean" } }, "required": [ "key", "channels", "custom" ], "additionalProperties": false } } }, "required": [ "channels", "events" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/scheduled-reports": { "get": { "parameters": [ { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "pageTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageSlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "dayOfWeek": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6 }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "null" } ] }, "time": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "frequency", "time", "timezone" ], "additionalProperties": false }, "recipients": { "type": "array", "items": { "type": "string" } }, "format": { "type": "string", "enum": [ "pdf", "png" ] }, "enabled": { "type": "boolean" }, "lastRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "pageTitle", "pageSlug", "name", "schedule", "recipients", "format", "enabled", "lastRunAt", "nextRunAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "dayOfWeek": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6 }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "null" } ] }, "time": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "frequency", "time", "timezone" ] }, "recipients": { "default": [], "type": "array", "items": { "type": "string" } }, "format": { "default": "pdf", "type": "string", "enum": [ "pdf", "png" ] }, "enabled": { "default": true, "type": "boolean" } }, "required": [ "pageId", "name", "schedule" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "pageTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageSlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "dayOfWeek": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6 }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "null" } ] }, "time": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "frequency", "time", "timezone" ], "additionalProperties": false }, "recipients": { "type": "array", "items": { "type": "string" } }, "format": { "type": "string", "enum": [ "pdf", "png" ] }, "enabled": { "type": "boolean" }, "lastRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "pageTitle", "pageSlug", "name", "schedule", "recipients", "format", "enabled", "lastRunAt", "nextRunAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/scheduled-reports/{id}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "dayOfWeek": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6 }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "null" } ] }, "time": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "frequency", "time", "timezone" ] }, "recipients": { "type": "array", "items": { "type": "string" } }, "format": { "type": "string", "enum": [ "pdf", "png" ] }, "enabled": { "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "pageTitle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pageSlug": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "schedule": { "type": "object", "properties": { "frequency": { "type": "string", "enum": [ "daily", "weekly", "monthly" ] }, "dayOfWeek": { "anyOf": [ { "type": "integer", "minimum": 0, "maximum": 6 }, { "type": "null" } ] }, "dayOfMonth": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 31 }, { "type": "null" } ] }, "time": { "type": "string" }, "timezone": { "type": "string" } }, "required": [ "frequency", "time", "timezone" ], "additionalProperties": false }, "recipients": { "type": "array", "items": { "type": "string" } }, "format": { "type": "string", "enum": [ "pdf", "png" ] }, "enabled": { "type": "boolean" }, "lastRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nextRunAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "pageTitle", "pageSlug", "name", "schedule", "recipients", "format", "enabled", "lastRunAt", "nextRunAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/email-templates": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "enabled": { "type": "boolean" }, "updatedAt": { "type": "number" } }, "required": [ "id", "key", "locale", "name", "subject", "enabled", "updatedAt" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } } } } }, "/api/v1/email-templates/{key}/{locale}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 80 }, "in": "path", "name": "key", "required": true }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35 }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "enabled": { "type": "boolean" }, "updatedAt": { "type": "number" }, "blocks": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "id", "key", "locale", "name", "subject", "enabled", "updatedAt", "blocks" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "subject": { "type": "string", "minLength": 1, "maxLength": 300 }, "blocks": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "enabled": { "type": "boolean" } }, "required": [ "name", "subject", "blocks", "enabled" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 80 }, "in": "path", "name": "key", "required": true }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35 }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "locale": { "type": "string" }, "name": { "type": "string" }, "subject": { "type": "string" }, "enabled": { "type": "boolean" }, "updatedAt": { "type": "number" }, "blocks": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } } }, "required": [ "id", "key", "locale", "name", "subject", "enabled", "updatedAt", "blocks" ], "additionalProperties": false } } } } } } }, "/api/v1/email-templates/{key}/test-send": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "string", "minLength": 3, "maxLength": 320 } }, "required": [ "to" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 120 }, "in": "path", "name": "key", "required": true } ], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "queued": { "type": "boolean", "enum": [ true ] }, "locale": { "type": "string" } }, "required": [ "queued", "locale" ], "additionalProperties": false } } } } } } }, "/api/v1/connections/{id}/generate": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "intent": { "type": "string", "enum": [ "full-admin", "read-only-analytics", "crud", "support-console" ] } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "pages": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "navGroups": { "type": "array", "items": { "type": "string" } }, "snapshotId": { "type": "string" }, "introspected": { "type": "boolean" }, "intent": { "type": "string", "enum": [ "full-admin", "read-only-analytics", "crud", "support-console" ] }, "result": { "type": "object", "properties": { "created": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updated": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "unchanged": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "pruned": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "preserved": { "type": "array", "items": { "type": "string" } }, "skippedEdited": { "type": "array", "items": { "type": "string" } }, "keptEdited": { "type": "array", "items": { "type": "string" } } }, "required": [ "created", "updated", "unchanged", "pruned", "preserved", "skippedEdited", "keptEdited" ], "additionalProperties": false }, "llmPagesMaterialized": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "warnings": { "type": "array", "items": { "type": "string" } }, "durationMs": { "type": "number", "minimum": 0 } }, "required": [ "pages", "navGroups", "snapshotId", "introspected", "intent", "result", "llmPagesMaterialized", "warnings", "durationMs" ], "additionalProperties": false } } } } } } }, "/api/v1/schema-import/parse": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "anyOf": [ { "type": "string", "enum": [ "sql-ddl", "prisma", "drizzle", "typeorm", "sequelize", "rails", "django", "json-ir" ] }, { "type": "string", "enum": [ "sql", "json" ] } ] }, "content": { "type": "string", "minLength": 1 }, "fileName": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": [ "content" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "model": {}, "format": { "type": "string", "enum": [ "sql-ddl", "prisma", "drizzle", "typeorm", "sequelize", "rails", "django", "json-ir" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "object", "properties": { "tables": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "columns": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "relations": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "enums": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "tables", "columns", "relations", "enums" ], "additionalProperties": false } }, "required": [ "model", "format", "warnings", "summary" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": {}, "canEditLayout": { "type": "boolean" }, "canCreate": { "type": "boolean" }, "canUpdate": { "type": "boolean" }, "canDelete": { "type": "boolean" }, "canUnmask": { "type": "boolean" }, "layoutStale": { "type": "boolean" } }, "required": [ "data", "canEditLayout" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 31, "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "icon": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string", "enum": [ "workspace", "library", "planning", "people", "account" ] }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "isEnabled": { "type": "boolean" }, "template": { "type": "string", "enum": [ "page-crud", "page-record", "page-dashboard", "page-master-detail", "page-queue-inbox", "page-board", "page-calendar", "page-scheduler", "page-directory", "page-log-viewer", "page-files", "page-chat", "page-builder", "page-wizard", "page-settings" ] }, "connectionId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "table": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "padding": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "standard" ] }, { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 200 }, "y": { "type": "integer", "minimum": 0, "maximum": 200 } }, "required": [ "x", "y" ] } ] }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "string", "enum": [ "full", "narrow", "content", "page", "dash", "wide" ] }, { "type": "null" } ] }, "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "origin": { "type": "string" }, "manifestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isEnabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "slug", "type", "title", "icon", "navGroup", "navOrder", "origin", "manifestId", "isEnabled", "revision", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}/layout": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "items": { "maxItems": 60, "type": "array", "items": { "type": "object", "properties": { "i": { "type": "string" }, "widget": { "type": "string" }, "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "w": { "type": "integer", "minimum": 1, "maximum": 12 }, "h": { "type": "integer", "minimum": 1, "maximum": 24 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "i", "widget", "x", "y", "w", "h", "config" ] } } }, "required": [ "version", "items" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "layout": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "items": { "maxItems": 60, "type": "array", "items": { "type": "object", "properties": { "i": { "type": "string" }, "widget": { "type": "string" }, "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "w": { "type": "integer", "minimum": 1, "maximum": 12 }, "h": { "type": "integer", "minimum": 1, "maximum": 24 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "i", "widget", "x", "y", "w", "h", "config" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false } }, "required": [ "layout" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "origin": { "type": "string" }, "manifestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isEnabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "slug", "type", "title", "icon", "navGroup", "navOrder", "origin", "manifestId", "isEnabled", "revision", "updatedAt" ], "additionalProperties": false } } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 31, "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 }, "template": { "type": "string", "enum": [ "page-crud", "page-record", "page-dashboard", "page-master-detail", "page-queue-inbox", "page-board", "page-calendar", "page-scheduler", "page-directory", "page-log-viewer", "page-files", "page-chat", "page-builder", "page-wizard", "page-settings" ] }, "navGroup": { "type": "string", "enum": [ "workspace", "library", "planning", "people", "account" ] }, "icon": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 40 }, { "type": "null" } ] }, "connectionId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "table": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "padding": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "standard" ] }, { "type": "object", "properties": { "x": { "type": "integer", "minimum": 0, "maximum": 200 }, "y": { "type": "integer", "minimum": 0, "maximum": 200 } }, "required": [ "x", "y" ] } ] }, { "type": "null" } ] }, "width": { "anyOf": [ { "type": "string", "enum": [ "full", "narrow", "content", "page", "dash", "wide" ] }, { "type": "null" } ] } }, "required": [ "slug", "title", "template", "navGroup" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "origin": { "type": "string" }, "manifestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isEnabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "slug", "type", "title", "icon", "navGroup", "navOrder", "origin", "manifestId", "isEnabled", "revision", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/nav-order": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "minItems": 1, "maxItems": 400, "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string", "minLength": 1 }, "navGroup": { "type": "string", "enum": [ "workspace", "library", "planning", "people", "account" ] } }, "required": [ "pageId", "navGroup" ] } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "moved": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "moved" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}/config": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "expectedRevision": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 } }, "required": [ "config" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "origin": { "type": "string" }, "manifestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isEnabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "slug", "type", "title", "icon", "navGroup", "navOrder", "origin", "manifestId", "isEnabled", "revision", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}/duplicate": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 31, "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" }, "title": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": [ "slug", "title" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "slug": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navGroup": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "navOrder": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "origin": { "type": "string" }, "manifestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isEnabled": { "type": "boolean" }, "revision": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "slug", "type", "title", "icon", "navGroup", "navOrder", "origin", "manifestId", "isEnabled", "revision", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/search": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 2 }, "in": "query", "name": "q", "required": true }, { "schema": { "type": "string" }, "in": "query", "name": "types", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "connectionId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "tables", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 10 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "groups": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "page" ] }, "count": { "type": "number" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "pageId": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "icon": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "pageId", "slug", "title", "icon" ], "additionalProperties": false } } }, "required": [ "type", "count", "hits" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "record" ] }, "connectionId": { "type": "string" }, "table": { "type": "string" }, "pageSlug": { "type": "string" }, "count": { "type": "number" }, "partial": { "type": "boolean" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "connectionId": { "type": "string" }, "table": { "type": "string" }, "recordId": { "type": "string" }, "label": { "type": "string" }, "context": { "type": "string" }, "pageSlug": { "type": "string" } }, "required": [ "connectionId", "table", "recordId", "label", "pageSlug" ], "additionalProperties": false } } }, "required": [ "type", "connectionId", "table", "pageSlug", "count", "hits" ], "additionalProperties": false } ] } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/widget-data/query": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "descriptor": { "type": "object", "properties": { "kind": { "default": "table-query", "type": "string", "enum": [ "table-query" ] }, "connectionId": { "type": "string" }, "source": { "type": "object", "properties": { "schema": { "type": "string" }, "name": { "type": "string" }, "type": { "default": "table", "type": "string", "enum": [ "table", "view" ] } }, "required": [ "name" ] }, "shape": { "type": "string", "enum": [ "single-metric", "metric+delta", "timeseries", "multi-timeseries", "categorical", "record-list", "record", "matrix", "hierarchy/tree", "calendar-events", "geo-points", "flows", "ohlc", "distribution", "boolean-map", "stream", "form-state", "static" ] }, "select": { "type": "array", "items": { "type": "string" } }, "aggregations": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "fn": { "type": "string", "enum": [ "count", "sum", "avg", "min", "max", "count_distinct", "percentile" ] }, "column": { "type": "string" }, "p": { "type": "number", "minimum": 0, "maximum": 1 }, "alias": { "type": "string" } }, "required": [ "fn", "alias" ] } }, "groupBy": { "maxItems": 2, "type": "array", "items": { "type": "string" } }, "bucket": { "type": "object", "properties": { "column": { "type": "string" }, "unit": { "type": "string", "enum": [ "hour", "day", "week", "month", "quarter", "year" ] } }, "required": [ "column", "unit" ] }, "filters": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "op": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "in", "like", "ilike", "is_null", "not_null", "between" ] }, "value": {}, "param": { "type": "string" } }, "required": [ "column", "op" ] } }, "window": { "type": "object", "properties": { "column": { "type": "string" }, "last": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unit": { "type": "string", "enum": [ "hour", "day", "week", "month", "quarter", "year" ] }, "compareToPrior": { "default": false, "type": "boolean" } }, "required": [ "column", "last", "unit" ] }, "orderBy": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "dir": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "column", "dir" ] } }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000 }, "cursor": { "type": "string" } }, "required": [ "connectionId", "source", "shape" ] }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "descriptor" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": {}, "cached": { "type": "boolean" } }, "required": [ "result", "cached" ], "additionalProperties": false } } } } } } }, "/api/v1/widget-data/batch": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "minItems": 1, "maxItems": 40, "type": "array", "items": { "type": "object", "properties": { "instanceId": { "type": "string", "minLength": 1, "maxLength": 64 }, "descriptor": { "type": "object", "properties": { "kind": { "default": "table-query", "type": "string", "enum": [ "table-query" ] }, "connectionId": { "type": "string" }, "source": { "type": "object", "properties": { "schema": { "type": "string" }, "name": { "type": "string" }, "type": { "default": "table", "type": "string", "enum": [ "table", "view" ] } }, "required": [ "name" ] }, "shape": { "type": "string", "enum": [ "single-metric", "metric+delta", "timeseries", "multi-timeseries", "categorical", "record-list", "record", "matrix", "hierarchy/tree", "calendar-events", "geo-points", "flows", "ohlc", "distribution", "boolean-map", "stream", "form-state", "static" ] }, "select": { "type": "array", "items": { "type": "string" } }, "aggregations": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "fn": { "type": "string", "enum": [ "count", "sum", "avg", "min", "max", "count_distinct", "percentile" ] }, "column": { "type": "string" }, "p": { "type": "number", "minimum": 0, "maximum": 1 }, "alias": { "type": "string" } }, "required": [ "fn", "alias" ] } }, "groupBy": { "maxItems": 2, "type": "array", "items": { "type": "string" } }, "bucket": { "type": "object", "properties": { "column": { "type": "string" }, "unit": { "type": "string", "enum": [ "hour", "day", "week", "month", "quarter", "year" ] } }, "required": [ "column", "unit" ] }, "filters": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "op": { "type": "string", "enum": [ "eq", "neq", "gt", "gte", "lt", "lte", "in", "like", "ilike", "is_null", "not_null", "between" ] }, "value": {}, "param": { "type": "string" } }, "required": [ "column", "op" ] } }, "window": { "type": "object", "properties": { "column": { "type": "string" }, "last": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "unit": { "type": "string", "enum": [ "hour", "day", "week", "month", "quarter", "year" ] }, "compareToPrior": { "default": false, "type": "boolean" } }, "required": [ "column", "last", "unit" ] }, "orderBy": { "maxItems": 3, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string" }, "dir": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "column", "dir" ] } }, "limit": { "type": "integer", "minimum": 1, "maximum": 1000 }, "cursor": { "type": "string" } }, "required": [ "connectionId", "source", "shape" ] } }, "required": [ "instanceId", "descriptor" ] } }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "requests" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "results": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": {}, "cached": { "type": "boolean" } }, "required": [ "ok", "result", "cached" ], "additionalProperties": false }, { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ false ] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "statusCode": { "type": "number" } }, "required": [ "code", "message", "statusCode" ], "additionalProperties": false } }, "required": [ "ok", "error" ], "additionalProperties": false } ] } } }, "required": [ "results" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/defaults": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "adoption": { "type": "object", "properties": { "totalUsers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "following": { "type": "object", "properties": { "theme": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "accent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "density": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "locale": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "theme", "accent", "density", "locale" ], "additionalProperties": false } }, "required": [ "totalUsers", "following" ], "additionalProperties": false } }, "required": [ "theme", "accent", "density", "locale", "adoption" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" } }, "required": [ "theme", "accent", "density", "locale" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "theme": { "type": "string", "enum": [ "light", "dark", "system" ] }, "accent": { "type": "string", "enum": [ "indigo", "blue", "teal", "violet", "rose", "red", "orange", "black" ] }, "density": { "type": "string", "enum": [ "comfortable", "compact" ] }, "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "adoption": { "type": "object", "properties": { "totalUsers": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "following": { "type": "object", "properties": { "theme": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "accent": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "density": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "locale": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "theme", "accent", "density", "locale" ], "additionalProperties": false } }, "required": [ "totalUsers", "following" ], "additionalProperties": false } }, "required": [ "theme", "accent", "density", "locale", "adoption" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/workspace": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "appName": { "type": "string", "minLength": 1, "maxLength": 60 }, "showVersion": { "type": "boolean" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "appName", "showVersion", "logoUrl" ], "additionalProperties": false } }, "required": [ "branding" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/branding": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "appName": { "type": "string", "minLength": 1, "maxLength": 60 }, "showVersion": { "type": "boolean" } }, "required": [ "appName", "showVersion" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "appName": { "type": "string", "minLength": 1, "maxLength": 60 }, "showVersion": { "type": "boolean" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "appName", "showVersion", "logoUrl" ], "additionalProperties": false } }, "required": [ "branding" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/security": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sessionTtlHours": { "type": "integer", "minimum": 1, "maximum": 8760 }, "require2fa": { "type": "boolean" }, "passwordMinLength": { "type": "integer", "minimum": 8, "maximum": 128 } }, "required": [ "sessionTtlHours", "require2fa", "passwordMinLength" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionTtlHours": { "type": "integer", "minimum": 1, "maximum": 8760 }, "require2fa": { "type": "boolean" }, "passwordMinLength": { "type": "integer", "minimum": 8, "maximum": 128 } }, "required": [ "sessionTtlHours", "require2fa", "passwordMinLength" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "sessionTtlHours": { "type": "integer", "minimum": 1, "maximum": 8760 }, "require2fa": { "type": "boolean" }, "passwordMinLength": { "type": "integer", "minimum": 8, "maximum": 128 } }, "required": [ "sessionTtlHours", "require2fa", "passwordMinLength" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/telemetry": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "boolean" }, "updateCheck": { "type": "boolean" } }, "required": [ "telemetry", "updateCheck" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "telemetry": { "type": "boolean" }, "updateCheck": { "type": "boolean" } }, "required": [ "telemetry", "updateCheck" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "telemetry": { "type": "boolean" }, "updateCheck": { "type": "boolean" } }, "required": [ "telemetry", "updateCheck" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/settings/email": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "configured": { "type": "boolean" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "port": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secure": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "configured", "host", "port", "user", "from", "secure" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "smtp": { "anyOf": [ { "type": "object", "properties": { "host": { "type": "string", "minLength": 1, "maxLength": 255 }, "port": { "type": "integer", "minimum": 1, "maximum": 65535 }, "user": { "type": "string", "maxLength": 320 }, "pass": { "type": "string", "maxLength": 512 }, "from": { "type": "string", "minLength": 3, "maxLength": 320 }, "secure": { "type": "boolean" } }, "required": [ "host", "port", "user", "from", "secure" ] }, { "type": "null" } ] } }, "required": [ "smtp" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "configured": { "type": "boolean" }, "host": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "port": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secure": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "required": [ "configured", "host", "port", "user", "from", "secure" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/branding": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "appName": { "type": "string" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "showVersion": { "type": "boolean" } }, "required": [ "appName", "logoUrl", "showVersion" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/branding/logo": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "v", "required": false } ], "responses": { "200": { "description": "Default Response" } } }, "post": { "parameters": [ { "schema": { "default": "logo", "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "filename", "required": false } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "appName": { "type": "string" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "showVersion": { "type": "boolean" } }, "required": [ "appName", "logoUrl", "showVersion" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "delete": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "appName": { "type": "string" }, "logoUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "showVersion": { "type": "boolean" } }, "required": [ "appName", "logoUrl", "showVersion" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/manifest": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "number" }, "locales": { "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string" }, "tag": { "type": "string" }, "english": { "type": "string" }, "native": { "type": "string" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string" }, "pluralCategories": { "type": "array", "items": { "type": "string" } }, "builtin": { "type": "boolean" }, "enabled": { "type": "boolean" }, "sortOrder": { "type": "number" }, "overrideCount": { "type": "number" } }, "required": [ "locale", "tag", "english", "native", "dir", "fontHint", "intlTag", "pluralCategories", "builtin", "enabled", "sortOrder", "overrideCount" ], "additionalProperties": false } } }, "required": [ "version", "locales" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/bundle/{locale}/{namespace}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "path", "name": "locale", "required": true }, { "schema": { "type": "string", "enum": [ "common", "ui", "studio", "generated", "errors" ] }, "in": "path", "name": "namespace", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string" }, "namespace": { "type": "string" }, "version": { "type": "number" }, "overrides": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "required": [ "locale", "namespace", "version", "overrides" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/format-errors": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "lng": { "type": "string" }, "message": { "type": "string" }, "at": { "type": "number" }, "count": { "type": "number" } }, "required": [ "key", "lng", "message", "at", "count" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/keys": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "query", "name": "locale", "required": true }, { "schema": { "type": "string", "enum": [ "common", "ui", "studio", "generated", "errors" ] }, "in": "query", "name": "namespace", "required": false }, { "schema": { "type": "string", "maxLength": 60 }, "in": "query", "name": "group", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "q", "required": false }, { "schema": { "default": "all", "type": "string", "enum": [ "all", "overridden", "untranslated", "stale" ] }, "in": "query", "name": "state", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "namespace": { "type": "string" }, "key": { "type": "string" }, "source": { "type": "string" }, "builtin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "override": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stale": { "type": "boolean" }, "a11yCritical": { "type": "boolean" }, "updatedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "namespace", "key", "source", "builtin", "override", "stale", "a11yCritical", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "number" }, "groups": { "type": "array", "items": { "type": "object", "properties": { "group": { "type": "string" }, "count": { "type": "number" } }, "required": [ "group", "count" ], "additionalProperties": false } }, "version": { "type": "number" } }, "required": [ "items", "total", "groups", "version" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "namespace": { "type": "string", "enum": [ "common", "ui", "studio", "generated", "errors" ] }, "key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z0-9_]+(\\.[A-Za-z0-9_]+)*$" }, "value": { "type": "string", "maxLength": 4000 } }, "required": [ "locale", "namespace", "key", "value" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "row": { "anyOf": [ { "type": "object", "properties": { "namespace": { "type": "string" }, "key": { "type": "string" }, "source": { "type": "string" }, "builtin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "override": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stale": { "type": "boolean" }, "a11yCritical": { "type": "boolean" }, "updatedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "namespace", "key", "source", "builtin", "override", "stale", "a11yCritical", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "version", "row" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "query", "name": "locale", "required": true }, { "schema": { "type": "string", "enum": [ "common", "ui", "studio", "generated", "errors" ] }, "in": "query", "name": "namespace", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z0-9_]+(\\.[A-Za-z0-9_]+)*$" }, "in": "query", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "row": { "anyOf": [ { "type": "object", "properties": { "namespace": { "type": "string" }, "key": { "type": "string" }, "source": { "type": "string" }, "builtin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "override": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "stale": { "type": "boolean" }, "a11yCritical": { "type": "boolean" }, "updatedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "required": [ "namespace", "key", "source", "builtin", "override", "stale", "a11yCritical", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "version", "row" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/keys/bulk": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "namespace": { "type": "string", "enum": [ "common", "ui", "studio", "generated", "errors" ] }, "key": { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[A-Za-z0-9_]+(\\.[A-Za-z0-9_]+)*$" }, "value": { "type": "string", "maxLength": 4000 } }, "required": [ "locale", "namespace", "key", "value" ] } } }, "required": [ "items" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "written": { "type": "number" }, "rejected": { "type": "array", "items": { "type": "object", "properties": { "namespace": { "type": "string" }, "key": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "namespace", "key", "reason" ], "additionalProperties": false } } }, "required": [ "ok", "version", "written", "rejected" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/export/{locale}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "formatVersion": { "type": "number", "enum": [ 1 ] }, "locale": { "type": "string" }, "exportedKeys": { "type": "number" }, "entries": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } } }, "required": [ "formatVersion", "locale", "exportedKeys", "entries" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/import/{locale}": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "formatVersion": { "type": "number", "enum": [ 1 ] }, "locale": { "type": "string" }, "exportedKeys": { "type": "number" }, "entries": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } } }, "required": [ "formatVersion", "entries" ] } } } }, "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "includeSensitive", "required": false }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "written": { "type": "number" }, "rejected": { "type": "array", "items": { "type": "object", "properties": { "namespace": { "type": "string" }, "key": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "namespace", "key", "reason" ], "additionalProperties": false } }, "sensitiveCount": { "type": "number" } }, "required": [ "ok", "version", "written", "rejected", "sensitiveCount" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/locales": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "number" }, "locales": { "type": "array", "items": { "type": "object", "properties": { "locale": { "type": "string" }, "tag": { "type": "string" }, "english": { "type": "string" }, "native": { "type": "string" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string" }, "pluralCategories": { "type": "array", "items": { "type": "string" } }, "builtin": { "type": "boolean" }, "enabled": { "type": "boolean" }, "sortOrder": { "type": "number" }, "overrideCount": { "type": "number" } }, "required": [ "locale", "tag", "english", "native", "dir", "fontHint", "intlTag", "pluralCategories", "builtin", "enabled", "sortOrder", "overrideCount" ], "additionalProperties": false } } }, "required": [ "version", "locales" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "locale": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "english": { "type": "string", "minLength": 1, "maxLength": 80 }, "native": { "type": "string", "minLength": 1, "maxLength": 80 }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string", "minLength": 2, "maxLength": 35 }, "enabled": { "default": true, "type": "boolean" }, "sortOrder": { "default": 0, "type": "integer", "minimum": 0, "maximum": 999 }, "copyFrom": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" } }, "required": [ "locale", "english", "native", "dir", "fontHint", "intlTag" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "locale": { "anyOf": [ { "type": "object", "properties": { "locale": { "type": "string" }, "tag": { "type": "string" }, "english": { "type": "string" }, "native": { "type": "string" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string" }, "pluralCategories": { "type": "array", "items": { "type": "string" } }, "builtin": { "type": "boolean" }, "enabled": { "type": "boolean" }, "sortOrder": { "type": "number" }, "overrideCount": { "type": "number" } }, "required": [ "locale", "tag", "english", "native", "dir", "fontHint", "intlTag", "pluralCategories", "builtin", "enabled", "sortOrder", "overrideCount" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "version", "locale" ], "additionalProperties": false } } } } } } }, "/api/v1/i18n/locales/{locale}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "sortOrder": { "type": "integer", "minimum": 0, "maximum": 999 }, "english": { "type": "string", "minLength": 1, "maxLength": 80 }, "native": { "type": "string", "minLength": 1, "maxLength": 80 }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string", "minLength": 2, "maxLength": 35 } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "locale": { "anyOf": [ { "type": "object", "properties": { "locale": { "type": "string" }, "tag": { "type": "string" }, "english": { "type": "string" }, "native": { "type": "string" }, "dir": { "type": "string", "enum": [ "ltr", "rtl" ] }, "fontHint": { "type": "string", "enum": [ "latin", "arabic", "cjk" ] }, "intlTag": { "type": "string" }, "pluralCategories": { "type": "array", "items": { "type": "string" } }, "builtin": { "type": "boolean" }, "enabled": { "type": "boolean" }, "sortOrder": { "type": "number" }, "overrideCount": { "type": "number" } }, "required": [ "locale", "tag", "english", "native", "dir", "fontHint", "intlTag", "pluralCategories", "builtin", "enabled", "sortOrder", "overrideCount" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "version", "locale" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "default": "inherit", "anyOf": [ { "type": "string", "enum": [ "inherit" ] }, { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" } ] }, "in": "query", "name": "reassignTo", "required": false }, { "schema": { "type": "string", "minLength": 2, "maxLength": 35, "pattern": "^[a-z]{2,3}(_[A-Za-z0-9]{2,8}){0,2}$" }, "in": "path", "name": "locale", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "version": { "type": "number" }, "reassignedUsers": { "type": "number" }, "deletedOverrides": { "type": "number" }, "deletedEmailTemplates": { "type": "number" }, "workspaceDefaultReset": { "type": "boolean" } }, "required": [ "ok", "version", "reassignedUsers", "deletedOverrides", "deletedEmailTemplates", "workspaceDefaultReset" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}/views": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "views": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "config": {}, "isDefault": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "userId", "name", "config", "isDefault", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "views" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "config": { "type": "object", "properties": { "v": { "type": "number", "enum": [ 1 ] }, "search": { "type": "string", "maxLength": 500 }, "sort": { "anyOf": [ { "type": "object", "properties": { "column": { "type": "string", "minLength": 1 }, "dir": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "column", "dir" ] }, { "type": "null" } ] }, "filters": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string", "minLength": 1 }, "op": { "type": "string", "minLength": 1 }, "value": {} }, "required": [ "column", "op" ], "additionalProperties": {} } }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 500 }, "columns": { "maxItems": 200, "type": "array", "items": { "type": "string" } } }, "required": [ "v" ], "additionalProperties": {} }, "isDefault": { "type": "boolean" } }, "required": [ "name", "config" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "config": {}, "isDefault": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "userId", "name", "config", "isDefault", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/pages/{pageId}/views/{viewId}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "config": { "type": "object", "properties": { "v": { "type": "number", "enum": [ 1 ] }, "search": { "type": "string", "maxLength": 500 }, "sort": { "anyOf": [ { "type": "object", "properties": { "column": { "type": "string", "minLength": 1 }, "dir": { "type": "string", "enum": [ "asc", "desc" ] } }, "required": [ "column", "dir" ] }, { "type": "null" } ] }, "filters": { "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "column": { "type": "string", "minLength": 1 }, "op": { "type": "string", "minLength": 1 }, "value": {} }, "required": [ "column", "op" ], "additionalProperties": {} } }, "pageSize": { "type": "integer", "exclusiveMinimum": 0, "maximum": 500 }, "columns": { "maxItems": 200, "type": "array", "items": { "type": "string" } } }, "required": [ "v" ], "additionalProperties": {} }, "isDefault": { "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "viewId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "pageId": { "type": "string" }, "userId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "config": {}, "isDefault": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "pageId", "userId", "name", "config", "isDefault", "createdAt", "updatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "viewId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/me/views/{pageId}/layout": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "items": { "maxItems": 60, "type": "array", "items": { "type": "object", "properties": { "i": { "type": "string" }, "widget": { "type": "string" }, "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "w": { "type": "integer", "minimum": 1, "maximum": 12 }, "h": { "type": "integer", "minimum": 1, "maximum": 24 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "i", "widget", "x", "y", "w", "h", "config" ] } } }, "required": [ "version", "items" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "layout": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "items": { "maxItems": 60, "type": "array", "items": { "type": "object", "properties": { "i": { "type": "string" }, "widget": { "type": "string" }, "x": { "type": "integer", "minimum": 0, "maximum": 11 }, "y": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "w": { "type": "integer", "minimum": 1, "maximum": 12 }, "h": { "type": "integer", "minimum": 1, "maximum": 24 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "i", "widget", "x", "y", "w", "h", "config" ], "additionalProperties": false } } }, "required": [ "version", "items" ], "additionalProperties": false } }, "required": [ "layout" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "pageId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/onboarding": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checklist": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "key", "done" ], "additionalProperties": false } }, "doneCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "complete": { "type": "boolean" } }, "required": [ "steps", "doneCount", "totalCount", "complete" ], "additionalProperties": false }, "dismissed": { "type": "boolean" } }, "required": [ "checklist", "dismissed" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/onboarding/dismiss": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dismissed": { "default": true, "type": "boolean" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "checklist": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "done": { "type": "boolean" } }, "required": [ "key", "done" ], "additionalProperties": false } }, "doneCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "totalCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "complete": { "type": "boolean" } }, "required": [ "steps", "doneCount", "totalCount", "complete" ], "additionalProperties": false }, "dismissed": { "type": "boolean" } }, "required": [ "checklist", "dismissed" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } } } } }, "/api/v1/public-api": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "registered": { "type": "boolean" }, "origins": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "registered", "origins" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "registered": { "type": "boolean" }, "origins": { "type": "array", "items": { "type": "string" } } }, "required": [ "enabled", "registered", "origins" ], "additionalProperties": false } } } } } } }, "/api/v1/public-scopes": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "name": { "type": "string" }, "timezone": { "type": "string" }, "document": { "type": "string" }, "proposedFromManifest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "keyCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "side", "name", "timezone", "document", "proposedFromManifest", "createdBy", "createdAt", "updatedAt", "keyCount" ], "additionalProperties": false } } }, "required": [ "scopes" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1 }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "document": { "type": "string", "minLength": 2, "maxLength": 256000 } }, "required": [ "connectionId", "side", "name", "document" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "name": { "type": "string" }, "timezone": { "type": "string" }, "document": { "type": "string" }, "proposedFromManifest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "keyCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "side", "name", "timezone", "document", "proposedFromManifest", "createdBy", "createdAt", "updatedAt", "keyCount" ], "additionalProperties": false } } }, "required": [ "scopes" ], "additionalProperties": false } } } } } } }, "/api/v1/public-scopes/{id}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "document": { "type": "string", "minLength": 2, "maxLength": 256000 } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scopes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "name": { "type": "string" }, "timezone": { "type": "string" }, "document": { "type": "string" }, "proposedFromManifest": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "keyCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "connectionId", "side", "name", "timezone", "document", "proposedFromManifest", "createdBy", "createdAt", "updatedAt", "keyCount" ], "additionalProperties": false } } }, "required": [ "scopes" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/public-keys": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopeId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "appKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origins": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "prefix", "scopeId", "side", "appKey", "origins", "expiresAt", "revokedAt", "lastUsedAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false } } }, "required": [ "keys" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "scopeId": { "type": "string", "minLength": 1 }, "appKey": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[a-z0-9][a-z0-9_-]*$" }, "origins": { "maxItems": 32, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 256 } }, "expiresAt": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "scopeId" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopeId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "appKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origins": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "prefix", "scopeId", "side", "appKey", "origins", "expiresAt", "revokedAt", "lastUsedAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false }, "token": { "type": "string" } }, "required": [ "key", "token" ], "additionalProperties": false } } } } } } }, "/api/v1/public-keys/{id}/reveal": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } }, "required": [ "token" ], "additionalProperties": false } } } } } } }, "/api/v1/public-keys/{id}/rotate": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopeId": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "appKey": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origins": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "name", "prefix", "scopeId", "side", "appKey", "origins", "expiresAt", "revokedAt", "lastUsedAt", "createdBy", "createdAt", "updatedAt" ], "additionalProperties": false }, "token": { "type": "string" } }, "required": [ "key", "token" ], "additionalProperties": false } } } } } } }, "/api/v1/public-keys/{id}": { "delete": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/surfaces": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "surfaces": { "type": "array", "items": { "type": "object", "properties": { "appKey": { "type": "string" }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "prefix": { "type": "string" }, "navAvailable": { "type": "boolean" }, "navItems": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "staffPlacement": { "anyOf": [ { "type": "string", "enum": [ "internal", "external" ] }, { "type": "null" } ] }, "boundKey": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" } }, "required": [ "id", "name", "prefix" ], "additionalProperties": false }, { "type": "null" } ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domains": { "type": "array", "items": { "type": "string" } } }, "required": [ "appKey", "side", "prefix", "navAvailable", "navItems", "staffPlacement", "boundKey", "connectionId", "domains" ], "additionalProperties": false } }, "domains": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "appKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "instance": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "appKey", "side" ], "additionalProperties": false } }, "instances": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "connectionId": { "type": "string" } }, "required": [ "slug", "connectionId" ], "additionalProperties": false } } } }, "required": [ "surfaces", "domains", "instances" ], "additionalProperties": false } } } } } } }, "/api/v1/surfaces/{appKey}/placement": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "staff": { "type": "string", "enum": [ "internal", "external" ] } }, "required": [ "staff" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "appKey", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "appKey": { "type": "string" }, "staff": { "type": "string", "enum": [ "internal", "external" ] } }, "required": [ "appKey", "staff" ], "additionalProperties": false } } } } } } }, "/api/v1/surfaces/{appKey}/connection": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "connectionId" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "appKey", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "appKey": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "appKey", "connectionId" ], "additionalProperties": false } } } } } } }, "/api/v1/surfaces/instances": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "instances": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64 }, "additionalProperties": { "maxItems": 32, "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string", "minLength": 1, "maxLength": 32 }, "connectionId": { "type": "string", "minLength": 1 } }, "required": [ "slug", "connectionId" ] } } } }, "required": [ "instances" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "instances": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "object", "properties": { "slug": { "type": "string" }, "connectionId": { "type": "string" } }, "required": [ "slug", "connectionId" ], "additionalProperties": false } } } }, "required": [ "instances" ], "additionalProperties": false } } } } } } }, "/api/v1/surfaces/domains": { "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 255 }, "additionalProperties": { "type": "object", "properties": { "appKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "instance": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "appKey", "side" ] } } }, "required": [ "domains" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "appKey": { "type": "string", "minLength": 1, "maxLength": 64 }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "instance": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "appKey", "side" ], "additionalProperties": false } } }, "required": [ "domains" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/catalog": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "source": { "type": "string", "enum": [ "bundled", "catalog" ] }, "state": { "type": "string", "enum": [ "installed", "staged", "available" ] }, "upgradeTo": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "key", "name", "version", "source", "state", "upgradeTo" ], "additionalProperties": false } }, "catalogFetchedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "onlineEnabled": { "type": "boolean" } }, "required": [ "addOns", "catalogFetchedAt", "onlineEnabled" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "onlineEnabled": { "type": "boolean" }, "vetoed": { "type": "boolean" } }, "required": [ "onlineEnabled", "vetoed" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/catalog/refresh": { "post": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } }, "required": [ "jobId" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/download": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string", "minLength": 1, "maxLength": 64 } }, "required": [ "key", "version" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } }, "required": [ "jobId" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/upload": { "post": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "query", "name": "key", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "version", "required": true }, { "schema": { "type": "string", "pattern": "^sha512-[A-Za-z0-9+/]+={0,2}$" }, "in": "query", "name": "expectedSha512", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string" }, "files": { "type": "number" }, "integrity": { "type": "string" } }, "required": [ "key", "version", "files", "integrity" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/staged/{key}/{version}": { "delete": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "version", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string" }, "discarded": { "type": "boolean" } }, "required": [ "key", "version", "discarded" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}/upgrade": { "post": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOn": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false }, "from": { "type": "string" }, "to": { "type": "string" }, "pruned": { "type": "array", "items": { "type": "string" } } }, "required": [ "addOn", "from", "to", "pruned" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false } } }, "required": [ "addOns" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string", "minLength": 1, "maxLength": 64 }, "attachTo": { "default": [], "type": "array", "items": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" } } }, "required": [ "key", "version" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOn": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false }, "plan": { "type": "object", "properties": { "addOnKey": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string" }, "installable": { "type": "boolean" }, "touchesData": { "type": "boolean" }, "create": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "type": { "type": "string" } }, "required": [ "ref", "type" ], "additionalProperties": false } } }, "required": [ "ref", "columns" ], "additionalProperties": false } }, "reuse": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "missingColumns": { "type": "array", "items": { "type": "string" } } }, "required": [ "ref", "missingColumns" ], "additionalProperties": false } }, "references": { "type": "array", "items": { "type": "object", "properties": { "fromTable": { "type": "string" }, "fromColumn": { "type": "string" }, "to": { "type": "string" }, "resolution": { "type": "string", "enum": [ "internal", "host", "unresolved" ] } }, "required": [ "fromTable", "fromColumn", "to", "resolution" ], "additionalProperties": false } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "table": { "type": "string" }, "column": { "type": "string" } }, "required": [ "code", "message", "table" ], "additionalProperties": false } }, "requiresSchemaChange": { "type": "boolean" } }, "required": [ "addOnKey", "version", "installable", "touchesData", "create", "reuse", "references", "problems", "requiresSchemaChange" ], "additionalProperties": false } }, "required": [ "addOn", "plan" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}/plan": { "get": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "plan": { "type": "object", "properties": { "addOnKey": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "version": { "type": "string" }, "installable": { "type": "boolean" }, "touchesData": { "type": "boolean" }, "create": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "type": { "type": "string" } }, "required": [ "ref", "type" ], "additionalProperties": false } } }, "required": [ "ref", "columns" ], "additionalProperties": false } }, "reuse": { "type": "array", "items": { "type": "object", "properties": { "ref": { "type": "string" }, "missingColumns": { "type": "array", "items": { "type": "string" } } }, "required": [ "ref", "missingColumns" ], "additionalProperties": false } }, "references": { "type": "array", "items": { "type": "object", "properties": { "fromTable": { "type": "string" }, "fromColumn": { "type": "string" }, "to": { "type": "string" }, "resolution": { "type": "string", "enum": [ "internal", "host", "unresolved" ] } }, "required": [ "fromTable", "fromColumn", "to", "resolution" ], "additionalProperties": false } }, "problems": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "table": { "type": "string" }, "column": { "type": "string" } }, "required": [ "code", "message", "table" ], "additionalProperties": false } }, "requiresSchemaChange": { "type": "boolean" } }, "required": [ "addOnKey", "version", "installable", "touchesData", "create", "reuse", "references", "problems", "requiresSchemaChange" ], "additionalProperties": false } }, "required": [ "plan" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}/bundle/{*}": { "get": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "path", "name": "*", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/api/v1/add-ons/{key}/connect": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "credentials": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[a-z][a-z0-9_]*$" }, "additionalProperties": { "type": "string", "minLength": 1, "maxLength": 4096 } } }, "required": [ "credentials" ] } } } }, "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOn": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false } }, "required": [ "addOn" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "credentialsDeleted": { "type": "boolean" }, "tablesKept": { "type": "boolean" } }, "required": [ "key", "credentialsDeleted", "tablesKept" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}/connect/oauth/start": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "clientId": { "type": "string", "minLength": 1, "maxLength": 512 }, "clientSecret": { "type": "string", "minLength": 1, "maxLength": 4096 }, "redirectUri": { "type": "string", "maxLength": 2048, "format": "uri" } }, "required": [ "clientId", "clientSecret", "redirectUri" ] } } } }, "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "authorizeUrl": { "type": "string" }, "state": { "type": "string" } }, "required": [ "authorizeUrl", "state" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}/connect/oauth/complete": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "minLength": 1, "maxLength": 512 }, "code": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "required": [ "state", "code" ] } } } }, "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOn": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false } }, "required": [ "addOn" ], "additionalProperties": false } } } } } } }, "/api/v1/add-ons/{key}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ] } } } }, "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "addOn": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "name": { "type": "string" }, "version": { "type": "string" }, "connectKind": { "type": "string", "enum": [ "none", "api-key", "oauth2" ] }, "connected": { "type": "boolean" }, "connectionExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "attachedTo": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "enabled": { "type": "boolean" } }, "required": [ "attachedTo", "enabled" ], "additionalProperties": false } }, "slots": { "type": "array", "items": { "type": "object", "properties": { "slot": { "type": "string" }, "client": { "type": "string" }, "order": { "type": "number" } }, "required": [ "slot", "client", "order" ], "additionalProperties": false } }, "provides": { "type": "array", "items": { "type": "object", "properties": { "contract": { "type": "string" }, "version": { "type": "number" } }, "required": [ "contract", "version" ], "additionalProperties": false } }, "networkAllow": { "type": "array", "items": { "type": "string" } }, "bundles": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "url": { "type": "string" }, "integrity": { "type": "string", "pattern": "^sha256-[A-Za-z0-9+/]+={0,2}$" } }, "required": [ "path", "url", "integrity" ], "additionalProperties": false } } }, "required": [ "key", "name", "version", "connectKind", "connected", "connectionExpiresAt", "attachments", "slots", "provides", "networkAllow", "bundles" ], "additionalProperties": false } }, "required": [ "addOn" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "in": "path", "name": "key", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "pattern": "^[a-z][a-z0-9-]{1,79}$" }, "tablesKept": { "type": "boolean" }, "packageRemoved": { "type": "boolean" } }, "required": [ "key", "tablesKept", "packageRemoved" ], "additionalProperties": false } } } } } } }, "/api/v1/roles": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isBuiltin": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "memberCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "slug", "name", "description", "isBuiltin", "createdAt", "updatedAt", "memberCount" ], "additionalProperties": false } } }, "required": [ "roles" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "cloneFromRoleId": { "type": "string" } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isBuiltin": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "slug", "name", "description", "isBuiltin", "createdAt", "updatedAt" ], "additionalProperties": false } } } } } } }, "/api/v1/roles/{id}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "description": { "anyOf": [ { "type": "string", "maxLength": 2000 }, { "type": "null" } ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isBuiltin": { "type": "boolean" }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" } }, "required": [ "id", "slug", "name", "description", "isBuiltin", "createdAt", "updatedAt" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "reassignTo", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/roles/{id}/permissions": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "roleId": { "type": "string" }, "grants": { "type": "array", "items": { "type": "string" } } }, "required": [ "roleId", "grants" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "grants": { "maxItems": 2000, "type": "array", "items": { "type": "string" } } }, "required": [ "grants" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "roleId": { "type": "string" }, "grants": { "type": "array", "items": { "type": "string" } } }, "required": [ "roleId", "grants" ], "additionalProperties": false } } } } } } }, "/api/v1/users/{id}/roles": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roleId": { "type": "string" } }, "required": [ "roleId" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "roleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "roleIds" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "roleIds": { "maxItems": 20, "type": "array", "items": { "type": "string" } } }, "required": [ "roleIds" ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false } } } } } } }, "/api/v1/users/{id}/roles/{roleId}": { "delete": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "roleId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userId": { "type": "string" }, "roleIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "userId", "roleIds" ], "additionalProperties": false } } } } } } }, "/api/v1/users": { "get": { "parameters": [ { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "roleId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "users": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "counts": { "type": "object", "properties": { "active": { "type": "number" }, "invited": { "type": "number" }, "suspended": { "type": "number" } }, "required": [ "active", "invited", "suspended" ], "additionalProperties": false } }, "required": [ "users", "nextCursor", "counts" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "minLength": 3, "maxLength": 320 }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "roleIds": { "maxItems": 20, "type": "array", "items": { "type": "string" } } }, "required": [ "email", "name" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false }, "invite": { "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "number" }, "activationPath": { "type": "string" } }, "required": [ "token", "expiresAt", "activationPath" ], "additionalProperties": false }, "emailSent": { "type": "boolean" } }, "required": [ "user", "invite", "emailSent" ], "additionalProperties": false } } } } } } }, "/api/v1/users/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false } } } } } }, "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "minLength": 3, "maxLength": 320 }, "status": { "type": "string", "enum": [ "active", "suspended" ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false } } } } } }, "delete": { "parameters": [ { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "permanent", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "permanent": { "type": "boolean" }, "user": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "permanent", "user" ], "additionalProperties": false } } } } } } }, "/api/v1/users/{id}/invite/resend": { "post": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "invited", "suspended" ] }, "totpEnabled": { "type": "boolean" }, "lastLoginAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "updatedAt": { "type": "number" }, "roles": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "slug", "name" ], "additionalProperties": false } } }, "required": [ "id", "email", "name", "status", "totpEnabled", "lastLoginAt", "createdAt", "updatedAt", "roles" ], "additionalProperties": false }, "invite": { "type": "object", "properties": { "token": { "type": "string" }, "expiresAt": { "type": "number" }, "activationPath": { "type": "string" } }, "required": [ "token", "expiresAt", "activationPath" ], "additionalProperties": false }, "emailSent": { "type": "boolean" } }, "required": [ "user", "invite", "emailSent" ], "additionalProperties": false } } } } } } }, "/api/v1/permissions/catalog": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "system": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "category": { "type": "string", "enum": [ "access", "data", "workspace", "operations" ] } }, "required": [ "key", "label", "category" ], "additionalProperties": false } }, "tableActions": { "type": "array", "items": { "type": "string" } }, "pageActions": { "type": "array", "items": { "type": "string" } } }, "required": [ "system", "tableActions", "pageActions" ], "additionalProperties": false } } } } } } }, "/api/v1/api-keys": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "roleId": { "type": "string" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "name", "prefix", "roleId", "createdBy", "lastUsedAt", "expiresAt", "revokedAt", "createdAt" ], "additionalProperties": false } } }, "required": [ "apiKeys" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "roleId": { "type": "string" }, "expiresAt": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "roleId" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "apiKey": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "roleId": { "type": "string" }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "name", "prefix", "roleId", "createdBy", "lastUsedAt", "expiresAt", "revokedAt", "createdAt" ], "additionalProperties": false }, "key": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } } }, "required": [ "apiKey", "key", "scopes" ], "additionalProperties": false } } } } } } }, "/api/v1/api-keys/{id}": { "delete": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] } }, "required": [ "ok" ], "additionalProperties": false } } } } } } }, "/api/v1/audit": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "actorId", "required": false }, { "schema": { "type": "string", "enum": [ "auth", "data", "schema", "settings", "rbac", "connection", "llm", "automation", "export", "system", "add-on" ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string", "maxLength": 80 }, "in": "query", "name": "resource", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "connectionId", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "entityTable", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "query", "name": "entityId", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "actorKind": { "type": "string", "enum": [ "user", "api-key", "system", "automation" ] }, "actorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorLabel": { "type": "string" }, "category": { "type": "string", "enum": [ "auth", "data", "schema", "settings", "rbac", "connection", "llm", "automation", "export", "system", "add-on" ] }, "action": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "entity": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "changes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userAgent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "createdAt", "actorKind", "actorId", "actorLabel", "category", "action", "connectionId", "entity", "changes", "ip", "userAgent", "requestId" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "entries", "nextCursor" ], "additionalProperties": false } } } } } } }, "/api/v1/audit/{id}": { "get": { "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "number" }, "actorKind": { "type": "string", "enum": [ "user", "api-key", "system", "automation" ] }, "actorId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "actorLabel": { "type": "string" }, "category": { "type": "string", "enum": [ "auth", "data", "schema", "settings", "rbac", "connection", "llm", "automation", "export", "system", "add-on" ] }, "action": { "type": "string" }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "entity": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "changes": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] }, "ip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "userAgent": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "requestId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "createdAt", "actorKind", "actorId", "actorLabel", "category", "action", "connectionId", "entity", "changes", "ip", "userAgent", "requestId" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/config": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "anyOf": [ { "type": "string", "enum": [ "anthropic", "openai", "openai-compatible", "ollama", "adminium-managed" ] }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "baseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "apiKeySet": { "type": "boolean" }, "apiKeyLast4": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "provider", "model", "baseUrl", "maxOutputTokens", "apiKeySet", "apiKeyLast4" ], "additionalProperties": false } } } } } }, "put": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "anyOf": [ { "type": "string", "enum": [ "anthropic", "openai", "openai-compatible", "ollama", "adminium-managed" ] }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 200 }, { "type": "null" } ] }, "baseUrl": { "anyOf": [ { "type": "string", "maxLength": 500, "format": "uri" }, { "type": "null" } ] }, "apiKey": { "type": "string", "maxLength": 500 }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "minimum": 256, "maximum": 200000 }, { "type": "null" } ] } }, "required": [ "provider" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "anyOf": [ { "type": "string", "enum": [ "anthropic", "openai", "openai-compatible", "ollama", "adminium-managed" ] }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "baseUrl": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "maxOutputTokens": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, { "type": "null" } ] }, "apiKeySet": { "type": "boolean" }, "apiKeyLast4": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "provider", "model", "baseUrl", "maxOutputTokens", "apiKeySet", "apiKeyLast4" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/config/test": { "post": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latencyMs": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "ok", "model", "latencyMs", "error" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/models": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "models": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" } }, "required": [ "id", "label" ], "additionalProperties": false } }, "source": { "type": "string", "enum": [ "live", "static" ] } }, "required": [ "models", "source" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string", "minLength": 1 }, "path": { "type": "string", "enum": [ "provider", "byo" ] }, "sections": { "type": "array", "items": { "type": "string", "enum": [ "labels", "groups", "enums", "relations", "keys", "templates", "widgets", "pii", "icons", "microcopy" ] } }, "locales": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "en_US", "de_DE", "ar_EG", "zh_CN", "zh_TW", "cs_CZ", "da_DK", "fr_FR" ] } }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ] }, { "type": "null" } ] } }, "required": [ "connectionId", "path" ] } } } }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "mode": { "type": "string", "enum": [ "provider", "byo" ] }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "promptVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "running", "awaiting_response", "validated", "applied", "partially_applied", "failed", "discarded" ] }, "validationStatus": { "type": "string", "enum": [ "pending", "valid", "partial", "invalid" ] }, "sections": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locales": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ], "additionalProperties": false }, { "type": "null" } ] }, "chunksTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunksReceived": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "tokensIn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tokensOut": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "appliedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "appliedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "connectionId", "snapshotId", "mode", "provider", "model", "promptVersion", "status", "validationStatus", "sections", "locales", "sampling", "chunksTotal", "chunksReceived", "tokensIn", "tokensOut", "durationMs", "appliedBy", "appliedAt", "createdBy", "createdAt" ], "additionalProperties": false }, "prompt": { "type": "object", "properties": { "promptVersion": { "type": "string" }, "tokenEstimate": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunks": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "byo": { "type": "string" } }, "required": [ "index", "total", "byo" ], "additionalProperties": false } } }, "required": [ "promptVersion", "tokenEstimate", "chunks" ], "additionalProperties": false } }, "required": [ "run", "prompt" ], "additionalProperties": false } } } } } }, "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "mode": { "type": "string", "enum": [ "provider", "byo" ] }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "promptVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "running", "awaiting_response", "validated", "applied", "partially_applied", "failed", "discarded" ] }, "validationStatus": { "type": "string", "enum": [ "pending", "valid", "partial", "invalid" ] }, "sections": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locales": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ], "additionalProperties": false }, { "type": "null" } ] }, "chunksTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunksReceived": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "tokensIn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tokensOut": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "appliedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "appliedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "connectionId", "snapshotId", "mode", "provider", "model", "promptVersion", "status", "validationStatus", "sections", "locales", "sampling", "chunksTotal", "chunksReceived", "tokensIn", "tokensOut", "durationMs", "appliedBy", "appliedAt", "createdBy", "createdAt" ], "additionalProperties": false } } }, "required": [ "runs" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/execute": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "202": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } }, "required": [ "jobId" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/response": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chunkIndex": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "text": { "type": "string", "minLength": 1, "maxLength": 4000000 } }, "required": [ "text" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "mode": { "type": "string", "enum": [ "provider", "byo" ] }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "promptVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "running", "awaiting_response", "validated", "applied", "partially_applied", "failed", "discarded" ] }, "validationStatus": { "type": "string", "enum": [ "pending", "valid", "partial", "invalid" ] }, "sections": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locales": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ], "additionalProperties": false }, { "type": "null" } ] }, "chunksTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunksReceived": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "tokensIn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tokensOut": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "appliedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "appliedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "validationErrors": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "fatal", "item", "warning" ] }, "path": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "suggestionId": { "type": "string" } }, "required": [ "code", "severity", "path", "message" ], "additionalProperties": false } }, { "type": "null" } ] }, "review": { "anyOf": [ { "type": "object", "properties": { "accepted": { "type": "array", "items": { "type": "string" } }, "rejected": { "type": "array", "items": { "type": "string" } } }, "required": [ "accepted", "rejected" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "snapshotId", "mode", "provider", "model", "promptVersion", "status", "validationStatus", "sections", "locales", "sampling", "chunksTotal", "chunksReceived", "tokensIn", "tokensOut", "durationMs", "appliedBy", "appliedAt", "createdBy", "createdAt", "validationErrors", "review" ], "additionalProperties": false }, "validation": { "type": "object", "properties": { "ok": { "type": "boolean" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "fatal", "item", "warning" ] }, "path": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "suggestionId": { "type": "string" } }, "required": [ "code", "severity", "path", "message" ], "additionalProperties": false } }, "warnings": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "fatal", "item", "warning" ] }, "path": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "suggestionId": { "type": "string" } }, "required": [ "code", "severity", "path", "message" ], "additionalProperties": false } } }, "required": [ "ok", "errors", "warnings" ], "additionalProperties": false } }, "required": [ "run", "validation" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "mode": { "type": "string", "enum": [ "provider", "byo" ] }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "promptVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "running", "awaiting_response", "validated", "applied", "partially_applied", "failed", "discarded" ] }, "validationStatus": { "type": "string", "enum": [ "pending", "valid", "partial", "invalid" ] }, "sections": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locales": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ], "additionalProperties": false }, { "type": "null" } ] }, "chunksTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunksReceived": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "tokensIn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tokensOut": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "appliedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "appliedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" }, "validationErrors": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "severity": { "type": "string", "enum": [ "fatal", "item", "warning" ] }, "path": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "suggestionId": { "type": "string" } }, "required": [ "code", "severity", "path", "message" ], "additionalProperties": false } }, { "type": "null" } ] }, "review": { "anyOf": [ { "type": "object", "properties": { "accepted": { "type": "array", "items": { "type": "string" } }, "rejected": { "type": "array", "items": { "type": "string" } } }, "required": [ "accepted", "rejected" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "id", "connectionId", "snapshotId", "mode", "provider", "model", "promptVersion", "status", "validationStatus", "sections", "locales", "sampling", "chunksTotal", "chunksReceived", "tokensIn", "tokensOut", "durationMs", "appliedBy", "appliedAt", "createdBy", "createdAt", "validationErrors", "review" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/prompt": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "promptVersion": { "type": "string" }, "chunks": { "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "byo": { "type": "string" } }, "required": [ "index", "total", "byo" ], "additionalProperties": false } } }, "required": [ "promptVersion", "chunks" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/diff": { "get": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "diff": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "category": { "type": "string" }, "table": { "type": "string" }, "status": { "type": "string", "enum": [ "agree", "conflict", "llm-new", "heuristic-only", "rejects-heuristic", "user-locked" ] }, "llmValue": {}, "heuristicValue": {}, "currentValue": {}, "confidence": { "type": "number" }, "reason": { "type": "string" } }, "required": [ "id", "category", "status", "llmValue", "heuristicValue", "confidence" ], "additionalProperties": false } } }, "required": [ "diff" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/apply": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accepted": { "type": "array", "items": { "type": "string" } } }, "required": [ "accepted" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string" }, "connectionId": { "type": "string" }, "snapshotId": { "type": "string" }, "mode": { "type": "string", "enum": [ "provider", "byo" ] }, "provider": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "model": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "promptVersion": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "running", "awaiting_response", "validated", "applied", "partially_applied", "failed", "discarded" ] }, "validationStatus": { "type": "string", "enum": [ "pending", "valid", "partial", "invalid" ] }, "sections": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "locales": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "sampling": { "anyOf": [ { "type": "object", "properties": { "maxValuesPerColumn": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "maxValuesPerColumn" ], "additionalProperties": false }, { "type": "null" } ] }, "chunksTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "chunksReceived": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "tokensIn": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "tokensOut": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "durationMs": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "appliedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "appliedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdAt": { "type": "number" } }, "required": [ "id", "connectionId", "snapshotId", "mode", "provider", "model", "promptVersion", "status", "validationStatus", "sections", "locales", "sampling", "chunksTotal", "chunksReceived", "tokensIn", "tokensOut", "durationMs", "appliedBy", "appliedAt", "createdBy", "createdAt" ], "additionalProperties": false }, "partial": { "type": "boolean" }, "counts": { "type": "object", "properties": { "overrides": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pages": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "navGroupUpdates": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "overrides", "pages", "navGroupUpdates" ], "additionalProperties": false }, "review": { "type": "object", "properties": { "accepted": { "type": "array", "items": { "type": "string" } }, "rejected": { "type": "array", "items": { "type": "string" } } }, "required": [ "accepted", "rejected" ], "additionalProperties": false }, "undoToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "run", "partial", "counts", "review", "undoToken" ], "additionalProperties": false } } } } } } }, "/api/v1/llm/runs/{id}/undo/{token}": { "post": { "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "token", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "overrides": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pages": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "overrides", "pages" ], "additionalProperties": false } } } } } } }, "/api/v1/public/config": { "get": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "side": { "type": "string", "enum": [ "staff", "customer" ] }, "timezone": { "type": "string" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "claim": { "anyOf": [ { "type": "object", "properties": { "strategy": { "type": "string", "enum": [ "lookup", "email-code", "external" ] }, "ref": { "type": "string" }, "match": { "type": "array", "items": { "type": "string" } } }, "required": [ "strategy", "ref", "match" ], "additionalProperties": false }, { "type": "null" } ] }, "refs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "actions": { "type": "array", "items": { "type": "string", "enum": [ "read", "create", "update" ] } }, "expose": { "type": "array", "items": { "type": "string" } }, "filterable": { "type": "array", "items": { "type": "string" } }, "searchable": { "type": "array", "items": { "type": "string" } }, "orderable": { "type": "array", "items": { "type": "string" } }, "writable": { "type": "array", "items": { "type": "string" } }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "actions", "expose", "filterable", "searchable", "orderable", "writable", "limit" ], "additionalProperties": false } } }, "required": [ "version", "side", "timezone", "currency", "claim", "refs" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/api/v1/public/records/{ref}": { "get": { "parameters": [ { "schema": { "type": "string", "maxLength": 2048 }, "in": "query", "name": "select", "required": false }, { "schema": { "type": "string", "maxLength": 4096 }, "in": "query", "name": "where", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "q", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "maxLength": 2048 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "ref", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "page": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "offset": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "limit", "offset", "total" ], "additionalProperties": false }, "cursor": { "type": "object", "properties": { "next": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "next" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } }, "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "values" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "ref", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/api/v1/public/records/{ref}/{id}": { "patch": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "values" ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "ref", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 512 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "data" ], "additionalProperties": false } } } }, "400": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "404": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/api/v1/public/claim": { "post": { "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "match": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "match" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "session": { "type": "string" }, "expiresAt": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "session", "expiresAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "403": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "429": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } }, "/api/v1/public/session": { "delete": { "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "data" ], "additionalProperties": false } } } }, "401": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } }, "503": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "error" ], "additionalProperties": false } } } } } } } }, "servers": [ { "url": "/", "description": "This instance" } ] }