{ "openapi": "3.1.2", "info": { "title": "Rootset public API", "version": "0.1.0", "description": "Typed MDM storage. Temporal values are UTC only; IDs are opaque ULIDs. Runtime table definitions are discovered through the schema endpoint." }, "servers": [{ "url": "http://localhost:4310" }], "paths": { "/v1/me": { "get": { "operationId": "getContext", "tags": ["accounts"], "summary": "Get the caller, installation organisation, current role capabilities and preferences.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": [] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getContextOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": [], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_context", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/me/profile": { "get": { "operationId": "getProfile", "tags": ["accounts"], "summary": "Read your profile.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["profile:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getProfileOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["profile:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_get_profile", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} }, "patch": { "operationId": "updateProfile", "tags": ["accounts"], "summary": "Update your display name.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["profile:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": ["name"], "additionalProperties": false }, "example": { "name": "example" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateProfileOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["profile:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_update_profile", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "name": "example" } } }, "/v1/me/preferences": { "get": { "operationId": "getPreferences", "tags": ["accounts"], "summary": "Read display preferences.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["profile:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getPreferencesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["profile:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_get_preferences", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} }, "patch": { "operationId": "updatePreferences", "tags": ["accounts"], "summary": "Update timezone, locale, format or theme preferences.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["profile:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": [ "24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds" ] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "additionalProperties": false, "required": [] }, "example": {} } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updatePreferencesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["profile:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_update_preferences", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/preferences/options": { "get": { "operationId": "getPreferenceOptions", "tags": ["accounts"], "summary": "List supported preference values.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": [] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getPreferenceOptionsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": [], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_preference_options", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/me/preferences/preview": { "post": { "operationId": "previewPreferences", "tags": ["accounts"], "summary": "Preview a UTC instant with proposed display preferences.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": [] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "preferences": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": [ "24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds" ] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "required": [ "timezone", "locale", "dateFormat", "timeFormat", "theme" ], "additionalProperties": false }, "value": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["preferences", "value"], "additionalProperties": false }, "example": { "preferences": { "timezone": "UTC", "locale": "en-GB", "dateFormat": "day-short-month-year", "timeFormat": "24-hour", "theme": "system" }, "value": "2024-01-01T12:30:00.000Z" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewPreferencesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": [], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_preview_preferences", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "preferences": { "timezone": "UTC", "locale": "en-GB", "dateFormat": "day-short-month-year", "timeFormat": "24-hour", "theme": "system" }, "value": "2024-01-01T12:30:00.000Z" } } }, "/v1/me/sessions": { "get": { "operationId": "listSessions", "tags": ["accounts"], "summary": "List your active browser sessions without session secrets.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["account:security"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listSessionsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["account:security"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_list_sessions", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/me/sessions/{id}": { "delete": { "operationId": "revokeSession", "tags": ["accounts"], "summary": "Revoke an owned browser session.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["account:security"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeSessionOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["account:security"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_revoke_session", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "id": "01K6J7B8000000000000000000" } } }, "/v1/me/connections": { "get": { "operationId": "listConnections", "tags": ["accounts"], "summary": "List your delegated OAuth connections.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["account:security"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listConnectionsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["account:security"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_list_connections", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/me/connections/{id}": { "delete": { "operationId": "revokeConnection", "tags": ["accounts"], "summary": "Revoke an owned OAuth grant and refresh family.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["account:security"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeConnectionOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["account:security"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_revoke_connection", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}": { "get": { "operationId": "getOrganisation", "tags": ["accounts"], "summary": "Read an authorised organisation.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["org:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getOrganisationOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["org:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_organisation", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } }, "patch": { "operationId": "updateOrganisation", "tags": ["accounts"], "summary": "Update the installation organisation name.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["org:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": ["name"], "additionalProperties": false }, "example": { "name": "example" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateOrganisationOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["org:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_organisation", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "name": "example" } } }, "/v1/orgs/{orgId}/members": { "get": { "operationId": "listMembers", "tags": ["accounts"], "summary": "List organisation members.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["members:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listMembersOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_members", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/members/{id}": { "patch": { "operationId": "updateMember", "tags": ["accounts"], "summary": "Update a member name or role while preserving at least one admin.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["members:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["expectedVersion"], "additionalProperties": false }, "example": { "expectedVersion": "1" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateMemberOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_member", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "LAST_ADMIN", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000", "expectedVersion": "1" } }, "delete": { "operationId": "removeMember", "tags": ["accounts"], "summary": "Remove a member and invalidate delegated access.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["members:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["expectedVersion"], "additionalProperties": false }, "example": { "expectedVersion": "1" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/removeMemberOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_remove_member", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "LAST_ADMIN", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000", "expectedVersion": "1" } } }, "/v1/orgs/{orgId}/invitations": { "get": { "operationId": "listInvitations", "tags": ["accounts"], "summary": "List redacted organisation invitations.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": ["pending", "accepted", "cancelled", "expired"] } } ], "security": [{ "apiKey": [] }, { "oauth": ["members:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listInvitationsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_invitations", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "inviteMember", "tags": ["accounts"], "summary": "Invite a member as an admin with email proof.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["members:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] } }, "required": ["email", "role"], "additionalProperties": false }, "example": { "email": "admin@example.test", "role": "admin" } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inviteMemberOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_invite_member", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "email": "admin@example.test", "role": "admin" } } }, "/v1/orgs/{orgId}/invitations/{id}": { "delete": { "operationId": "cancelInvitation", "tags": ["accounts"], "summary": "Cancel an invitation before acceptance.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["members:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelInvitationOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["members:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_cancel_invitation", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/me/keys": { "get": { "operationId": "listPersonalKeys", "tags": ["accounts"], "summary": "List metadata for your personal keys.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["keys:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listPersonalKeysOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["keys:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_list_personal_keys", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} }, "post": { "operationId": "createPersonalKey", "tags": ["accounts"], "summary": "Create a personal key with read-only, edit or administrative permissions capped by your live role; secret appears once.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["keys:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "orgId", "name", "access", "includeAdmin", "expiresAt" ], "additionalProperties": false }, "example": { "orgId": "01K6J7B8000000000000000000", "name": "example", "access": "read", "includeAdmin": false, "expiresAt": "2024-01-01T12:30:00.000Z" } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createPersonalKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_create_personal_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "name": "example", "access": "read", "includeAdmin": false, "expiresAt": "2024-01-01T12:30:00.000Z" } } }, "/v1/me/keys/{id}/rotate": { "post": { "operationId": "rotatePersonalKey", "tags": ["accounts"], "summary": "Rotate a personal key with bounded overlap and one-time secret display; preserve name, permissions and expiry unless explicitly changed.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["keys:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "overlapSeconds": { "type": "integer", "minimum": 0, "maximum": 86400 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [], "additionalProperties": false }, "example": {} } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rotatePersonalKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_rotate_personal_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "id": "01K6J7B8000000000000000000" } } }, "/v1/me/keys/{id}": { "delete": { "operationId": "revokePersonalKey", "tags": ["accounts"], "summary": "Revoke an owned personal key.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["keys:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokePersonalKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_revoke_personal_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/keys": { "get": { "operationId": "listTeamKeys", "tags": ["accounts"], "summary": "List metadata for workspace-owned API keys. Administrators only.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["team-keys:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listTeamKeysOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["team-keys:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_list_team_keys", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createTeamKey", "tags": ["accounts"], "summary": "Create a workspace-owned API key with explicit permissions and expiry; the secret appears once and access is independent of its creator.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["team-keys:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["name", "access", "includeAdmin", "expiresAt"], "additionalProperties": false }, "example": { "name": "example", "access": "read", "includeAdmin": false, "expiresAt": "2024-01-01T12:30:00.000Z" } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTeamKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["team-keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_create_team_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "name": "example", "access": "read", "includeAdmin": false, "expiresAt": "2024-01-01T12:30:00.000Z" } } }, "/v1/orgs/{orgId}/keys/{id}/rotate": { "post": { "operationId": "rotateTeamKey", "tags": ["accounts"], "summary": "Rotate a workspace API key with bounded overlap; preserve permissions and expiry unless explicitly changed. Administrators only.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["team-keys:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "overlapSeconds": { "type": "integer", "minimum": 0, "maximum": 86400 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [], "additionalProperties": false }, "example": {} } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rotateTeamKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["team-keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_rotate_team_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/keys/{id}": { "delete": { "operationId": "revokeTeamKey", "tags": ["accounts"], "summary": "Revoke a workspace-owned API key. Administrators only.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["team-keys:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/revokeTeamKeyOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["team-keys:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_revoke_team_key", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/me/security": { "get": { "operationId": "getSecurityStatus", "tags": ["accounts"], "summary": "Read factor status and credential metadata only.", "parameters": [], "security": [{ "apiKey": [] }, { "oauth": ["account:security"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSecurityStatusOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["account:security"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_get_security_status", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": {} } }, "/v1/orgs/{orgId}/databases": { "get": { "operationId": "listDatabases", "tags": ["databases"], "summary": "List accessible logical databases.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["databases:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listDatabasesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["databases:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_databases", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createDatabase", "tags": ["databases"], "summary": "Create a logical database with a managed PostgreSQL namespace.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["databases:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["name"], "additionalProperties": false }, "example": { "name": "example" } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createDatabaseOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["databases:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_create_database", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "name": "example" } } }, "/v1/orgs/{orgId}/databases/{databaseId}": { "get": { "operationId": "getDatabase", "tags": ["databases"], "summary": "Read a database within its full organisation parent.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["databases:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getDatabaseOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["databases:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_database", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000" } }, "patch": { "operationId": "updateDatabase", "tags": ["databases"], "summary": "Update database presentation metadata.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["databases:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["name"], "additionalProperties": false }, "example": { "name": "example" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateDatabaseOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["databases:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_database", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "name": "example" } }, "delete": { "operationId": "deleteDatabase", "tags": ["databases"], "summary": "Start administrator database deletion, removing its tables, rows and cell history.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["databases:manage"] }], "responses": { "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteDatabaseOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["databases:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "required", "x-rootset-job": true, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_delete_database", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "STEP_UP_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables": { "get": { "operationId": "listTables", "tags": ["schema"], "summary": "List accessible tables inside a database.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listTablesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_tables", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createTable", "tags": ["schema"], "summary": "Create a physical typed table and runtime schema metadata.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "fields": { "maxItems": 200, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } } }, "required": ["name"], "additionalProperties": false }, "example": { "name": "example" } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createTableOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_create_table", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "name": "example" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}": { "get": { "operationId": "getTable", "tags": ["schema"], "summary": "Read table metadata including cached live-row count.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTableOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_table", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } }, "patch": { "operationId": "updateTable", "tags": ["schema"], "summary": "Update table name and description.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["expectedSchemaVersion", "name"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "name": "example" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateTableOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_table", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "name": "example" } }, "delete": { "operationId": "deleteTable", "tags": ["schema"], "summary": "Start administrator table deletion, removing its rows and cell history.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, "required": ["expectedSchemaVersion"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1 } } } }, "responses": { "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteTableOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_delete_table", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1 } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema": { "get": { "operationId": "getTableSchema", "tags": ["schema"], "summary": "Discover active fields, rules, limits and operator coverage.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTableSchemaOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_table_schema", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/fields": { "get": { "operationId": "listFields", "tags": ["schema"], "summary": "List active fields by property name and stable identifier.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listFieldsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_fields", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createField", "tags": ["schema"], "summary": "Add a validated field, checking existing values and row bytes.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "field": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } }, "required": ["expectedSchemaVersion", "field"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "field": { "name": "example", "type": "text" } } } } }, "responses": { "201": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFieldOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createFieldOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_create_field", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "field": { "name": "example", "type": "text" } } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/fields/{fieldId}": { "patch": { "operationId": "updateField", "tags": ["schema"], "summary": "Change field definition with explicit existing-data validation and conversion.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "field": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["expectedSchemaVersion", "field"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "field": { "name": "example", "type": "text" } } } } }, "responses": { "200": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateFieldOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateFieldOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_field", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "fieldId": "01K6J7B8000000000000000000", "field": { "name": "example", "type": "text" } } }, "delete": { "operationId": "deleteField", "tags": ["schema"], "summary": "Remove a field safely after approving dependent unique-rule removal.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "removeDependencies": { "type": "boolean" } }, "required": ["expectedSchemaVersion"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1 } } } }, "responses": { "200": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteFieldOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteFieldOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_delete_field", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "fieldId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/field-order": { "put": { "operationId": "reorderFields", "tags": ["schema"], "summary": "Set field presentation order without changing API keys.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["expectedSchemaVersion", "fieldIds"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "fieldIds": [] } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/reorderFieldsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_reorder_fields", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "fieldIds": [] } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/preview": { "post": { "operationId": "previewSchemaChange", "tags": ["schema"], "summary": "Dry run a proposed schema change over existing values.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "change": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "add_field" }, "field": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "update_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "fieldId", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "delete_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "fieldId", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "reorder_fields" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false } ] } }, "required": ["expectedSchemaVersion", "change"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "change": { "kind": "add_field", "field": {} } } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/previewSchemaChangeOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "admin", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_preview_schema_change", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "change": { "kind": "add_field", "field": {} } } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations": { "post": { "operationId": "applySchemaChange", "tags": ["schema"], "summary": "Start a journalled resumable schema change with verified cutover.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "change": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "add_field" }, "field": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "update_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "fieldId", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "delete_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "fieldId", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "reorder_fields" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false } ] } }, "required": ["expectedSchemaVersion", "change"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "change": { "kind": "add_field", "field": {} } } } } }, "responses": { "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/applySchemaChangeOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_apply_schema_change", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "change": { "kind": "add_field", "field": {} } } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/schema/operations/{id}": { "get": { "operationId": "getSchemaOperation", "tags": ["schema"], "summary": "Inspect a schema journal using its journal ID or the originating schema job ID. Reports preserve recovery state and public business definitions without physical identifiers.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getSchemaOperationOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_schema_operation", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/unique-rules": { "get": { "operationId": "listUniqueRules", "tags": ["schema"], "summary": "List active or building scalar uniqueness rules.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["tables:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listUniqueRulesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["tables:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_unique_rules", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createUniqueRule", "tags": ["schema"], "summary": "Validate the whole table and activate collision-safe scalar uniqueness.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["expectedSchemaVersion", "fieldIds"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "fieldIds": ["01K6J7B8000000000000000000"] } } } }, "responses": { "201": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createUniqueRuleOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createUniqueRuleOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_create_unique_rule", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "fieldIds": ["01K6J7B8000000000000000000"] } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/unique-rules/{id}": { "delete": { "operationId": "deleteUniqueRule", "tags": ["schema"], "summary": "Remove uniqueness enforcement and update the schema version.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["schema:manage"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, "required": ["expectedSchemaVersion"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1 } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteUniqueRuleOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["schema:manage"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_delete_unique_rule", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/rows": { "get": { "operationId": "listRows", "tags": ["data"], "summary": "List rows with compact projection/order/cursor parameters.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "select", "in": "query", "required": false, "content": { "application/json": { "schema": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } } } } }, { "name": "orderBy", "in": "query", "required": false, "content": { "application/json": { "schema": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } } } } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listRowsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_rows", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } }, "post": { "operationId": "createRow", "tags": ["data"], "summary": "Commit a validated row, uniqueness, capacity, initial cell history and idempotency.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["expectedSchemaVersion", "values"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "values": {} } } } }, "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/createRowOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:write"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_create_row", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "values": {} } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/query": { "post": { "operationId": "queryRows", "tags": ["data"], "summary": "Query typed fields with bounded projection, filters, sorting and live cursors.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000001" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000002" } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "properties": { "select": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "where": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" }, "orderBy": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131200 }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": ["query"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "op": { "type": "string", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "between", "in", "isNull", "isNotNull", "prefix", "contains", "iContains", "pathExists", "pathEq", "jsonContains" ] }, "value": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "path": { "maxItems": 32, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } }, "required": ["field", "op"], "additionalProperties": false }, { "type": "object", "properties": { "and": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" } } }, "required": ["and"], "additionalProperties": false }, { "type": "object", "properties": { "or": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" } } }, "required": ["or"], "additionalProperties": false } ] } } }, "example": { "query": { "select": ["AIRLINE_ID", "SHORT_NAME"], "limit": 200 } } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queryRowsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_query_rows", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000001", "tableId": "01K6J7B8000000000000000002", "query": { "select": ["AIRLINE_ID", "SHORT_NAME"], "limit": 200 } } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/rows/{rowId}": { "get": { "operationId": "getRow", "tags": ["data"], "summary": "Get one canonical row with its opaque ID and decimal-string revision.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getRowOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_row", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "rowId": "01K6J7B8000000000000000000" } }, "patch": { "operationId": "updateRow", "tags": ["data"], "summary": "Patch cells with optimistic revision checks and atomic history.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": [ "expectedSchemaVersion", "expectedVersion", "values" ], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "expectedVersion": "1", "values": {} } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateRowOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:write"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_update_row", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "rowId": "01K6J7B8000000000000000000", "expectedVersion": "1", "values": {} } }, "delete": { "operationId": "deleteRow", "tags": ["data"], "summary": "Delete a row with If-Match revision, remove its cell history and release live capacity.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^\"[0-7][0-9A-HJKMNP-TV-Z]{25}:[1-9][0-9]*\"$" }, "description": "Quoted row-id:decimal-version optimistic concurrency proof." } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["expectedSchemaVersion", "expectedVersion"], "additionalProperties": false }, "example": { "expectedSchemaVersion": 1, "expectedVersion": "1" } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deleteRowOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:write"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_delete_row", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "rowId": "01K6J7B8000000000000000000", "expectedVersion": "1" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/rows/batch": { "post": { "operationId": "mutateRows", "tags": ["data"], "summary": "Commit at most 1,000 create/update/delete mutations atomically. With repair, accept only revision-bound updates as a durable operator repair job; require a personal admin with installation:manage and rows:write, current permission checks for the target, schema, revisions, values and reason. Ordinary batches return the synchronous result.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:write"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "mutations": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "create" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["type", "values"], "additionalProperties": false }, { "type": "object", "properties": { "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "type": { "type": "string", "const": "update" } }, "required": [ "rowId", "expectedVersion", "values", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "delete" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["type", "rowId", "expectedVersion"], "additionalProperties": false } ] } }, "repair": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["reason"], "additionalProperties": false } }, "required": ["expectedSchemaVersion", "mutations"], "additionalProperties": false, "allOf": [ { "if": { "required": ["repair"] }, "then": { "properties": { "mutations": { "items": { "properties": { "type": { "const": "update" } } } } } } } ] }, "example": { "expectedSchemaVersion": 1, "mutations": [{ "type": "create", "values": {} }] } } } }, "responses": { "201": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mutateRowsOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/mutateRowsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:write"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "member", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_mutate_rows", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "expectedSchemaVersion": 1, "mutations": [{ "type": "create", "values": {} }] } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/statistics": { "get": { "operationId": "getTableStatistics", "tags": ["data"], "summary": "Read counts and size estimates without counting every filtered page.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getTableStatisticsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_table_statistics", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/count": { "post": { "operationId": "countRows", "tags": ["data"], "summary": "Get an explicitly labelled count; expensive exact filtered counts become jobs.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "object", "properties": { "select": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "where": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" }, "orderBy": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131200 }, { "type": "null" } ] } }, "additionalProperties": false }, "exact": { "type": "boolean" } }, "required": [], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "op": { "type": "string", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "between", "in", "isNull", "isNotNull", "prefix", "contains", "iContains", "pathExists", "pathEq", "jsonContains" ] }, "value": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "path": { "maxItems": 32, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } }, "required": ["field", "op"], "additionalProperties": false }, { "type": "object", "properties": { "and": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" } } }, "required": ["and"], "additionalProperties": false }, { "type": "object", "properties": { "or": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" } } }, "required": ["or"], "additionalProperties": false } ] } } }, "example": {} } } }, "responses": { "200": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countRowsOutput" } } } }, "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/countRowsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_count_rows", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/rows/{rowId}/cells/{fieldId}/history": { "get": { "operationId": "getCellHistory", "tags": ["data"], "summary": "Read the latest 200 saved changes for an existing cell.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "rowId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 25000 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } } ], "security": [{ "apiKey": [] }, { "oauth": ["history:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getCellHistoryOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["history:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_cell_history", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "rowId": "01K6J7B8000000000000000000", "fieldId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/history/query": { "post": { "operationId": "queryHistory", "tags": ["data"], "summary": "Query bounded row/table history under current resource access.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["history:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "from": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "to": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": [], "additionalProperties": false }, "example": {} } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/queryHistoryOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["history:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_query_history", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/mutations/{id}": { "get": { "operationId": "getMutation", "tags": ["accounts"], "summary": "Inspect a committed mutation without replaying one-time secrets.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": [] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getMutationOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": [], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_mutation", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/databases/{databaseId}/tables/{tableId}/exports": { "post": { "operationId": "exportRows", "tags": ["artifacts"], "summary": "Start a complete-table snapshot export in CSV or JSONL, including every row and field, with checksummed artifacts.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "databaseId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [ { "apiKey": [] }, { "oauth": ["exports:read", "rows:read"] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "format": { "type": "string", "enum": ["csv", "jsonl"] } }, "required": ["format"], "additionalProperties": false }, "example": { "format": "csv" } } } }, "responses": { "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/exportRowsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["exports:read", "rows:read"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_export_rows", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "databaseId": "01K6J7B8000000000000000000", "tableId": "01K6J7B8000000000000000000", "format": "csv" } } }, "/v1/orgs/{orgId}/artifacts/{id}": { "get": { "operationId": "getArtifact", "tags": ["artifacts"], "summary": "Get authenticated expiring artifact access after current source/target permission checks.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": [] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getArtifactOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": [], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_artifact", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/jobs": { "get": { "operationId": "listJobs", "tags": ["jobs"], "summary": "List only currently authorised jobs and their truthful progress.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "content": { "application/json": { "schema": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } } } }, { "name": "databaseId", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, { "name": "tableId", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, { "name": "state", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] } }, { "name": "kind", "in": "query", "required": false, "schema": { "type": "string" } } ], "security": [{ "apiKey": [] }, { "oauth": ["jobs:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/listJobsOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["jobs:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_list_jobs", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/jobs/{id}": { "get": { "operationId": "getJob", "tags": ["jobs"], "summary": "Inspect a durable job and committed checkpoints.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["jobs:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getJobOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["jobs:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_job", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/jobs/{id}/cancel": { "post": { "operationId": "cancelJob", "tags": ["jobs"], "summary": "Request cancellation at a safe checkpoint with partial outcomes.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["jobs:cancel"] }], "responses": { "201": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/cancelJobOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["jobs:cancel"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_cancel_job", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/jobs/{id}/retry": { "post": { "operationId": "retryJob", "tags": ["jobs"], "summary": "Retry an authorised recoverable job after reconciliation.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["jobs:retry"] }], "responses": { "202": { "description": "Committed synchronous result or accepted durable job; polling is required for terminal verification.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/retryJobOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["jobs:retry"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": true, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_retry_job", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000", "id": "01K6J7B8000000000000000000" } } }, "/v1/orgs/{orgId}/usage": { "get": { "operationId": "getUsage", "tags": ["accounts"], "summary": "Read appropriately redacted organisation usage and capacity.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["org:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getUsageOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["org:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": false, "x-rootset-mcp-tool": "rootset_get_usage", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "orgId": "01K6J7B8000000000000000000" } } }, "/v1/me/view-preferences/{tableId}": { "get": { "operationId": "getViewPreferences", "tags": ["accounts"], "summary": "Read your accessible table column/filter preferences.", "parameters": [ { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/getViewPreferencesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": true, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_get_view_preferences", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "tableId": "01K6J7B8000000000000000000" } }, "put": { "operationId": "updateViewPreferences", "tags": ["accounts"], "summary": "Save table view preferences without changing data/schema.", "parameters": [ { "name": "tableId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "example": "01K6J7B8000000000000000000" }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 255 }, "description": "Bound to actor, operation, target, schema version and canonical payload; changed input returns 409." } ], "security": [{ "apiKey": [] }, { "oauth": ["rows:read"] }], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "preferences": { "type": "object", "properties": { "columnOrder": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "columnWidths": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number", "minimum": 40, "maximum": 2000 } }, "frozenColumns": { "type": "integer", "minimum": 0, "maximum": 200 }, "hiddenColumns": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "query": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": [ "columnOrder", "columnWidths", "frozenColumns", "hiddenColumns" ], "additionalProperties": false } }, "required": ["preferences"], "additionalProperties": false }, "example": { "preferences": { "columnOrder": [], "columnWidths": {}, "frozenColumns": 0, "hiddenColumns": [] } } } } }, "responses": { "200": { "description": "Authorised operation result.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/updateViewPreferencesOutput" } } } }, "400": { "description": "Malformed request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "401": { "description": "Missing, expired, revoked or wrong-audience credential.", "headers": { "WWW-Authenticate": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Insufficient current authority.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Unknown or undisclosed target.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "408": { "description": "Ordinary JSON request body did not finish within its bounded read deadline.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Revision, schema, uniqueness or idempotency conflict.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "413": { "description": "Payload or output budget exceeded.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "422": { "description": "Typed validation failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Rate, concurrency or admission limit.", "headers": { "Retry-After": { "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted internal failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "502": { "description": "A required upstream service is unavailable.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "A required service is unavailable. Check service configuration before retrying.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-scopes": ["rows:read"], "x-rootset-read-only": false, "x-rootset-step-up": "never", "x-rootset-job": false, "x-rootset-minimum-role": "viewer", "x-rootset-personal": true, "x-rootset-mcp-tool": "rootset_update_view_preferences", "x-rootset-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "RESOURCE_NOT_FOUND", "DEPENDENCY_UNAVAILABLE", "REQUEST_TIMEOUT", "IDEMPOTENCY_CONFLICT" ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000, "x-rootset-request-example": { "tableId": "01K6J7B8000000000000000000", "preferences": { "columnOrder": [], "columnWidths": {}, "frozenColumns": 0, "hiddenColumns": [] } } } }, "/v1/orgs/{orgId}/artifacts/{id}/download": { "get": { "operationId": "downloadArtifactBytes", "tags": ["artifacts"], "summary": "Stream verified artifact bytes under current artifact-purpose and target authority.", "description": "Use the authenticated download URL returned by getArtifact. An API key or API-audience OAuth bearer token is accepted; the MCP-audience OAuth grant used for artifact retrieval is also accepted only at this bound binary handoff. The server rechecks the artifact's organisation, original purpose scopes, requester and current role, verifies encrypted-object integrity, then streams the bytes with their exact declared size and checksum. Artifact-bound downloads are the only MCP-audience exception among /v1 routes; ordinary JSON API routes remain API-audience only. The ordinary JSON response budget does not apply to the binary stream. MCP artifact resources return bounded metadata with this authenticated download URL.", "parameters": [ { "name": "orgId", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } ], "security": [{ "apiKey": [] }, { "oauth": [] }], "responses": { "200": { "description": "Verified artifact stream with its exact byte length and checksum.", "headers": { "Content-Length": { "schema": { "type": "string", "pattern": "^[0-9]+$" } }, "Content-Disposition": { "schema": { "type": "string" } }, "Cache-Control": { "schema": { "type": "string", "const": "no-store" } }, "Digest": { "schema": { "type": "string" }, "description": "sha-256= followed by the base64 checksum." } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "text/csv": { "schema": { "type": "string", "format": "binary" } }, "application/x-ndjson": { "schema": { "type": "string", "format": "binary" } } } }, "401": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "403": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "404": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "409": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "410": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "429": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "500": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } }, "503": { "description": "Redacted artifact authentication, current authority, availability, expiry or integrity failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorEnvelope" } } } } }, "x-rootset-operation": "getArtifact", "x-rootset-protocol-adapter": "binary", "x-rootset-read-only": true, "x-rootset-mcp-audience-handoff": true, "x-rootset-target-resolver": "artifact-purpose-and-current-target" } } }, "components": { "schemas": { "getContextInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getContextOutput": { "type": "object", "properties": { "principal": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "userId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] } }, "required": ["id", "kind", "role"], "additionalProperties": false }, "organisation": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "createdAt", "updatedAt"], "additionalProperties": false }, { "type": "null" } ] }, "scopes": { "type": "array", "items": { "type": "string" } }, "profile": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "name", "email", "emailVerified", "createdAt", "updatedAt" ], "additionalProperties": false }, { "type": "null" } ] }, "preferences": { "anyOf": [ { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": [ "24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds" ] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "required": [ "timezone", "locale", "dateFormat", "timeFormat", "theme" ], "additionalProperties": false }, { "type": "null" } ] }, "onboarding": { "type": "object", "properties": { "needsEmailVerification": { "type": "boolean" }, "setupComplete": { "type": "boolean" } }, "required": ["needsEmailVerification", "setupComplete"], "additionalProperties": false } }, "required": [ "principal", "organisation", "scopes", "profile", "preferences", "onboarding" ], "additionalProperties": false }, "getProfileInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getProfileOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "name", "email", "emailVerified", "createdAt", "updatedAt" ], "additionalProperties": false }, "updateProfileInput": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": ["name"], "additionalProperties": false }, "updateProfileOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "emailVerified": { "type": "boolean" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "name", "email", "emailVerified", "createdAt", "updatedAt" ], "additionalProperties": false }, "getPreferencesInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getPreferencesOutput": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": ["24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds"] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "required": ["timezone", "locale", "dateFormat", "timeFormat", "theme"], "additionalProperties": false }, "updatePreferencesInput": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": ["24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds"] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "additionalProperties": false }, "updatePreferencesOutput": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": ["24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds"] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "required": ["timezone", "locale", "dateFormat", "timeFormat", "theme"], "additionalProperties": false }, "getPreferenceOptionsInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getPreferenceOptionsOutput": { "type": "object", "properties": { "timezones": { "type": "array", "items": { "type": "string" } }, "locales": { "type": "array", "items": { "type": "string" } }, "dateFormats": { "type": "array", "items": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] } }, "timeFormats": { "type": "array", "items": { "type": "string", "enum": [ "24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds" ] } }, "themes": { "type": "array", "items": { "type": "string" } } }, "required": [ "timezones", "locales", "dateFormats", "timeFormats", "themes" ], "additionalProperties": false }, "previewPreferencesInput": { "type": "object", "properties": { "preferences": { "type": "object", "properties": { "timezone": { "type": "string", "minLength": 1, "maxLength": 100 }, "locale": { "type": "string", "minLength": 2, "maxLength": 64 }, "dateFormat": { "type": "string", "enum": [ "day-short-month-year", "short-month-day-year", "year-month-day", "day-month-year", "month-day-year" ] }, "timeFormat": { "type": "string", "enum": [ "24-hour", "12-hour", "24-hour-seconds", "12-hour-seconds" ] }, "theme": { "type": "string", "enum": ["system", "light", "dark"] } }, "required": [ "timezone", "locale", "dateFormat", "timeFormat", "theme" ], "additionalProperties": false }, "value": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["preferences", "value"], "additionalProperties": false }, "previewPreferencesOutput": { "type": "object", "properties": { "utc": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "displayed": { "type": "string" }, "timezone": { "type": "string" } }, "required": ["utc", "displayed", "timezone"], "additionalProperties": false }, "listSessionsInput": { "type": "object", "properties": {}, "additionalProperties": false }, "listSessionsOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "lastActivityAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "current": { "type": "boolean" }, "userAgent": { "type": "string" } }, "required": [ "id", "createdAt", "expiresAt", "lastActivityAt", "current" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "revokeSessionInput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["id"], "additionalProperties": false }, "revokeSessionOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "listConnectionsInput": { "type": "object", "properties": {}, "additionalProperties": false }, "listConnectionsOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "clientId": { "type": "string" }, "clientName": { "type": "string" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "audience": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "id", "clientId", "clientName", "orgId", "audience", "scopes", "createdAt", "expiresAt", "revokedAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "revokeConnectionInput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["id"], "additionalProperties": false }, "revokeConnectionOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "getOrganisationInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId"], "additionalProperties": false }, "getOrganisationOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "createdAt", "updatedAt"], "additionalProperties": false }, "updateOrganisationInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "required": ["orgId", "name"], "additionalProperties": false }, "updateOrganisationOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "createdAt", "updatedAt"], "additionalProperties": false }, "listMembersInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId"], "additionalProperties": false }, "listMembersOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "userId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "verified": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" } }, "required": [ "id", "orgId", "userId", "name", "email", "role", "version", "verified", "twoFactorEnabled" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "updateMemberInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["orgId", "id", "expectedVersion"], "additionalProperties": false }, "updateMemberOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "userId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "verified": { "type": "boolean" }, "twoFactorEnabled": { "type": "boolean" } }, "required": [ "id", "orgId", "userId", "name", "email", "role", "version", "verified", "twoFactorEnabled" ], "additionalProperties": false }, "removeMemberInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["orgId", "id", "expectedVersion"], "additionalProperties": false }, "removeMemberOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "listInvitationsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] }, "state": { "type": "string", "enum": ["pending", "accepted", "cancelled", "expired"] } }, "required": ["orgId"], "additionalProperties": false }, "listInvitationsOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "state": { "type": "string", "enum": ["pending", "accepted", "cancelled", "expired"] }, "expiresAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "orgId", "email", "role", "state", "expiresAt", "createdAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "inviteMemberInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] } }, "required": ["orgId", "email", "role"], "additionalProperties": false }, "inviteMemberOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "email": { "type": "string", "format": "email", "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "role": { "type": "string", "enum": ["admin", "member", "viewer"] }, "state": { "type": "string", "enum": ["pending", "accepted", "cancelled", "expired"] }, "expiresAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "inviteUrl": { "type": "string", "format": "uri" } }, "required": [ "id", "orgId", "email", "role", "state", "expiresAt", "createdAt", "inviteUrl" ], "additionalProperties": false }, "cancelInvitationInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "cancelInvitationOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "listPersonalKeysInput": { "type": "object", "properties": {}, "additionalProperties": false }, "listPersonalKeysOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createPersonalKeyInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["orgId", "name", "access", "includeAdmin", "expiresAt"], "additionalProperties": false }, "createPersonalKeyOutput": { "type": "object", "properties": { "key": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false }, "secret": { "type": "string" }, "replayed": { "type": "boolean" } }, "required": ["key"], "additionalProperties": false }, "rotatePersonalKeyInput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "overlapSeconds": { "type": "integer", "minimum": 0, "maximum": 86400 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["id"], "additionalProperties": false }, "rotatePersonalKeyOutput": { "type": "object", "properties": { "key": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false }, "secret": { "type": "string" }, "replayed": { "type": "boolean" } }, "required": ["key"], "additionalProperties": false }, "revokePersonalKeyInput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["id"], "additionalProperties": false }, "revokePersonalKeyOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "listTeamKeysInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId"], "additionalProperties": false }, "listTeamKeysOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createTeamKeyInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["orgId", "name", "access", "includeAdmin", "expiresAt"], "additionalProperties": false }, "createTeamKeyOutput": { "type": "object", "properties": { "key": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false }, "secret": { "type": "string" }, "replayed": { "type": "boolean" } }, "required": ["key"], "additionalProperties": false }, "rotateTeamKeyInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "overlapSeconds": { "type": "integer", "minimum": 0, "maximum": 86400 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["orgId", "id"], "additionalProperties": false }, "rotateTeamKeyOutput": { "type": "object", "properties": { "key": { "type": "object", "properties": { "scope": { "type": "string", "enum": ["personal", "team"] }, "access": { "type": "string", "enum": ["read", "edit"] }, "includeAdmin": { "type": "boolean" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "userId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "prefix": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "revokedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": [ "scope", "access", "includeAdmin", "id", "orgId", "name", "userId", "prefix", "createdAt", "expiresAt", "revokedAt", "lastUsedAt" ], "additionalProperties": false }, "secret": { "type": "string" }, "replayed": { "type": "boolean" } }, "required": ["key"], "additionalProperties": false }, "revokeTeamKeyInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "revokeTeamKeyOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "getSecurityStatusInput": { "type": "object", "properties": {}, "additionalProperties": false }, "getSecurityStatusOutput": { "type": "object", "properties": { "twoFactorEnabled": { "type": "boolean" }, "recoveryCodesRemaining": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "passkeys": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "lastUsedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] } }, "required": ["id", "name", "createdAt", "lastUsedAt"], "additionalProperties": false } } }, "required": ["twoFactorEnabled", "recoveryCodesRemaining", "passkeys"], "additionalProperties": false }, "listDatabasesInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId"], "additionalProperties": false }, "listDatabasesOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "tableCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "orgId", "name", "state", "createdAt", "updatedAt", "tableCount" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createDatabaseInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["orgId", "name"], "additionalProperties": false }, "createDatabaseOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "orgId", "name", "state", "createdAt", "updatedAt"], "additionalProperties": false }, "getDatabaseInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId"], "additionalProperties": false }, "getDatabaseOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "orgId", "name", "state", "createdAt", "updatedAt"], "additionalProperties": false }, "updateDatabaseInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["orgId", "databaseId", "name"], "additionalProperties": false }, "updateDatabaseOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "orgId", "name", "state", "createdAt", "updatedAt"], "additionalProperties": false }, "deleteDatabaseInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId"], "additionalProperties": false }, "deleteDatabaseOutput": { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false }, "listTablesInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId", "databaseId"], "additionalProperties": false }, "listTablesOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createTableInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "fields": { "maxItems": 200, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } } }, "required": ["orgId", "databaseId", "name"], "additionalProperties": false }, "createTableOutput": { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["table", "fields", "uniqueRules", "operators", "limits"], "additionalProperties": false }, "getTableInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "getTableOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "updateTableInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "name" ], "additionalProperties": false }, "updateTableOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "deleteTableInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 } }, "required": ["orgId", "databaseId", "tableId", "expectedSchemaVersion"], "additionalProperties": false }, "deleteTableOutput": { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false }, "getTableSchemaInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "getTableSchemaOutput": { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["table", "fields", "uniqueRules", "operators", "limits"], "additionalProperties": false }, "listFieldsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "listFieldsOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createFieldInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "field": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "field" ], "additionalProperties": false }, "createFieldOutput": { "anyOf": [ { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": [ "table", "fields", "uniqueRules", "operators", "limits" ], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "updateFieldInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "field": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "fieldId", "field" ], "additionalProperties": false }, "updateFieldOutput": { "anyOf": [ { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": [ "table", "fields", "uniqueRules", "operators", "limits" ], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "deleteFieldInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "fieldId" ], "additionalProperties": false }, "deleteFieldOutput": { "anyOf": [ { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": [ "table", "fields", "uniqueRules", "operators", "limits" ], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "reorderFieldsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "fieldIds" ], "additionalProperties": false }, "reorderFieldsOutput": { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "uniqueRules": { "maxItems": 16, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "operators": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "array", "items": { "type": "string" } } }, "limits": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "schemaOperationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["table", "fields", "uniqueRules", "operators", "limits"], "additionalProperties": false }, "previewSchemaChangeInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "change": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "add_field" }, "field": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "update_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "fieldId", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "delete_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "fieldId", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "reorder_fields" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false } ] } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "change" ], "additionalProperties": false }, "previewSchemaChangeOutput": { "type": "object", "properties": { "valid": { "type": "boolean" }, "requiresJob": { "type": "boolean" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "conflicts": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "code": { "type": "string" }, "message": { "type": "string" } }, "required": ["rowId", "code", "message"], "additionalProperties": false } }, "reportArtifactId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["valid", "requiresJob", "rowCount", "conflicts"], "additionalProperties": false }, "applySchemaChangeInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "change": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "add_field" }, "field": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "update_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "fieldId", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "delete_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "fieldId", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "reorder_fields" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false } ] } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "change" ], "additionalProperties": false }, "applySchemaChangeOutput": { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false }, "getSchemaOperationInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId", "id"], "additionalProperties": false }, "getSchemaOperationOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "anyOf": [ { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, { "type": "null" } ] }, "kind": { "type": "string", "minLength": 1, "maxLength": 128 }, "state": { "type": "string", "minLength": 1, "maxLength": 64 }, "phase": { "type": "string", "enum": [ "planned", "running", "committed", "failed", "historical", "unknown" ] }, "expectedSchemaVersion": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 2147483647 }, { "type": "null" } ] }, "request": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "database.create" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["kind", "name"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "database.update" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["kind"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "database.delete" } }, "required": ["kind"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table.create" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "fields": { "maxItems": 200, "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } } }, "required": ["kind", "name", "fields"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table.update" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] } }, "required": ["kind"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table.delete" } }, "required": ["kind"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field.create" }, "field": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["name", "type"], "additionalProperties": false } ] } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field.update" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "type": { "type": "string", "enum": [ "text", "uri", "url", "image", "integer", "float", "boolean", "date", "time", "date-time", "json" ] }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "charLimit": { "type": "integer", "minimum": 1, "maximum": 65536 }, "min": { "type": ["number", "string"] }, "max": { "type": ["number", "string"] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 } }, "additionalProperties": false } }, "required": ["kind", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field.convert" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "type": { "type": "string", "enum": [ "text", "uri", "url", "image", "integer", "float", "boolean", "date", "time", "date-time", "json" ] }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "charLimit": { "type": "integer", "minimum": 1, "maximum": 65536 }, "min": { "type": ["number", "string"] }, "max": { "type": ["number", "string"] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 } }, "additionalProperties": false }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "field.delete" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "fields.reorder" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rule.create" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "name": { "type": "string", "minLength": 1, "maxLength": 255 } }, "required": ["kind", "fieldIds"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "rule.delete" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["kind"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "unknown" } }, "required": ["kind"], "additionalProperties": false } ] }, "before": { "anyOf": [ { "type": "object", "properties": { "table": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 255 }, "description": { "anyOf": [ { "type": "string", "maxLength": 4096 }, { "type": "null" } ] }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 5000000 }, "state": { "type": "string", "enum": [ "active", "creating", "maintenance", "deleting", "deleted", "failed" ] }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "databaseId", "orgId", "name", "schemaVersion", "rowCount", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "fields": { "maxItems": 200, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } } }, "required": ["table", "fields"], "additionalProperties": false }, { "type": "null" } ] }, "change": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "add_field" }, "field": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["kind", "field"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "update_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "changes": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "conversion": { "type": "string", "enum": ["explicit", "lossless"] } }, "required": ["kind", "fieldId", "changes"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "delete_field" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "removeDependencies": { "type": "boolean" } }, "required": ["kind", "fieldId", "removeDependencies"], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "reorder_fields" }, "fieldIds": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": ["kind", "fieldIds"], "additionalProperties": false } ] }, "verification": { "type": "object", "properties": { "transactional": { "type": "boolean" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "nextField": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] } }, "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "committedAt": { "anyOf": [ { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, { "type": "null" } ] }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "retryable": { "type": "boolean" } }, "required": ["code", "message"], "additionalProperties": false }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": [ "id", "databaseId", "tableId", "kind", "state", "phase", "expectedSchemaVersion", "request", "before", "verification", "createdAt", "committedAt" ], "additionalProperties": false }, "listUniqueRulesInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "listUniqueRulesOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "createUniqueRuleInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "fieldIds" ], "additionalProperties": false }, "createUniqueRuleOutput": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldIds": { "minItems": 1, "maxItems": 8, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "nullPolicy": { "type": "string", "const": "distinct" }, "state": { "type": "string", "enum": ["building", "active", "failed", "deleting"] }, "strategy": { "type": "string", "enum": ["native", "registry"] }, "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "error": { "type": "string" } }, "required": [ "id", "tableId", "fieldIds", "nullPolicy", "state", "strategy" ], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "deleteUniqueRuleInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "id" ], "additionalProperties": false }, "deleteUniqueRuleOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "listRowsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "select": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "orderBy": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string" }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "listRowsOutput": { "type": "object", "properties": { "data": { "maxItems": 25000, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["id", "version", "createdAt", "updatedAt", "values"], "additionalProperties": false } }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "page": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 25000 }, "requestedLimit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": ["string", "null"] }, "stopReason": { "type": "string", "enum": ["row_limit", "byte_limit", "end"] }, "consistency": { "type": "string", "const": "live" } }, "required": [ "returned", "requestedLimit", "hasMore", "nextCursor", "stopReason", "consistency" ], "additionalProperties": false } }, "required": ["data", "schemaVersion", "page"], "additionalProperties": false }, "queryRowsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "query": { "type": "object", "properties": { "select": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "where": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" }, "orderBy": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131200 }, { "type": "null" } ] } }, "additionalProperties": false } }, "required": ["orgId", "databaseId", "tableId", "query"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "op": { "type": "string", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "between", "in", "isNull", "isNotNull", "prefix", "contains", "iContains", "pathExists", "pathEq", "jsonContains" ] }, "value": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "path": { "maxItems": 32, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } }, "required": ["field", "op"], "additionalProperties": false }, { "type": "object", "properties": { "and": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" } } }, "required": ["and"], "additionalProperties": false }, { "type": "object", "properties": { "or": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/queryRowsInput/$defs/__schema0" } } }, "required": ["or"], "additionalProperties": false } ] } } }, "queryRowsOutput": { "type": "object", "properties": { "data": { "maxItems": 25000, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["id", "version", "createdAt", "updatedAt", "values"], "additionalProperties": false } }, "schemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "page": { "type": "object", "properties": { "returned": { "type": "integer", "minimum": 0, "maximum": 25000 }, "requestedLimit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": ["string", "null"] }, "stopReason": { "type": "string", "enum": ["row_limit", "byte_limit", "end"] }, "consistency": { "type": "string", "const": "live" } }, "required": [ "returned", "requestedLimit", "hasMore", "nextCursor", "stopReason", "consistency" ], "additionalProperties": false } }, "required": ["data", "schemaVersion", "page"], "additionalProperties": false }, "getRowInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId", "rowId"], "additionalProperties": false }, "getRowOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["id", "version", "createdAt", "updatedAt", "values"], "additionalProperties": false }, "createRowInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "values" ], "additionalProperties": false }, "createRowOutput": { "type": "object", "properties": { "row": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["id", "version", "createdAt", "updatedAt", "values"], "additionalProperties": false }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["row", "mutationId"], "additionalProperties": false }, "updateRowInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "rowId", "expectedVersion", "values" ], "additionalProperties": false }, "updateRowOutput": { "type": "object", "properties": { "row": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["id", "version", "createdAt", "updatedAt", "values"], "additionalProperties": false }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["row", "mutationId"], "additionalProperties": false }, "deleteRowInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "rowId", "expectedVersion" ], "additionalProperties": false }, "deleteRowOutput": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["deleted"], "additionalProperties": false }, "mutateRowsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedSchemaVersion": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "mutations": { "minItems": 1, "maxItems": 1000, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "const": "create" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": ["type", "values"], "additionalProperties": false }, { "type": "object", "properties": { "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "type": { "type": "string", "const": "update" } }, "required": ["rowId", "expectedVersion", "values", "type"], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "const": "delete" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "expectedVersion": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" } }, "required": ["type", "rowId", "expectedVersion"], "additionalProperties": false } ] } }, "repair": { "type": "object", "properties": { "reason": { "type": "string", "minLength": 1, "maxLength": 512 } }, "required": ["reason"], "additionalProperties": false } }, "required": [ "orgId", "databaseId", "tableId", "expectedSchemaVersion", "mutations" ], "additionalProperties": false, "allOf": [ { "if": { "required": ["repair"] }, "then": { "properties": { "mutations": { "items": { "properties": { "type": { "const": "update" } } } } } } } ] }, "mutateRowsOutput": { "anyOf": [ { "type": "object", "properties": { "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "results": { "maxItems": 1000, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": ["create", "update", "delete"] }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "row": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "values": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "additionalProperties": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } } }, "required": [ "id", "version", "createdAt", "updatedAt", "values" ], "additionalProperties": false }, "deleted": { "type": "boolean" } }, "required": ["type", "rowId"], "additionalProperties": false } } }, "required": ["mutationId", "results"], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "getTableStatisticsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "getTableStatisticsOutput": { "type": "object", "properties": { "liveRows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rowCountKind": { "type": "string", "enum": ["cached", "live", "approximate"] }, "storageBytes": { "type": "number", "minimum": 0 }, "indexBytes": { "type": "number", "minimum": 0 }, "historyEvents": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "asOf": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "liveRows", "rowCountKind", "storageBytes", "indexBytes", "historyEvents", "asOf" ], "additionalProperties": false }, "countRowsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "query": { "type": "object", "properties": { "select": { "maxItems": 200, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "where": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" }, "orderBy": { "maxItems": 8, "type": "array", "items": { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "direction": { "type": "string", "enum": ["asc", "desc"] } }, "required": ["field", "direction"], "additionalProperties": false } }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 131200 }, { "type": "null" } ] } }, "additionalProperties": false }, "exact": { "type": "boolean" } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false, "$defs": { "__schema0": { "anyOf": [ { "type": "object", "properties": { "field": { "type": "string", "minLength": 1, "maxLength": 64 }, "op": { "type": "string", "enum": [ "eq", "ne", "lt", "lte", "gt", "gte", "between", "in", "isNull", "isNotNull", "prefix", "contains", "iContains", "pathExists", "pathEq", "jsonContains" ] }, "value": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "path": { "maxItems": 32, "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "integer", "minimum": 0, "maximum": 2147483647 } ] } } }, "required": ["field", "op"], "additionalProperties": false }, { "type": "object", "properties": { "and": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" } } }, "required": ["and"], "additionalProperties": false }, { "type": "object", "properties": { "or": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "$ref": "#/components/schemas/countRowsInput/$defs/__schema0" } } }, "required": ["or"], "additionalProperties": false } ] } } }, "countRowsOutput": { "anyOf": [ { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "kind": { "type": "string", "enum": ["cached", "live", "approximate", "exact"] }, "asOf": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["count", "kind", "asOf"], "additionalProperties": false }, { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false } ] }, "getCellHistoryInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId", "databaseId", "tableId", "rowId", "fieldId"], "additionalProperties": false }, "getCellHistoryOutput": { "type": "object", "properties": { "data": { "maxItems": 25000, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "requestId": { "type": "string" }, "actor": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "credentialId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "clientId": { "type": "string" } }, "required": ["id", "kind"], "additionalProperties": false }, "source": { "type": "string" }, "operation": { "type": "string", "enum": ["create", "update", "delete", "conversion", "repair"] }, "before": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "after": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "fieldDefinition": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] }, "previousVersion": { "anyOf": [ { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, { "type": "null" } ] }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "timestamp": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "orgId", "databaseId", "tableId", "rowId", "fieldId", "mutationId", "requestId", "actor", "source", "operation", "before", "after", "fieldDefinition", "previousVersion", "version", "timestamp" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data", "nextCursor", "hasMore"], "additionalProperties": false }, "queryHistoryInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "from": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "to": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "limit": { "type": "integer", "minimum": 1, "maximum": 25000 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] } }, "required": ["orgId", "databaseId", "tableId"], "additionalProperties": false }, "queryHistoryOutput": { "type": "object", "properties": { "data": { "maxItems": 25000, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "rowId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "fieldId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "requestId": { "type": "string" }, "actor": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "credentialId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "clientId": { "type": "string" } }, "required": ["id", "kind"], "additionalProperties": false }, "source": { "type": "string" }, "operation": { "type": "string", "enum": ["create", "update", "delete", "conversion", "repair"] }, "before": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "after": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "fieldDefinition": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "text" }, "charLimit": { "type": "integer", "exclusiveMinimum": 0, "maximum": 65536 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "integer" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "float" }, "min": { "type": "number" }, "max": { "type": "number" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "uri" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "url" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "image" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "boolean" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}$", "format": "date", "examples": ["2024-01-01"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "time" } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "date-time" }, "min": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "max": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": ["id", "name", "type"], "additionalProperties": false }, { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 64, "pattern": "^[A-Za-z_]+$" }, "required": { "type": "boolean" }, "default": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "order": { "type": "integer", "minimum": 0, "maximum": 199 }, "type": { "type": "string", "const": "json" } }, "required": ["id", "name", "type"], "additionalProperties": false } ] }, "previousVersion": { "anyOf": [ { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, { "type": "null" } ] }, "version": { "type": "string", "pattern": "^[1-9][0-9]{0,18}$" }, "timestamp": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] } }, "required": [ "id", "orgId", "databaseId", "tableId", "rowId", "fieldId", "mutationId", "requestId", "actor", "source", "operation", "before", "after", "fieldDefinition", "previousVersion", "version", "timestamp" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data", "nextCursor", "hasMore"], "additionalProperties": false }, "getMutationInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "getMutationOutput": { "type": "object", "properties": { "mutationId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "replayed": { "type": "boolean" }, "result": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": ["mutationId"], "additionalProperties": false }, "exportRowsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "format": { "type": "string", "enum": ["csv", "jsonl"] } }, "required": ["orgId", "databaseId", "tableId", "format"], "additionalProperties": false }, "exportRowsOutput": { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false }, "getArtifactInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "getArtifactOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "kind": { "type": "string", "const": "export" }, "format": { "type": "string", "enum": ["csv", "jsonl", "json"] }, "sizeBytes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "checksum": { "type": "string" }, "expiresAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d{1,3})?Z$", "format": "date-time", "description": "UTC instant with mandatory Z and at most three fractional digits.", "examples": ["2024-01-01T12:30:00.000Z"] }, "downloadUrl": { "type": "string" }, "resourceUri": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "orgId", "kind", "format", "sizeBytes", "checksum", "expiresAt" ], "additionalProperties": false }, "listJobsInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 }, "cursor": { "anyOf": [ { "type": "string", "maxLength": 131200 }, { "type": "null" } ] }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "kind": { "type": "string" } }, "required": ["orgId"], "additionalProperties": false }, "listJobsOutput": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "kind": { "type": "string" }, "operationId": { "type": "string" }, "format": { "type": "string", "enum": ["csv", "jsonl"] }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "stage": { "type": "string" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "progress": { "type": "object", "properties": { "completed": { "type": "number", "minimum": 0 }, "total": { "type": "number", "minimum": 0 }, "unit": { "type": "string" } }, "required": ["completed"], "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "result": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Known domain codes are published in ErrorCode; unknown future codes remain valid.", "x-rootset-known-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "LAST_ADMIN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "DELEGATION_EXCEEDS_AUTHORITY", "RESOURCE_NOT_FOUND", "ROW_VERSION_CONFLICT", "SCHEMA_VERSION_CONFLICT", "UNIQUE_CONFLICT", "ROW_SIZE_LIMIT", "ROW_LIMIT_REACHED", "PAYLOAD_TOO_LARGE", "REQUEST_TIMEOUT", "QUERY_TIMEOUT", "CURSOR_INVALID", "STEP_UP_REQUIRED", "IDEMPOTENCY_CONFLICT", "JOB_FAILED", "RATE_LIMITED", "CAPACITY_LIMIT", "SCHEMA_MAINTENANCE", "ARTIFACT_UNVERIFIED", "ARTIFACT_EXPIRED", "CONFIGURATION_INVALID", "DEPENDENCY_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": ["code", "message", "requestId"], "additionalProperties": false }, "checkpoint": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "orgId", "kind", "operationId", "state", "createdAt", "updatedAt" ], "additionalProperties": false } }, "nextCursor": { "type": ["string", "null"] }, "hasMore": { "type": "boolean" } }, "required": ["data"], "additionalProperties": false }, "getJobInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "getJobOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "kind": { "type": "string" }, "operationId": { "type": "string" }, "format": { "type": "string", "enum": ["csv", "jsonl"] }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "stage": { "type": "string" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "progress": { "type": "object", "properties": { "completed": { "type": "number", "minimum": 0 }, "total": { "type": "number", "minimum": 0 }, "unit": { "type": "string" } }, "required": ["completed"], "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "result": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Known domain codes are published in ErrorCode; unknown future codes remain valid.", "x-rootset-known-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "LAST_ADMIN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "DELEGATION_EXCEEDS_AUTHORITY", "RESOURCE_NOT_FOUND", "ROW_VERSION_CONFLICT", "SCHEMA_VERSION_CONFLICT", "UNIQUE_CONFLICT", "ROW_SIZE_LIMIT", "ROW_LIMIT_REACHED", "PAYLOAD_TOO_LARGE", "REQUEST_TIMEOUT", "QUERY_TIMEOUT", "CURSOR_INVALID", "STEP_UP_REQUIRED", "IDEMPOTENCY_CONFLICT", "JOB_FAILED", "RATE_LIMITED", "CAPACITY_LIMIT", "SCHEMA_MAINTENANCE", "ARTIFACT_UNVERIFIED", "ARTIFACT_EXPIRED", "CONFIGURATION_INVALID", "DEPENDENCY_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": ["code", "message", "requestId"], "additionalProperties": false }, "checkpoint": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "orgId", "kind", "operationId", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "cancelJobInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "cancelJobOutput": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "kind": { "type": "string" }, "operationId": { "type": "string" }, "format": { "type": "string", "enum": ["csv", "jsonl"] }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "stage": { "type": "string" }, "databaseId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "progress": { "type": "object", "properties": { "completed": { "type": "number", "minimum": 0 }, "total": { "type": "number", "minimum": 0 }, "unit": { "type": "string" } }, "required": ["completed"], "additionalProperties": false }, "createdAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "updatedAt": { "type": "string", "pattern": "^(?!0000)\\d{4}-\\d{2}-\\d{2}T(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d\\.\\d{3}Z$" }, "result": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "error": { "type": "object", "properties": { "code": { "type": "string", "description": "Known domain codes are published in ErrorCode; unknown future codes remain valid.", "x-rootset-known-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "LAST_ADMIN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "DELEGATION_EXCEEDS_AUTHORITY", "RESOURCE_NOT_FOUND", "ROW_VERSION_CONFLICT", "SCHEMA_VERSION_CONFLICT", "UNIQUE_CONFLICT", "ROW_SIZE_LIMIT", "ROW_LIMIT_REACHED", "PAYLOAD_TOO_LARGE", "REQUEST_TIMEOUT", "QUERY_TIMEOUT", "CURSOR_INVALID", "STEP_UP_REQUIRED", "IDEMPOTENCY_CONFLICT", "JOB_FAILED", "RATE_LIMITED", "CAPACITY_LIMIT", "SCHEMA_MAINTENANCE", "ARTIFACT_UNVERIFIED", "ARTIFACT_EXPIRED", "CONFIGURATION_INVALID", "DEPENDENCY_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": ["code", "message", "requestId"], "additionalProperties": false }, "checkpoint": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] }, "attempt": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "id", "orgId", "kind", "operationId", "state", "createdAt", "updatedAt" ], "additionalProperties": false }, "retryJobInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "id": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId", "id"], "additionalProperties": false }, "retryJobOutput": { "type": "object", "properties": { "jobId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "state": { "type": "string", "enum": [ "queued", "running", "succeeded", "failed", "cancelled", "partially_completed" ] }, "statusUrl": { "type": "string" } }, "required": ["jobId", "state", "statusUrl"], "additionalProperties": false }, "getUsageInput": { "type": "object", "properties": { "orgId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["orgId"], "additionalProperties": false }, "getUsageOutput": { "type": "object", "properties": { "databases": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "tables": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rows": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "dataBytes": { "type": "number", "minimum": 0 }, "indexBytes": { "type": "number", "minimum": 0 }, "historyBytes": { "type": "number", "minimum": 0 }, "artifactBytes": { "type": "number", "minimum": 0 } }, "required": [ "databases", "tables", "rows", "dataBytes", "indexBytes", "historyBytes", "artifactBytes" ], "additionalProperties": false }, "getViewPreferencesInput": { "type": "object", "properties": { "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "required": ["tableId"], "additionalProperties": false }, "getViewPreferencesOutput": { "type": "object", "properties": { "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "preferences": { "type": "object", "properties": { "columnOrder": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "columnWidths": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number", "minimum": 40, "maximum": 2000 } }, "frozenColumns": { "type": "integer", "minimum": 0, "maximum": 200 }, "hiddenColumns": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "query": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": [ "columnOrder", "columnWidths", "frozenColumns", "hiddenColumns" ], "additionalProperties": false } }, "required": ["tableId", "preferences"], "additionalProperties": false }, "updateViewPreferencesInput": { "type": "object", "properties": { "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "preferences": { "type": "object", "properties": { "columnOrder": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "columnWidths": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number", "minimum": 40, "maximum": 2000 } }, "frozenColumns": { "type": "integer", "minimum": 0, "maximum": 200 }, "hiddenColumns": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "query": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": [ "columnOrder", "columnWidths", "frozenColumns", "hiddenColumns" ], "additionalProperties": false } }, "required": ["tableId", "preferences"], "additionalProperties": false }, "updateViewPreferencesOutput": { "type": "object", "properties": { "tableId": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" }, "preferences": { "type": "object", "properties": { "columnOrder": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "columnWidths": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number", "minimum": 40, "maximum": 2000 } }, "frozenColumns": { "type": "integer", "minimum": 0, "maximum": 200 }, "hiddenColumns": { "maxItems": 200, "type": "array", "items": { "type": "string", "pattern": "^[0-7][0-9A-HJKMNP-TV-Z]{25}$" } }, "query": { "description": "Any finite JSON value. Cell size/depth and typed numeric policies are enforced by the domain validator.", "anyOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ] } }, "required": [ "columnOrder", "columnWidths", "frozenColumns", "hiddenColumns" ], "additionalProperties": false } }, "required": ["tableId", "preferences"], "additionalProperties": false }, "ErrorCode": { "type": "string", "enum": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "LAST_ADMIN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "DELEGATION_EXCEEDS_AUTHORITY", "RESOURCE_NOT_FOUND", "ROW_VERSION_CONFLICT", "SCHEMA_VERSION_CONFLICT", "UNIQUE_CONFLICT", "ROW_SIZE_LIMIT", "ROW_LIMIT_REACHED", "PAYLOAD_TOO_LARGE", "REQUEST_TIMEOUT", "QUERY_TIMEOUT", "CURSOR_INVALID", "STEP_UP_REQUIRED", "IDEMPOTENCY_CONFLICT", "JOB_FAILED", "RATE_LIMITED", "CAPACITY_LIMIT", "SCHEMA_MAINTENANCE", "ARTIFACT_UNVERIFIED", "ARTIFACT_EXPIRED", "CONFIGURATION_INVALID", "DEPENDENCY_UNAVAILABLE", "INTERNAL_ERROR" ] }, "ErrorEnvelope": { "type": "object", "required": ["error"], "additionalProperties": false, "properties": { "error": { "type": "object", "required": ["code", "message", "requestId"], "additionalProperties": false, "properties": { "code": { "type": "string", "description": "Known domain codes are published in ErrorCode; unknown future codes remain valid.", "x-rootset-known-error-codes": [ "VALIDATION_FAILED", "UNAUTHENTICATED", "ACCESS_DENIED", "FORBIDDEN", "LAST_ADMIN", "INSUFFICIENT_SCOPE", "PERSONAL_IDENTITY_REQUIRED", "DELEGATION_EXCEEDS_AUTHORITY", "RESOURCE_NOT_FOUND", "ROW_VERSION_CONFLICT", "SCHEMA_VERSION_CONFLICT", "UNIQUE_CONFLICT", "ROW_SIZE_LIMIT", "ROW_LIMIT_REACHED", "PAYLOAD_TOO_LARGE", "REQUEST_TIMEOUT", "QUERY_TIMEOUT", "CURSOR_INVALID", "STEP_UP_REQUIRED", "IDEMPOTENCY_CONFLICT", "JOB_FAILED", "RATE_LIMITED", "CAPACITY_LIMIT", "SCHEMA_MAINTENANCE", "ARTIFACT_UNVERIFIED", "ARTIFACT_EXPIRED", "CONFIGURATION_INVALID", "DEPENDENCY_UNAVAILABLE", "INTERNAL_ERROR" ] }, "message": { "type": "string" }, "requestId": { "type": "string" }, "details": {} } } } } }, "securitySchemes": { "apiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "Rootset personal API key" }, "browserSession": { "type": "apiKey", "in": "cookie", "name": "rootset.session_token" }, "oauth": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "http://localhost:4310/oauth/authorize", "tokenUrl": "http://localhost:4310/oauth/token", "scopes": { "profile:manage": "Current profile:manage authority; the live role ceiling still applies.", "account:security": "Current account:security authority; the live role ceiling still applies.", "org:read": "Current org:read authority; the live role ceiling still applies.", "org:manage": "Current org:manage authority; the live role ceiling still applies.", "members:read": "Current members:read authority; the live role ceiling still applies.", "members:manage": "Current members:manage authority; the live role ceiling still applies.", "keys:manage": "Current keys:manage authority; the live role ceiling still applies.", "team-keys:manage": "Current team-keys:manage authority; the live role ceiling still applies.", "databases:read": "Current databases:read authority; the live role ceiling still applies.", "databases:manage": "Current databases:manage authority; the live role ceiling still applies.", "tables:read": "Current tables:read authority; the live role ceiling still applies.", "tables:manage": "Current tables:manage authority; the live role ceiling still applies.", "schema:manage": "Current schema:manage authority; the live role ceiling still applies.", "rows:read": "Current rows:read authority; the live role ceiling still applies.", "rows:write": "Current rows:write authority; the live role ceiling still applies.", "history:read": "Current history:read authority; the live role ceiling still applies.", "exports:read": "Current exports:read authority; the live role ceiling still applies.", "jobs:read": "Current jobs:read authority; the live role ceiling still applies.", "jobs:cancel": "Current jobs:cancel authority; the live role ceiling still applies.", "jobs:retry": "Current jobs:retry authority; the live role ceiling still applies." } } } } } }, "x-rootset-protocol-adapters": [ { "path": "/mcp", "methods": ["GET", "POST", "DELETE"], "kind": "protocol", "reason": "Streamable HTTP MCP transport negotiates protocol methods and requires a personal API key or MCP-resource OAuth actor; its named tools come from the operation catalog." }, { "path": "/v1/orgs/{orgId}/artifacts/{id}/download", "methods": ["GET"], "kind": "binary", "operationId": "getArtifact", "reason": "An authenticated verified artifact stream follows metadata retrieval and checks current artifact-purpose, requester and target authority; MCP also exposes bounded artifact resources." }, { "path": "/api/internal/v1/orgs/{orgId}/artifacts/{id}/download", "methods": ["GET"], "kind": "binary", "operationId": "getArtifact", "reason": "The browser session download adapter uses the same current artifact-purpose, requester and target checks. Bearer credentials use the public binary handoff; this read-only adapter does not require mutation CSRF proof." }, { "path": "/v1/setup", "methods": ["GET", "POST"], "kind": "bootstrap", "reason": "First identity must exist before OAuth." }, { "path": "/v1/public/auth/request-verification-email", "methods": ["POST"], "kind": "identity", "reason": "Public normalized-email verification request with neutral acknowledgement and fixed login callback." }, { "path": "/v1/auth/*", "methods": ["GET", "POST", "DELETE"], "kind": "identity", "reason": "Identity/factor proof is browser-mediated. Personal account deletion, organisation lifecycle and team credentials are not supported." }, { "path": "/oauth/*", "methods": ["GET", "POST"], "kind": "protocol", "reason": "OAuth identity/consent/token exchange is protocol-specific." }, { "path": "/api/internal/v1/oauth/requests/*", "methods": ["GET", "POST"], "kind": "interactive", "reason": "Browser session consent inspection and approval are OAuth protocol proof, with issuer/request/client binding." }, { "path": "/.well-known/*", "methods": ["GET"], "kind": "discovery", "reason": "OAuth resource and authorization server discovery." }, { "path": "/api/internal/v1/context", "methods": ["GET"], "kind": "context", "operationId": "getContext" }, { "path": "/api/internal/v1/tables/{id}/windows/query", "methods": ["POST"], "kind": "window", "operationId": "queryRows" }, { "path": "/api/internal/v1/view-preferences/{tableId}", "methods": ["GET", "PUT"], "kind": "alias", "operationIds": ["getViewPreferences", "updateViewPreferences"], "reason": "Browser convenience aliases execute the same typed personal table-view preference operations." }, { "path": "/v1/openapi.json", "methods": ["GET"], "kind": "discovery", "reason": "Public generated contract publication contains no credential or private installation values." }, { "path": "/api/internal/v1/openapi.json", "methods": ["GET"], "kind": "discovery", "reason": "Browser-authenticated generated internal contract publication." }, { "path": "/v1/operation-coverage", "methods": ["GET"], "kind": "discovery", "reason": "Public static coverage inventory lists operation metadata, without user data or a claim that every operation was executed successfully." }, { "path": "/health/live", "methods": ["GET"], "kind": "probe", "reason": "Bounded redacted liveness." }, { "path": "/health/ready", "methods": ["GET"], "kind": "probe", "reason": "Bounded redacted readiness." } ], "x-rootset-json-request-max-bytes": 8388608, "x-rootset-json-read-timeout-ms": 10000 }