{ "openapi": "3.0.3", "info": { "title": "Hex API", "version": "1.0.0", "description": "API specification for the Hex External API", "license": { "name": "UNLICENSED" }, "contact": {} }, "servers": [ { "url": "https://app.hex.tech/api" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/v1/embedding/createPresignedUrl/{projectId}": { "post": { "operationId": "CreatePresignedUrl", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Create an embedded url for a project", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmbeddingRequest" } } } } } }, "/v1/projects": { "post": { "operationId": "CreateProject", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Create a new project.\n\nCreates a new project in the workspace with the specified title.\nOptionally provide a description and project language.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "description": { "type": "string" }, "title": { "type": "string" } }, "required": [ "title" ], "type": "object" } } } } }, "get": { "operationId": "ListProjects", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectsListApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "List all viewable projects, sorted by most recently created first.", "parameters": [ { "in": "query", "name": "includeArchived", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "includeComponents", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "includeTrashed", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "includeSharing", "required": false, "schema": { "default": false, "type": "boolean" } }, { "in": "query", "name": "statuses", "required": false, "schema": { "default": [], "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "categories", "required": false, "schema": { "default": [], "type": "array", "items": { "type": "string" } } }, { "in": "query", "name": "creatorEmail", "required": false, "schema": { "default": null, "type": "string" } }, { "in": "query", "name": "ownerEmail", "required": false, "schema": { "default": null, "type": "string" } }, { "in": "query", "name": "collectionId", "required": false, "schema": { "default": null, "type": "string" } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "$ref": "#/components/schemas/SortByEnum" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "$ref": "#/components/schemas/SortDirectionEnum" } } ] } }, "/v1/projects/{projectId}": { "get": { "operationId": "GetProject", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectApiResource" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get metadata about a single project.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "query", "name": "includeSharing", "required": false, "schema": { "default": false, "type": "boolean" } } ] }, "patch": { "operationId": "UpdateProject", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Use this endpoint to add or remove a status (including endorsements) from a project", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "nullable": true } }, "type": "object" } } } } } }, "/v1/projects/{projectId}/queriedTables": { "get": { "operationId": "GetQueriedTables", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectQueriedTablesApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Given a project ID, return the list of warehouse tables queried in the project.", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ] } }, "/v1/projects/{projectId}/sharing/collections": { "patch": { "operationId": "EditProjectSharingCollections", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectSharingCollectionsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Add a project to collections or remove it from collections.\nFor projects, use `CAN_VIEW` to grant the UI permission labeled \"Can explore\".\nUse `APP_ONLY` to grant the UI permission labeled \"Can view app\".\nWorkspace tokens calling this endpoint need to have \"Collections -> Write access\" scope\nin addition to \"Projects -> Write access\" scope.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "upsert": { "properties": { "collections": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "collection": { "properties": { "id": { "$ref": "#/components/schemas/CollectionId" } }, "required": [ "id" ], "type": "object" } }, "required": [ "access", "collection" ], "type": "object" }, "type": "array", "maxItems": 25 } }, "required": [ "collections" ], "type": "object" } }, "required": [ "upsert" ], "type": "object" } }, "required": [ "sharing" ], "type": "object" } } } } } }, "/v1/projects/{projectId}/sharing/workspaceAndPublic": { "patch": { "operationId": "EditProjectSharingOrgAndPublic", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectSharingWorkspaceAndPublicResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Update workspace or public-web sharing for a project.\nFor projects, use `CAN_VIEW` to grant the UI permission labeled \"Can explore\".\nUse `APP_ONLY` to grant the UI permission labeled \"Can view app\".", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "publicWeb": { "$ref": "#/components/schemas/PublicWebAccessLevel" }, "workspace": { "$ref": "#/components/schemas/AccessLevelEnum" } }, "type": "object" } }, "required": [ "sharing" ], "type": "object" } } } } } }, "/v1/projects/{projectId}/sharing/groups": { "patch": { "operationId": "EditProjectSharingGroups", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectSharingGroupsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Add groups to a project or update/remove their project sharing access.\nFor projects, use `CAN_VIEW` to grant the UI permission labeled \"Can explore\".\nUse `APP_ONLY` to grant the UI permission labeled \"Can view app\".", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "upsert": { "properties": { "groups": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "group": { "properties": { "id": { "$ref": "#/components/schemas/GroupId" } }, "required": [ "id" ], "type": "object" } }, "required": [ "access", "group" ], "type": "object" }, "type": "array", "maxItems": 25 } }, "required": [ "groups" ], "type": "object" } }, "required": [ "upsert" ], "type": "object" } }, "required": [ "sharing" ], "type": "object" } } } } } }, "/v1/projects/{projectId}/sharing/users": { "patch": { "operationId": "EditProjectSharingUsers", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditProjectSharingUsersResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Add users to a project or update/remove their project sharing access.\nFor projects, use `CAN_VIEW` to grant the UI permission labeled \"Can explore\".\nUse `APP_ONLY` to grant the UI permission labeled \"Can view app\".", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "upsert": { "properties": { "users": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "user": { "properties": { "id": { "$ref": "#/components/schemas/UserId" } }, "required": [ "id" ], "type": "object" } }, "required": [ "access", "user" ], "type": "object" }, "type": "array", "maxItems": 25 } }, "required": [ "users" ], "type": "object" } }, "required": [ "upsert" ], "type": "object" } }, "required": [ "sharing" ], "type": "object" } } } } } }, "/v1/semantic-(projects|models)/{semanticProjectId}/ingest": { "post": { "operationId": "IngestSemanticProject", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SemanticProjectsSyncResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TsoaErrorResponsePayload" }, { "properties": { "problems": { "items": { "$ref": "#/components/schemas/HexSLProblemWithDisplay" }, "type": "array" } }, "type": "object" } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "415": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "502": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Ingest a semantic project from a zip file.\n\nThis API endpoint is subject to a maximum of 3 requests per minute.", "parameters": [ { "in": "path", "name": "semanticProjectId", "required": true, "schema": { "$ref": "#/components/schemas/SemanticProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "verbose": { "type": "boolean", "description": "Whether to respond with detail on which components of the semantic layer were successfully synced", "default": true }, "debug": { "type": "boolean", "description": "Whether to include additional debug information", "default": false }, "dryRun": { "type": "boolean", "description": "If enabled, the sync will not actually write to the database" } }, "type": "object" } } } } } }, "/v1/semantic-(projects|models)/{semanticProjectId}": { "patch": { "operationId": "UpdateSemanticProject", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSemanticProjectResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Omit_TsoaErrorResponsePayload.details_" }, { "properties": { "details": { "items": { "$ref": "#/components/schemas/UpdateStatusErrorDetail" }, "type": "array" } }, "type": "object" } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Omit_TsoaErrorResponsePayload.details_" }, { "properties": { "details": { "items": { "$ref": "#/components/schemas/UpdateStatusErrorDetail" }, "type": "array" } }, "type": "object" } ] } } } } }, "description": "Use this endpoint to add or remove a status (including endorsements) from datasets and views within a semantic project\n\nThis endpoint uses atomic semantics - if any update in the batch fails validation,\nthe entire request fails and no changes are applied.", "parameters": [ { "in": "path", "name": "semanticProjectId", "required": true, "schema": { "$ref": "#/components/schemas/SemanticProjectId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSemanticProjectRequest" } } } } } }, "/v1/projects/{projectId}/runs": { "post": { "operationId": "RunProject", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRunResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/TsoaErrorResponsePayload" }, { "$ref": "#/components/schemas/InvalidParamPayload" } ] } } } }, "503": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Trigger a run of the latest published version of a project.\n\nThis API endpoint is subject to a maximum of 20 requests per minute and 60 requests per hour.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "header", "name": "flag-config-override", "required": false, "schema": { "type": "string" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RunProjectRequestBody" } } } } }, "get": { "operationId": "GetProjectRuns", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectRunsResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get the status of runs of a project.\nBy default, all run types are returned (API-triggered, scheduled, and publish/refresh runs).\nUse the `runTriggerFilter` parameter to filter to a specific type.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "offset", "required": false, "schema": { "$ref": "#/components/schemas/Offset" } }, { "in": "query", "name": "statusFilter", "required": false, "schema": { "$ref": "#/components/schemas/ProjectRunStatus" } }, { "description": "Filter by how the run was triggered\nValid values: `API`, `SCHEDULED`, `APP_REFRESH`", "in": "query", "name": "runTriggerFilter", "required": false, "schema": { "$ref": "#/components/schemas/RunTypeFilter" } } ] } }, "/v1/projects/{projectId}/runs/{runId}": { "get": { "operationId": "GetRunStatus", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatusResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get the status of a project run.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "path", "name": "runId", "required": true, "schema": { "$ref": "#/components/schemas/InputRunId" } }, { "in": "header", "name": "enable-expanded-stats", "required": false, "schema": { "type": "string" } } ] }, "delete": { "operationId": "CancelRun", "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Cancel a project run.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "path", "name": "runId", "required": true, "schema": { "$ref": "#/components/schemas/InputRunId" } } ] } }, "/v1/projects/{projectId}/runs/{runId}/cells/{staticId}/image": { "get": { "operationId": "GetChartImageFromRun", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartImageFromRunResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get the rendered PNG image of a chart cell from a completed run by staticCellId.\nThe \"staticId\" path parameter should be the cell's staticId (which remains stable across project versions),\nas opposed to its cellId (which is scoped to a specific version).\n\nReturns a JSON object containing the base64-encoded PNG image of the chart cell\nas rendered at the time of the specified run, along with project/run/cell IDs and MIME type.\nThe cell must have been executed and must not be in an error state.\nOnly chart-type cells are supported.\n\nThe optional `width` and `height` query params set the output image size in pixels.\nBoth must be provided to apply, and must be between 100 and 2000.\nThe optional `includeTitle` query param includes the chart title in the image when true.\n\nRate limit: 20 requests per minute.", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "path", "name": "runId", "required": true, "schema": { "$ref": "#/components/schemas/InputRunId" } }, { "in": "path", "name": "staticId", "required": true, "schema": { "$ref": "#/components/schemas/StaticCellId" } }, { "in": "query", "name": "width", "required": false, "schema": { "$ref": "#/components/schemas/ChartImageDimension" } }, { "in": "query", "name": "height", "required": false, "schema": { "$ref": "#/components/schemas/ChartImageDimension" } }, { "in": "query", "name": "includeTitle", "required": false, "schema": { "type": "boolean" } } ] } }, "/v1/groups/{groupId}": { "get": { "operationId": "GetGroup", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "groupId", "required": true, "schema": { "$ref": "#/components/schemas/GroupId" } } ] }, "delete": { "operationId": "DeleteGroup", "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "groupId", "required": true, "schema": { "$ref": "#/components/schemas/GroupId" } } ] }, "patch": { "operationId": "EditGroup", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GroupApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "groupId", "required": true, "schema": { "$ref": "#/components/schemas/GroupId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "members": { "properties": { "remove": { "$ref": "#/components/schemas/GroupMembers" }, "add": { "$ref": "#/components/schemas/GroupMembers" } }, "type": "object" }, "name": { "$ref": "#/components/schemas/Name" } }, "type": "object" } } } } } }, "/v1/groups": { "get": { "operationId": "ListGroups", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListGroupsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/LargerPageSize" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "$ref": "#/components/schemas/ListGroupsSortByEnum" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "$ref": "#/components/schemas/SortDirectionEnum" } } ] }, "post": { "operationId": "CreateGroup", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateGroupResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "members": { "$ref": "#/components/schemas/GroupMembers" }, "name": { "$ref": "#/components/schemas/Name" } }, "required": [ "name" ], "type": "object" } } } } } }, "/v1/data-connections/{dataConnectionId}": { "get": { "operationId": "GetDataConnection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectionWithSensitiveFieldsApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "dataConnectionId", "required": true, "schema": { "$ref": "#/components/schemas/DataConnectionId" } } ] }, "patch": { "operationId": "EditDataConnection", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectionWithSensitiveFieldsApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "dataConnectionId", "required": true, "schema": { "$ref": "#/components/schemas/DataConnectionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "workspace": { "properties": { "public": { "$ref": "#/components/schemas/DataConnectionPublicSharingAccessLevelEnum" }, "guests": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "members": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" } }, "type": "object" }, "groups": { "properties": { "upsert": { "items": { "properties": { "access": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "group": { "properties": { "id": { "$ref": "#/components/schemas/GroupId" } }, "required": [ "id" ], "type": "object" } }, "required": [ "access", "group" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "type": "object" }, "schemaRefreshAccess": { "$ref": "#/components/schemas/DataConnectionSchemaRefreshAccess" }, "schemaRefreshSchedule": { "allOf": [ { "$ref": "#/components/schemas/SchemaRefreshScheduleApiResource" } ], "nullable": true }, "schemaFilters": { "properties": { "tables": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "schemas": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "databases": { "$ref": "#/components/schemas/SchemaEntityFilter" } }, "type": "object" }, "allowWritebackCells": { "type": "boolean" }, "includeMagic": { "type": "boolean" }, "connectViaSsh": { "type": "boolean" }, "description": { "type": "string" }, "connectionDetails": { "$ref": "#/components/schemas/EditConnectionDetails" }, "name": { "type": "string" } }, "type": "object" } } } } } }, "/v1/data-connections": { "get": { "operationId": "ListDataConnections", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDataConnectionsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "$ref": "#/components/schemas/ListDataConnectionsSortByEnum" } }, { "in": "query", "name": "sortDirection", "required": false, "schema": { "$ref": "#/components/schemas/SortDirectionEnum" } } ] }, "post": { "operationId": "CreateDataConnection", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataConnectionWithSensitiveFieldsApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "workspace": { "properties": { "public": { "$ref": "#/components/schemas/DataConnectionPublicSharingAccessLevelEnum" }, "guests": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "members": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" } }, "type": "object" }, "groups": { "items": { "properties": { "access": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "group": { "properties": { "id": { "$ref": "#/components/schemas/GroupId" } }, "required": [ "id" ], "type": "object" } }, "required": [ "access", "group" ], "type": "object" }, "type": "array" } }, "type": "object" }, "schemaRefreshAccess": { "$ref": "#/components/schemas/DataConnectionSchemaRefreshAccess" }, "schemaRefreshSchedule": { "$ref": "#/components/schemas/SchemaRefreshScheduleApiResource" }, "schemaFilters": { "properties": { "tables": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "schemas": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "databases": { "$ref": "#/components/schemas/SchemaEntityFilter" } }, "type": "object" }, "allowWritebackCells": { "type": "boolean" }, "includeMagic": { "type": "boolean" }, "connectViaSsh": { "type": "boolean" }, "description": { "type": "string" }, "connectionDetails": { "$ref": "#/components/schemas/CreateConnectionDetails" }, "type": { "$ref": "#/components/schemas/DataConnectionApiType" }, "name": { "$ref": "#/components/schemas/Name" } }, "required": [ "connectionDetails", "type", "name" ], "type": "object" } } } } } }, "/v1/data-connections/{dataConnectionId}/schema": { "patch": { "operationId": "UpdateDataConnectionSchema", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataConnectionSchemaResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Omit_TsoaErrorResponsePayload.details_" }, { "properties": { "details": { "items": { "$ref": "#/components/schemas/UpdateSchemaObjectErrorDetail" }, "type": "array" } }, "type": "object" } ] } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Omit_TsoaErrorResponsePayload.details_" }, { "properties": { "details": { "items": { "$ref": "#/components/schemas/UpdateSchemaObjectErrorDetail" }, "type": "array" } }, "type": "object" } ] } } } } }, "description": "Use this endpoint to add or remove a status (including endorsements) from databases, schemas, and tables\nwithin a data connection\n\nThis endpoint uses atomic semantics - if any update in the batch fails validation,\nthe entire request fails and no changes are applied", "parameters": [ { "in": "path", "name": "dataConnectionId", "required": true, "schema": { "$ref": "#/components/schemas/DataConnectionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDataConnectionSchemaRequest" } } } } } }, "/v1/collections/{collectionId}": { "get": { "operationId": "GetCollection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "$ref": "#/components/schemas/CollectionId" } } ] }, "patch": { "operationId": "EditCollection", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "collectionId", "required": true, "schema": { "$ref": "#/components/schemas/CollectionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "properties": { "upsert": { "$ref": "#/components/schemas/CollectionApiResourceSharing" } }, "type": "object" }, "description": { "type": "string" }, "name": { "$ref": "#/components/schemas/Name" } }, "type": "object" } } } } } }, "/v1/collections": { "get": { "operationId": "ListCollections", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCollectionsResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "sortBy", "required": false, "schema": { "$ref": "#/components/schemas/ListCollectionsSortByEnum" } } ] }, "post": { "operationId": "CreateCollection", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "sharing": { "$ref": "#/components/schemas/CollectionApiResourceSharing" }, "description": { "type": "string" }, "name": { "type": "string" } }, "required": [ "name" ], "type": "object" } } } } } }, "/v1/guides/draft/list": { "get": { "operationId": "ListDraftGuides", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDraftGuidesResponse" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } }, { "description": "A JSON stringified, URI encoded external source locator\nexample: encodeURIComponent(JSON.stringify({\"source\":\"github\",\"owner\":\"my-org\",\"repo\":\"my-repo\",\"baseUrl\":\"https://github.com\"}))", "in": "query", "name": "externalSource", "required": false, "schema": { "default": null, "type": "string" } } ] } }, "/v1/guides/draft": { "put": { "operationId": "UpsertGuideDraft", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertGuideDraftResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Update or create guide drafts by filePath.\n\nAccepts a dictionary mapping file paths to their contents.\nFor each file:\n- If the guide doesn't exist, it will be created.\n- If the guide exists but has no draft, a new draft will be created.\n- If the guide exists with a draft, the draft contents will be updated.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpsertGuideDraftRequestBody" } } } } } }, "/v1/guides/publish": { "post": { "operationId": "PublishGuideDrafts", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishGuidesResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Publish all currently drafted guides.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PublishGuidesRequestBody" } } } } } }, "/v1/guides/draft/{orgGuideFileId}": { "delete": { "operationId": "DeleteGuideDraft", "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "parameters": [ { "in": "path", "name": "orgGuideFileId", "required": true, "schema": { "$ref": "#/components/schemas/OrgGuideFileId" } } ] } }, "/v1/cells": { "get": { "operationId": "ListCells", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CellsListApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "List all cells\n\nReturns cells from the draft version of the project only, not the published app.\nRequires a project id for filtering.\nFor SQL and CODE cells, includes the source code content.", "parameters": [ { "in": "query", "name": "projectId", "required": true, "schema": { "$ref": "#/components/schemas/ProjectId" } }, { "in": "query", "name": "limit", "required": false, "schema": { "$ref": "#/components/schemas/PageSize" } }, { "in": "query", "name": "after", "required": false, "schema": { "default": null } }, { "in": "query", "name": "before", "required": false, "schema": { "default": null } } ] }, "post": { "operationId": "CreateCell", "responses": { "201": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CellApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Create a new cell\n\nCreates a new cell in the draft version of a project.\nCurrently only CODE and SQL cell types are supported.\nRequires EDIT_PROJECT_CONTENTS permission on the project.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "location": { "properties": { "childPosition": { "type": "string", "enum": [ "FIRST", "LAST" ], "description": "Where to place the cell within the parent section. Defaults to LAST." }, "parentCellId": { "$ref": "#/components/schemas/CellId", "description": "Insert the new cell as a child of a section (parent) cell. Use with childPosition to control placement within the section." }, "insertAfterCellId": { "$ref": "#/components/schemas/CellId", "description": "Insert the new cell after this cell ID. The cell must belong to the target project." } }, "type": "object", "description": "Controls where the new cell is placed. If omitted, the cell is appended to the end of the project." }, "contents": { "properties": { "markdownCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" }, "sqlCell": { "properties": { "outputDataframe": { "type": "string" }, "isDataframeSql": { "type": "boolean", "description": "Set to true to create a dataframe SQL cell that queries the outputs of other\nSQL cells in the project instead of a data connection.\nMutually exclusive with dataConnectionId." }, "dataConnectionId": { "$ref": "#/components/schemas/DataConnectionId" }, "source": { "type": "string" } }, "required": [ "source" ], "type": "object" }, "codeCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" } }, "type": "object" }, "label": { "type": "string" }, "cellType": { "type": "string", "enum": [ "CODE", "SQL", "MARKDOWN" ] }, "projectId": { "$ref": "#/components/schemas/ProjectId" } }, "required": [ "contents", "cellType", "projectId" ], "type": "object" } } } } } }, "/v1/cells/{cellId}": { "get": { "operationId": "GetCell", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CellApiResource" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get a single cell by ID\n\nReturns cells from the draft version of the project only, not the published app.\nReturns the cell details including id, staticId, cellType, label, dataConnectionId,\nsource contents (for CODE and SQL cells), and projectId.", "parameters": [ { "in": "path", "name": "cellId", "required": true, "schema": { "$ref": "#/components/schemas/CellId" } } ] }, "patch": { "operationId": "UpdateCell", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CellApiResource" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Update a cell's source and/or data connection\n\nUpdates the source code and/or data connection ID for a cell.\nFor SQL cells, can update SQL source and data connection ID.\nFor code cells, can update code source.\nRequires EDIT_PROJECT_CONTENTS permission on the project containing the cell.", "parameters": [ { "in": "path", "name": "cellId", "required": true, "schema": { "$ref": "#/components/schemas/CellId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "contents": { "properties": { "markdownCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" }, "sqlCell": { "properties": { "outputDataframe": { "type": "string" }, "source": { "type": "string" } }, "required": [ "source" ], "type": "object" }, "codeCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object" } }, "type": "object" }, "dataConnectionId": { "allOf": [ { "$ref": "#/components/schemas/DataConnectionId" } ], "nullable": true } }, "type": "object" } } } } }, "delete": { "operationId": "DeleteCell", "responses": { "204": { "description": "" }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Delete a cell\n\nPermanently deletes a cell from the draft version of a project.\nRequires EDIT_PROJECT_CONTENTS permission on the project containing the cell.", "parameters": [ { "in": "path", "name": "cellId", "required": true, "schema": { "$ref": "#/components/schemas/CellId" } } ] } }, "/v1/cells/{cellId}/image": { "get": { "operationId": "GetChartImageFromLogic", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChartImageResponsePayload" } } } }, "400": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "403": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "404": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "422": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } }, "500": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TsoaErrorResponsePayload" } } } } }, "description": "Get the rendered PNG image of a chart cell from the current notebook session by cellId.\nThe \"cellId\" path parameter should be the cell's ID (scoped to a\nspecific version), as opposed to its staticId (which remains stable across versions).\n\nReturns a JSON object containing the base64-encoded PNG image of the chart cell\nas it currently appears in the Logic view, along with the cell ID and MIME type.\nThe cell must have been executed and must not be in an error state.\nOnly chart-type cells are supported.\n\nThe optional `width` and `height` query params set the output image size in pixels.\nBoth must be provided to apply, and must be between 100 and 2000.\nThe optional `includeTitle` query param includes the chart title in the image when true.\n\nRate limit: 20 requests per minute.", "parameters": [ { "in": "path", "name": "cellId", "required": true, "schema": { "$ref": "#/components/schemas/CellId" } }, { "in": "query", "name": "width", "required": false, "schema": { "$ref": "#/components/schemas/ChartImageDimension" } }, { "in": "query", "name": "height", "required": false, "schema": { "$ref": "#/components/schemas/ChartImageDimension" } }, { "in": "query", "name": "includeTitle", "required": false, "schema": { "type": "boolean" } } ] } }, "/v1/projects/export": { "post": { "operationId": "ExportProject", "summary": "ExportProject", "description": "Exports a Hex project in the *.hex.yaml format.\n\nAvailability of this endpoint varies by organization. Contact Hex support to request access.\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "description": "The project to export." }, "version": { "anyOf": [ { "type": "integer", "minimum": 1 }, { "type": "string", "enum": [ "draft" ] }, { "type": "string", "enum": [ "latest" ] } ], "default": "draft", "description": "Used to specify the version to export. \"draft\" is the current notebook version; \"latest\" is the latest published app version." } }, "required": [ "projectId" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "filename": { "type": "string" }, "content": { "type": "string", "description": "YAML encoded hex project following the *.hex.yaml format" } }, "required": [ "filename", "content" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/threads": { "post": { "operationId": "CreateThread", "summary": "CreateThread", "description": "Start an agent thread with a prompt. The Hex agent will analyze data and respond to the prompt. The thread runs asynchronously — poll its status or visit the returned URL to view progress.\n\nAvailability of this endpoint varies by organization. Contact Hex support to request access.\n\nThis endpoint is subject to the following rate limits:\n- `hex-send-thread-message`: Rate limits for sending messages to threads\n - Dynamic per minute maximum based on Hex traffic\n - Dynamic per hour maximum based on Hex traffic", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "minLength": 1 }, "attachments": { "type": "object", "properties": { "dataConnectionId": { "type": "string", "nullable": true, "description": "Data connection referenced by the prompt" }, "tableIds": { "type": "array", "items": { "type": "string" }, "description": "Tables referenced by the prompt" }, "semanticDatasetIds": { "type": "array", "items": { "type": "string" }, "description": "Semantic datasets referenced by the prompt" }, "semanticViewIds": { "type": "array", "items": { "type": "string" }, "description": "Semantic views referenced by the prompt" }, "projectIds": { "type": "array", "items": { "type": "string" }, "description": "Projects referenced by the prompt" } }, "description": "Entities referenced by the prompt" }, "projectId": { "type": "string", "nullable": true, "description": "Run the thread against an existing project. Mutually exclusive with `newProject`" }, "newProject": { "type": "boolean", "nullable": true, "description": "Create a new project for the thread to work on. Mutually exclusive with `projectId`" } }, "required": [ "prompt" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" }, "url": { "type": "string" }, "createdAt": { "type": "string" }, "projectId": { "type": "string", "nullable": true } }, "required": [ "threadId", "url", "createdAt", "projectId" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } }, "get": { "operationId": "ListThreads", "summary": "ListThreads", "description": "List agent threads in the workspace, sorted by most recently created first. Requires Manager org role or higher. Workspace admins receive every non-private thread; managers receive threads they created plus Threads-type threads on projects they have access to. Threads marked private are returned with their title redacted.\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "parameters": [ { "in": "query", "name": "after", "schema": { "type": "string", "nullable": true, "default": null } }, { "in": "query", "name": "before", "schema": { "type": "string", "nullable": true, "default": null } }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 1, "maximum": 100, "default": 25 } }, { "in": "query", "name": "source", "schema": { "type": "string", "nullable": true, "enum": [ "HEX", "SLACK", "MCP", "PUBLIC_API", null ] } }, { "in": "query", "name": "userId", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threads": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "orgId": { "type": "string" }, "userId": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true, "description": "Title of the thread, when available. Null for private threads" }, "type": { "type": "string", "description": "User-facing label for the type of agent thread" }, "source": { "type": "string", "enum": [ "HEX", "SLACK", "MCP", "TASK", "PUBLIC_API" ] }, "url": { "type": "string" }, "createdAt": { "type": "string" }, "sensitive": { "type": "boolean", "description": "Whether the thread has been marked as sensitive. When true, the thread's contents (such as title) are hidden from callers other than the thread author" } }, "required": [ "id", "orgId", "userId", "title", "type", "source", "url", "createdAt", "sensitive" ] } }, "pagination": { "type": "object", "properties": { "before": { "type": "string", "nullable": true, "default": null }, "after": { "type": "string", "nullable": true, "default": null } }, "required": [ "before", "after" ] } }, "required": [ "threads", "pagination" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.NOT_FOUND" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/threads/{id}": { "get": { "operationId": "GetThread", "summary": "GetThread", "description": "Get the response of an agent thread. Returns the current status (RUNNING, IDLE, or ERROR) and the agent's response content when available.\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" }, "status": { "type": "string", "enum": [ "IDLE", "RUNNING", "ERROR" ] }, "url": { "type": "string" }, "error": { "type": "object", "nullable": true, "properties": { "type": { "type": "string", "enum": [ "NO_CONTEXT", "BAD_DATA", "AGENT_ERROR", "AGENT_OVERLOADED", "GENERIC_ERROR", "POSSIBLE_PROMPT_INJECTION", "OVER_LIMIT", "NO_DATA", "INVALID_RESPONSE", "HALLUCINATED_SCHEMA_ELEMENT", "NON_EXPRESSIBLE", "INVALID_JOIN", "EXPLORE_TIMED_OUT", "EXPLORE_ERRORED", "EXPLORE_TABLE_SWAPPED", "UNSUPPORTED_QUERY_ELEMENTS", "EXPLORE_NO_DATA", "CHART_ROW_LIMIT_EXCEEDED", "BYOK_AUTHENTICATION", "AGENT_COMPRESSION_ERROR", "TOKEN_COUNTING_FAILURE", "REQUEST_CANCELLED", "INVALID_MESSAGE_HISTORY", "INVALID_REQUEST", "DATA_CONNECTION_NOT_AUTHORIZED", "JOIN_VALIDATION_TIMEOUT" ] }, "message": { "type": "string" } }, "required": [ "type", "message" ] }, "response": { "type": "array", "nullable": true, "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "text" ] }, "text": { "type": "string" } }, "required": [ "type", "text" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "cell" ] }, "id": { "type": "string" }, "staticId": { "type": "string" }, "label": { "type": "string", "nullable": true } }, "required": [ "type", "id", "staticId", "label" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "project" ] }, "id": { "type": "string" }, "title": { "type": "string", "nullable": true } }, "required": [ "type", "id", "title" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "task" ] }, "title": { "type": "string" } }, "required": [ "type", "title" ] } ] } } }, "required": [ "threadId", "status", "url", "response" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.NOT_FOUND" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/threads/{id}/followup": { "post": { "operationId": "ContinueThread", "summary": "ContinueThread", "description": "Continue an existing agent thread with a follow-up prompt. This endpoint does not support queuing: the thread must be idle before a follow-up can be sent.\n\nAvailability of this endpoint varies by organization. Contact Hex support to request access.\n\nThis endpoint is subject to the following rate limits:\n- `hex-send-thread-message`: Rate limits for sending messages to threads\n - Dynamic per minute maximum based on Hex traffic\n - Dynamic per hour maximum based on Hex traffic", "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "prompt": { "type": "string", "minLength": 1 }, "attachments": { "type": "object", "properties": { "dataConnectionId": { "type": "string", "nullable": true, "description": "Data connection referenced by the prompt" }, "tableIds": { "type": "array", "items": { "type": "string" }, "description": "Tables referenced by the prompt" }, "semanticDatasetIds": { "type": "array", "items": { "type": "string" }, "description": "Semantic datasets referenced by the prompt" }, "semanticViewIds": { "type": "array", "items": { "type": "string" }, "description": "Semantic views referenced by the prompt" }, "projectIds": { "type": "array", "items": { "type": "string" }, "description": "Projects referenced by the prompt" } }, "description": "Entities referenced by the prompt" } }, "required": [ "prompt" ] } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "threadId": { "type": "string" }, "url": { "type": "string" } }, "required": [ "threadId", "url" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/users/me": { "get": { "operationId": "Me", "summary": "Me", "description": "Returns information about the current logged in user.\nUser metadata will be omitted when authenticating with a workspace token.\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "ADMIN", "MANAGER", "EDITOR", "EXPLORER", "MEMBER", "GUEST", "EMBEDDED_USER", "ANONYMOUS" ] }, "lastLoginDate": { "type": "string", "nullable": true }, "org": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "token": { "type": "object", "nullable": true, "properties": { "exp": { "type": "number", "nullable": true } }, "required": [ "exp" ] } }, "required": [ "id", "name", "email", "role", "lastLoginDate", "org" ] }, { "type": "object", "properties": { "org": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ] }, "token": { "type": "object", "nullable": true, "properties": { "exp": { "type": "number", "nullable": true } }, "required": [ "exp" ] } }, "required": [ "org" ] } ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.NOT_FOUND" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/users": { "get": { "operationId": "ListUsers", "summary": "ListUsers", "description": "List all users in the workspace\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "parameters": [ { "in": "query", "name": "after", "schema": { "type": "string", "nullable": true, "default": null } }, { "in": "query", "name": "before", "schema": { "type": "string", "nullable": true, "default": null } }, { "in": "query", "name": "limit", "schema": { "type": "number", "minimum": 1, "maximum": 500, "default": 25 } }, { "in": "query", "name": "sortBy", "schema": { "type": "string", "enum": [ "NAME", "EMAIL" ], "default": "NAME" } }, { "in": "query", "name": "sortDirection", "schema": { "type": "string", "enum": [ "ASC", "DESC" ], "default": "ASC" } }, { "in": "query", "name": "groupId", "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "values": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "ADMIN", "MANAGER", "EDITOR", "EXPLORER", "MEMBER", "GUEST", "EMBEDDED_USER", "ANONYMOUS" ] }, "lastLoginDate": { "type": "string", "nullable": true } }, "required": [ "id", "name", "email", "role", "lastLoginDate" ] } }, "pagination": { "type": "object", "properties": { "before": { "type": "string", "nullable": true, "default": null }, "after": { "type": "string", "nullable": true, "default": null } }, "required": [ "before", "after" ] } }, "required": [ "values", "pagination" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.NOT_FOUND" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } }, "/v1/users/{userId}/deactivate": { "post": { "operationId": "DeactivateUser", "summary": "DeactivateUser", "description": "Deactivate a user\n\nThis endpoint is subject to the following rate limits:\n- `hex-api`: Default rate limit group for the Hex API\n - Max 30 requests per minute", "parameters": [ { "in": "path", "name": "userId", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "user": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "ADMIN", "MANAGER", "EDITOR", "EXPLORER", "MEMBER", "GUEST", "EMBEDDED_USER", "ANONYMOUS" ] }, "lastLoginDate": { "type": "string", "nullable": true } }, "required": [ "id", "name", "email", "role", "lastLoginDate" ] } }, "required": [ "user" ] } } } }, "400": { "description": "Invalid input data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.BAD_REQUEST" } } } }, "401": { "description": "Authorization not provided", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.UNAUTHORIZED" } } } }, "403": { "description": "Insufficient access", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.FORBIDDEN" } } } }, "500": { "description": "Internal server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/error.INTERNAL_SERVER_ERROR" } } } } } } } }, "components": { "schemas": { "EmbeddingResponse": { "properties": { "url": { "type": "string" } }, "required": [ "url" ], "type": "object", "additionalProperties": false }, "TraceId": { "type": "string", "description": "A unique identifier for this API request. The Hex Support team may request this value when debugging an issue." }, "TsoaErrorResponsePayload": { "properties": { "details": { "type": "string" }, "traceId": { "$ref": "#/components/schemas/TraceId" }, "reason": { "type": "string" } }, "required": [ "reason" ], "type": "object" }, "EmbeddingRequest": { "properties": { "hexUserAttributes": { "properties": {}, "additionalProperties": { "type": "string" }, "type": "object", "description": "A map of attributes meant to populate hex_user_attributes in the app for the running user. This must be a string to string map. For more complexity, you can do json serialization", "example": { "orgId": "my-org-id", "groupId": "my-group-id" } }, "scope": { "items": { "type": "string" }, "type": "array", "description": "Optionally include additional permissions for a user to do in an embedded app. Valid scopes include:\n\nEXPORT_PDF: allow users to download the app as a pdf\nEXPORT_CSV: allow users to download CSVs from tables" }, "inputParameters": { "properties": {}, "additionalProperties": {}, "type": "object", "description": "Optionall sets default values for input states. The keys are the names of the inputs and the values are the default values for those inputs." }, "expiresIn": { "type": "number", "format": "double", "description": "Optionally specify the expiration time of the embedding url in milliseconds.\nThis represents the maximum allowed time between receiving the API response with the single-use signed URL, and requesting the signed URL for the iframe.\nDefault is 15 seconds. Maximum value is 300 seconds (5 minutes).", "default": "15000" }, "displayOptions": { "properties": { "theme": { "type": "string", "enum": [ "light", "dark" ] }, "showEmbeddedRunButton": { "type": "boolean", "description": "The showEmbeddedRunButton parameter will ensure the run button always shows up in the embedded app navbar" }, "noEmbedHeaderPadding": { "type": "boolean", "description": "The noEmbedHeaderPadding parameter removes the top padding added to apps with no tabs." }, "noEmbedBasePadding": { "type": "boolean", "description": "The noEmbedBasePadding parameter removes the padding around the embedded app container" }, "noEmbedOutline": { "type": "boolean", "description": "The noEmbedOutline parameter removes the border around the embedded app" }, "noEmbedFooter": { "type": "boolean", "description": "The noEmbedFooter parameter removes the Hex-branded footer at the bottom of the embedded app" } }, "additionalProperties": {}, "type": "object", "description": "Optionally customize the display of the embedded app" }, "testMode": { "type": "boolean", "description": "Run the embed API call in test mode. Does not run the app and will not count towards rate limits or embedding usage counts." } }, "type": "object", "additionalProperties": {} }, "ProjectId": { "type": "string", "format": "uuid", "description": "Unique ID for a Hex project. This can be found in the Variables side bar of the Logic View of a project, or by visiting the Project, and copying the UUID after `hex` in the URL.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "EnumValues_typeofProjectTypeApiEnum_": { "type": "string", "enum": [ "PROJECT", "COMPONENT" ] }, "ProjectTypeApiEnum": { "$ref": "#/components/schemas/EnumValues_typeofProjectTypeApiEnum_", "description": "The type of the ProjectApiResource being returned." }, "Timestamp": { "type": "string", "format": "timestamp", "description": "An ISO 8601 timestamp with timezone like 1970-01-01T00:00:00Z." }, "EnumValues_typeofScheduleCadenceApiEnum_": { "type": "string", "enum": [ "HOURLY", "DAILY", "WEEKLY", "MONTHLY", "CUSTOM" ] }, "ScheduleCadenceApiEnum": { "$ref": "#/components/schemas/EnumValues_typeofScheduleCadenceApiEnum_", "description": "Types of cadence of a schedule for a Hex project." }, "TimezoneDesignator": { "type": "string", "description": "An ISO 8601 timezone designator like +08:00." }, "EnumValues_typeofDayOfWeekApiEnum_": { "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "DayOfWeekApiEnum": { "$ref": "#/components/schemas/EnumValues_typeofDayOfWeekApiEnum_" }, "ScheduleApiResource": { "properties": { "cadence": { "$ref": "#/components/schemas/ScheduleCadenceApiEnum" }, "enabled": { "type": "boolean" }, "hourly": { "properties": { "timezone": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 } }, "required": [ "timezone", "minute" ], "type": "object", "nullable": true }, "daily": { "properties": { "timezone": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 } }, "required": [ "timezone", "minute", "hour" ], "type": "object", "nullable": true }, "weekly": { "properties": { "timezone": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 }, "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeekApiEnum" } }, "required": [ "timezone", "minute", "hour", "dayOfWeek" ], "type": "object", "nullable": true }, "monthly": { "properties": { "timezone": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 }, "day": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 28 } }, "required": [ "timezone", "minute", "hour", "day" ], "type": "object", "nullable": true }, "custom": { "properties": { "timezone": { "$ref": "#/components/schemas/TimezoneDesignator" }, "cron": { "type": "string" } }, "required": [ "timezone", "cron" ], "type": "object", "nullable": true } }, "required": [ "cadence", "enabled", "hourly", "daily", "weekly", "monthly", "custom" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofAccessLevelEnum_": { "type": "string", "enum": [ "NONE", "APP_ONLY", "CAN_VIEW", "CAN_EDIT", "FULL_ACCESS" ] }, "AccessLevelEnum": { "$ref": "#/components/schemas/EnumValues_typeofAccessLevelEnum_", "description": "Access level granted by sharing endpoints.\nFor projects, `CAN_VIEW` is the API value that corresponds to the UI permission labeled \"Can explore\".\n`APP_ONLY` is the API value that corresponds to the UI permission labeled \"Can view app\"." }, "SharingResource": { "properties": { "users": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "user": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" } }, "required": [ "access", "user" ], "type": "object" }, "type": "array" }, "collections": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "collection": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "access", "collection" ], "type": "object" }, "type": "array" }, "groups": { "items": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" }, "group": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object" } }, "required": [ "access", "group" ], "type": "object" }, "type": "array" }, "workspace": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" } }, "required": [ "access" ], "type": "object" }, "publicWeb": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" } }, "required": [ "access" ], "type": "object" }, "support": { "properties": { "access": { "$ref": "#/components/schemas/AccessLevelEnum" } }, "required": [ "access" ], "type": "object" } }, "required": [ "users", "collections", "groups", "workspace", "publicWeb", "support" ], "type": "object", "additionalProperties": false }, "ProjectApiResource": { "properties": { "id": { "$ref": "#/components/schemas/ProjectId" }, "title": { "type": "string" }, "description": { "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ProjectTypeApiEnum" }, "creator": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "owner": { "properties": { "email": { "type": "string" } }, "required": [ "email" ], "type": "object" }, "status": { "properties": { "name": { "type": "string" } }, "required": [ "name" ], "type": "object", "nullable": true }, "categories": { "items": { "properties": { "description": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "description", "name" ], "type": "object" }, "type": "array" }, "reviews": { "properties": { "required": { "type": "boolean" } }, "required": [ "required" ], "type": "object" }, "analytics": { "properties": { "publishedResultsUpdatedAt": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "nullable": true }, "lastViewedAt": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "nullable": true }, "appViews": { "properties": { "lastThirtyDays": { "type": "integer", "format": "int32" }, "lastFourteenDays": { "type": "integer", "format": "int32" }, "lastSevenDays": { "type": "integer", "format": "int32" }, "allTime": { "type": "integer", "format": "int32" } }, "required": [ "lastThirtyDays", "lastFourteenDays", "lastSevenDays", "allTime" ], "type": "object" } }, "required": [ "publishedResultsUpdatedAt", "lastViewedAt", "appViews" ], "type": "object" }, "lastEditedAt": { "$ref": "#/components/schemas/Timestamp" }, "lastPublishedAt": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "nullable": true }, "createdAt": { "$ref": "#/components/schemas/Timestamp" }, "archivedAt": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "nullable": true }, "trashedAt": { "allOf": [ { "$ref": "#/components/schemas/Timestamp" } ], "nullable": true }, "schedules": { "items": { "$ref": "#/components/schemas/ScheduleApiResource" }, "type": "array" }, "sharing": { "$ref": "#/components/schemas/SharingResource" } }, "required": [ "id", "title", "description", "type", "creator", "owner", "status", "categories", "reviews", "analytics", "lastEditedAt", "lastPublishedAt", "createdAt", "archivedAt", "trashedAt", "schedules" ], "type": "object", "additionalProperties": false }, "ResponseRunId": { "type": "string", "format": "uuid", "description": "Unique ID for a run of a Hex project", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ProjectRunStatus": { "description": "Current status of a project run", "enum": [ "PENDING", "RUNNING", "ERRORED", "COMPLETED", "KILLED", "UNABLE_TO_ALLOCATE_KERNEL" ], "type": "string" }, "RunUrl": { "type": "string", "description": "URL to view the current progress of the project run in the Hex UI" }, "NotebookProjectRunResponsePayload": { "properties": { "projectId": { "$ref": "#/components/schemas/ProjectId" }, "runId": { "$ref": "#/components/schemas/ResponseRunId" }, "status": { "$ref": "#/components/schemas/ProjectRunStatus" }, "url": { "$ref": "#/components/schemas/RunUrl" }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "projectId", "runId", "status", "url", "traceId" ], "type": "object", "additionalProperties": false }, "ProjectVersionId": { "type": "string", "format": "uuid", "description": "Unique ID for a Hex project version.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "CellId": { "type": "string", "format": "uuid", "description": "Unique ID for a cell. This can be found by going into the menu of a cell in the notebook.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ImportProjectWarningsApiResource": { "properties": { "categories": { "items": { "type": "string" }, "type": "array", "nullable": true }, "components": { "items": { "properties": { "version": { "type": "string" }, "componentId": { "type": "string" } }, "required": [ "version", "componentId" ], "type": "object" }, "type": "array", "nullable": true }, "status": { "type": "string", "nullable": true }, "projectSecrets": { "items": { "type": "string" }, "type": "array", "nullable": true }, "sharedSecrets": { "items": { "type": "string" }, "type": "array", "nullable": true }, "projectDataConnectionIds": { "items": { "type": "string" }, "type": "array", "nullable": true }, "sharedDataConnections": { "items": { "type": "string" }, "type": "array", "nullable": true }, "sharedVcsPackages": { "items": { "type": "string" }, "type": "array", "nullable": true }, "projectTitle": { "type": "string", "nullable": true }, "projectLanguage": { "type": "string", "nullable": true }, "cellIds": { "items": { "$ref": "#/components/schemas/CellId" }, "type": "array", "nullable": true }, "appLayout": { "items": { "type": "string" }, "type": "array", "nullable": true }, "timezones": { "items": { "type": "string" }, "type": "array", "nullable": true }, "externalFileIntegrations": { "items": { "type": "string" }, "type": "array", "nullable": true }, "exportedHexType": { "type": "string", "nullable": true }, "semanticProjects": { "items": { "type": "string" }, "type": "array", "nullable": true } }, "required": [ "categories", "components", "status", "projectSecrets", "sharedSecrets", "projectDataConnectionIds", "sharedDataConnections", "sharedVcsPackages", "projectTitle", "projectLanguage", "cellIds", "appLayout", "timezones", "externalFileIntegrations", "exportedHexType", "semanticProjects" ], "type": "object", "additionalProperties": false }, "ImportProjectApiResource": { "properties": { "projectId": { "$ref": "#/components/schemas/ProjectId" }, "hexVersionId": { "$ref": "#/components/schemas/ProjectVersionId" }, "warnings": { "$ref": "#/components/schemas/ImportProjectWarningsApiResource" } }, "required": [ "projectId", "hexVersionId", "warnings" ], "type": "object", "additionalProperties": false }, "ApiPaginationCursor": { "type": "string", "description": "A cursor string used with `before` and `after` parameters to paginate through a list\nof items on the API." }, "PaginationApiResource": { "properties": { "after": { "allOf": [ { "$ref": "#/components/schemas/ApiPaginationCursor" } ], "nullable": true }, "before": { "allOf": [ { "$ref": "#/components/schemas/ApiPaginationCursor" } ], "nullable": true } }, "required": [ "after", "before" ], "type": "object", "additionalProperties": false }, "ProjectsListApiResource": { "properties": { "values": { "items": { "$ref": "#/components/schemas/ProjectApiResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" } }, "required": [ "values", "pagination" ], "type": "object", "additionalProperties": false }, "PageSize": { "type": "integer", "format": "int32", "default": "25", "description": "Number of results to fetch per page for paginated requests", "minimum": 1, "maximum": 100 }, "EnumValues_typeofSortByEnum_": { "type": "string", "enum": [ "CREATED_AT", "LAST_EDITED_AT", "LAST_PUBLISHED_AT" ] }, "SortByEnum": { "$ref": "#/components/schemas/EnumValues_typeofSortByEnum_" }, "EnumValues_typeofSortDirectionEnum_": { "type": "string", "enum": [ "DESC", "ASC" ] }, "SortDirectionEnum": { "$ref": "#/components/schemas/EnumValues_typeofSortDirectionEnum_" }, "DataConnectionId": { "type": "string", "format": "uuid", "description": "Unique ID for a data connection.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ProjectQueriedTableResource": { "properties": { "dataConnectionId": { "$ref": "#/components/schemas/DataConnectionId" }, "dataConnectionName": { "type": "string" }, "tableName": { "type": "string" } }, "required": [ "dataConnectionId", "dataConnectionName", "tableName" ], "type": "object", "additionalProperties": false }, "ProjectQueriedTablesApiResource": { "properties": { "values": { "items": { "$ref": "#/components/schemas/ProjectQueriedTableResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" }, "traceId": { "type": "string" } }, "required": [ "values", "pagination", "traceId" ], "type": "object", "additionalProperties": false }, "CollectionId": { "type": "string", "format": "uuid", "description": "Unique ID for a collection.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ShareProjectWithCollectionError": { "properties": { "collectionIds": { "items": { "$ref": "#/components/schemas/CollectionId" }, "type": "array" }, "reason": { "type": "string" } }, "required": [ "collectionIds", "reason" ], "type": "object", "additionalProperties": false }, "EditProjectSharingCollectionsResponse": { "properties": { "project": { "$ref": "#/components/schemas/ProjectApiResource" }, "errors": { "items": { "$ref": "#/components/schemas/ShareProjectWithCollectionError" }, "type": "array" } }, "required": [ "project" ], "type": "object", "additionalProperties": false }, "ShareProjectWithWorkspaceError": { "properties": { "type": { "type": "string", "enum": [ "workspace", "publicWeb" ] }, "reason": { "type": "string" } }, "required": [ "type", "reason" ], "type": "object", "additionalProperties": false }, "EditProjectSharingWorkspaceAndPublicResponse": { "properties": { "project": { "$ref": "#/components/schemas/ProjectApiResource" }, "errors": { "items": { "$ref": "#/components/schemas/ShareProjectWithWorkspaceError" }, "type": "array" } }, "required": [ "project" ], "type": "object", "additionalProperties": false }, "PublicWebAccessLevel": { "$ref": "#/components/schemas/EnumValues_typeofAccessLevelEnum_" }, "GroupId": { "type": "string", "format": "uuid", "description": "Unique ID for a group. This can be found from the groups page (in Settings).", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ShareProjectWithGroupError": { "properties": { "groupIds": { "items": { "$ref": "#/components/schemas/GroupId" }, "type": "array" }, "reason": { "type": "string" } }, "required": [ "groupIds", "reason" ], "type": "object", "additionalProperties": false }, "EditProjectSharingGroupsResponse": { "properties": { "project": { "$ref": "#/components/schemas/ProjectApiResource" }, "errors": { "items": { "$ref": "#/components/schemas/ShareProjectWithGroupError" }, "type": "array" } }, "required": [ "project" ], "type": "object", "additionalProperties": false }, "UserId": { "type": "string", "format": "uuid", "description": "Unique ID for a user. This can be found from the users page (in Settings).", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ShareProjectWithUserError": { "properties": { "userIds": { "items": { "$ref": "#/components/schemas/UserId" }, "type": "array" }, "reason": { "type": "string" } }, "required": [ "userIds", "reason" ], "type": "object", "additionalProperties": false }, "EditProjectSharingUsersResponse": { "properties": { "project": { "$ref": "#/components/schemas/ProjectApiResource" }, "errors": { "items": { "$ref": "#/components/schemas/ShareProjectWithUserError" }, "type": "array" } }, "required": [ "project" ], "type": "object", "additionalProperties": false }, "ProblemSeverity": { "type": "string", "enum": [ "fatal", "error", "warning" ] }, "ProblemMessage": { "type": "string" }, "ProblemKeyPath": { "items": { "anyOf": [ { "type": "string" }, { "type": "number", "format": "double" } ] }, "type": "array" }, "HexSLTypes.PublicProblem": { "description": "A problem encountered during the import of a public HexSL project.", "properties": { "severity": { "$ref": "#/components/schemas/ProblemSeverity" }, "message": { "$ref": "#/components/schemas/ProblemMessage" }, "cause_paths": { "items": { "$ref": "#/components/schemas/ProblemKeyPath" }, "type": "array" }, "impact_paths": { "items": { "$ref": "#/components/schemas/ProblemKeyPath" }, "type": "array" }, "validated_by_json_schema": { "type": "boolean" } }, "required": [ "severity", "message", "cause_paths", "impact_paths" ], "type": "object", "additionalProperties": false }, "HexSLProblemWithDisplay": { "allOf": [ { "$ref": "#/components/schemas/HexSLTypes.PublicProblem" }, { "properties": { "display": { "type": "string" } }, "required": [ "display" ], "type": "object" } ] }, "Record_string.Record_string.HexSLTypes.DataType__": { "properties": {}, "type": "object", "description": "Construct a type with a set of properties K of type T" }, "MetricflowModelSchemas": { "$ref": "#/components/schemas/Record_string.Record_string.HexSLTypes.DataType__" }, "SemanticProjectsSyncResponsePayload": { "properties": { "traceId": { "type": "string" }, "contents": { "items": { "type": "string" }, "type": "array" }, "warnings": { "items": { "type": "string" }, "type": "array" }, "skipped": { "properties": {}, "additionalProperties": {}, "type": "object" }, "problems": { "items": { "$ref": "#/components/schemas/HexSLProblemWithDisplay" }, "type": "array" }, "debug": { "properties": { "metricflowModelSchemas": { "$ref": "#/components/schemas/MetricflowModelSchemas" } }, "type": "object" } }, "required": [ "traceId", "contents" ], "type": "object", "additionalProperties": false }, "SemanticProjectId": { "type": "string", "format": "uuid", "description": "Unique ID for a Hex semantic project. This can be found from the semantic\nprojects admin panel (in Settings).", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "UpdateSemanticProjectResponse": { "description": "Response body for successful status updates", "properties": { "updated": { "properties": { "views": { "items": { "properties": { "status": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "status", "name" ], "type": "object" }, "type": "array" }, "datasets": { "items": { "properties": { "status": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "status", "name" ], "type": "object" }, "type": "array" } }, "required": [ "views", "datasets" ], "type": "object" } }, "required": [ "updated" ], "type": "object", "additionalProperties": false }, "SemanticObjectUpdate": { "description": "A single update for a semantic object (dataset or view)\nCurrently, only status updates are supported.", "properties": { "type": { "type": "string", "enum": [ "DATASET", "VIEW" ], "description": "The type of object to update" }, "name": { "type": "string", "description": "The name of the dataset or view" }, "status": { "type": "string", "nullable": true, "description": "The status name to apply, or null to remove the current status" } }, "required": [ "type", "name", "status" ], "type": "object", "additionalProperties": false }, "UpdateSemanticProjectRequest": { "description": "Request body for updating semantic datasets and views\nCurrently, only status updates are supported.", "properties": { "updates": { "items": { "$ref": "#/components/schemas/SemanticObjectUpdate" }, "type": "array", "description": "Array of updates to apply" } }, "required": [ "updates" ], "type": "object", "additionalProperties": false }, "Pick_TsoaErrorResponsePayload.Exclude_keyofTsoaErrorResponsePayload.details__": { "properties": { "reason": { "type": "string" }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "reason" ], "type": "object", "description": "From T, pick a set of properties whose keys are in the union K" }, "Omit_TsoaErrorResponsePayload.details_": { "$ref": "#/components/schemas/Pick_TsoaErrorResponsePayload.Exclude_keyofTsoaErrorResponsePayload.details__", "description": "Construct a type with the properties of T except for those in type K." }, "UpdateStatusErrorDetail": { "description": "Details about a failed update", "properties": { "name": { "type": "string", "description": "The name of the dataset or view" }, "type": { "type": "string", "enum": [ "DATASET", "VIEW" ], "description": "The type of object" }, "reason": { "type": "string", "enum": [ "not_found", "invalid_status" ], "description": "The reason for the failure" }, "value": { "type": "string", "description": "The invalid value (for invalid_status errors)" } }, "required": [ "name", "type", "reason" ], "type": "object", "additionalProperties": false }, "RunStatusUrl": { "type": "string", "description": "URL to query the status of the project run via the Hex API" }, "ProjectVersion": { "type": "integer", "format": "int32", "description": "The version of the Hex project that was run. Project versions are ordered, starting at 1 and incrementing on each saved version. Project versions can be found in the History & Versions side bar of the Logic View." }, "RunNotificationType": { "description": "The condition that determines whether or not the notification should be delivered based on these types.", "enum": [ "SUCCESS", "FAILURE", "ALL" ], "type": "string" }, "NotificationRecipientType": { "description": "The delivery type of a notification recipient.", "enum": [ "USER", "GROUP", "SLACK_CHANNEL" ], "type": "string" }, "ScreenshotFormatType": { "type": "string", "enum": [ "png", "pdf" ], "description": "The file format of the generated screenshot." }, "NotificationRecipient": { "properties": { "id": { "type": "string", "description": "The Id of the recipient. For users and groups, these Ids are found in the settings panel in Hex, while the Id for Slack can be found within the Slack app or URL.", "example": "C0123456" }, "name": { "type": "string", "description": "The human readable name for the user, group, or Slack channel.", "example": "data-team" }, "isPrivate": { "type": "boolean", "description": "Whether or not the Slack channel is a private channel in the Slack workspace.", "example": false } }, "required": [ "id", "name" ], "type": "object", "additionalProperties": false }, "ProjectRunNotificationRecipient": { "description": "The recipient of a project run notification, which will include the type of recipient and additional configuration details.\nThis is used to determine who to send the notification to, and what triggers would qualify sending the notification.", "properties": { "type": { "$ref": "#/components/schemas/RunNotificationType" }, "subject": { "type": "string" }, "body": { "type": "string" }, "recipientType": { "$ref": "#/components/schemas/NotificationRecipientType" }, "includeSuccessScreenshot": { "type": "boolean", "description": "If true, a screenshot of the project will be included in the notification when the project succeeds." }, "screenshotFormat": { "items": { "$ref": "#/components/schemas/ScreenshotFormatType" }, "type": "array", "description": "The format of the screenshot to be included in the notification.\nDefaults to png only if not specified and includeSuccessScreenshot is true." }, "recipient": { "$ref": "#/components/schemas/NotificationRecipient" } }, "required": [ "type", "recipientType", "includeSuccessScreenshot", "recipient" ], "type": "object", "additionalProperties": false }, "ProjectRunResponsePayload": { "description": "Response format returned by the runProject endpoint", "properties": { "projectId": { "$ref": "#/components/schemas/ProjectId" }, "runId": { "$ref": "#/components/schemas/ResponseRunId" }, "runUrl": { "$ref": "#/components/schemas/RunUrl" }, "runStatusUrl": { "$ref": "#/components/schemas/RunStatusUrl" }, "traceId": { "$ref": "#/components/schemas/TraceId" }, "projectVersion": { "$ref": "#/components/schemas/ProjectVersion" }, "notifications": { "items": { "$ref": "#/components/schemas/ProjectRunNotificationRecipient" }, "type": "array" } }, "required": [ "projectId", "runId", "runUrl", "runStatusUrl", "traceId", "projectVersion" ], "type": "object", "additionalProperties": false }, "NotFoundParam": { "type": "string", "description": "Name of an input parameter passed to the API call that was not found in the project." }, "InvalidParam": { "properties": { "dataType": { "type": "string", "description": "The expected data type of the parameter (number, string, etc.), which the input value should have matched" }, "inputCellType": { "type": "string", "description": "The cell input type of the parameter (text, slider, etc.)" }, "paramValue": { "type": "string", "description": "The JSON-encoded, invalid value for the parameter" }, "paramName": { "type": "string", "description": "The name of the parameter for which an invalid value was provided" } }, "required": [ "dataType", "inputCellType", "paramValue", "paramName" ], "type": "object", "description": "Information about an input parameter pass to the API call that could not be parsed." }, "InvalidParamPayload": { "properties": { "traceId": { "$ref": "#/components/schemas/TraceId" }, "invalid": { "items": { "$ref": "#/components/schemas/InvalidParam" }, "type": "array", "description": "Array of specified input parameters that were invalid or could not be parsed" }, "notFound": { "items": { "$ref": "#/components/schemas/NotFoundParam" }, "type": "array", "description": "Array of specified input parameter names that were not found in the project" } }, "required": [ "traceId", "invalid", "notFound" ], "type": "object" }, "ProjectRunNotification": { "description": "The configuration details for notifications, which are sent after a run has completed.", "properties": { "type": { "$ref": "#/components/schemas/RunNotificationType" }, "includeSuccessScreenshot": { "type": "boolean", "description": "If true, a screenshot of the project will be included in the notification when the project succeeds." }, "screenshotFormat": { "$ref": "#/components/schemas/ScreenshotFormatType", "description": "The format of the screenshot to be included in the notification.\nDefaults to png if not specified and includeSuccessScreenshot is true." }, "slackChannelIds": { "items": { "type": "string" }, "type": "array", "description": "The Slack channels to send the notification to.\nThe Hex Slackbot must be added to any private channels included.\nThe Slack Channel Id can be found in the channel's settings from within the Slack app." }, "userIds": { "items": { "type": "string" }, "type": "array", "description": "The Hex user Ids to send the notification to. These Ids can be found and copied from the Setting's User panel in Hex." }, "groupIds": { "items": { "type": "string" }, "type": "array", "description": "The Hex group Ids to send the notification to. These Ids can be found and copied from the Setting's Group panel in Hex." }, "subject": { "type": "string", "description": "An optional message to use as the subject of the notification." }, "body": { "type": "string", "description": "An optional message to include in the body of the notification." } }, "required": [ "type", "includeSuccessScreenshot" ], "type": "object", "additionalProperties": false }, "RunProjectRequestBody": { "description": "Request body format for triggering a project run", "properties": { "inputParams": { "properties": {}, "additionalProperties": {}, "type": "object", "description": "Optionally specify input parameters for this project run.\nThese should be structured as a dictionary of key/value pairs, where the key name matches the name of the variable in the Hex project.\n\nOnly parameters that are added to the published app can be set via this request parameter. Any additional inputs will be ignored.\nIt is invalid to pass in both a viewId and inputParams.\n\nIf no input parameters are provided, the project will be run with the default input values.\nNote that if input parameters are provided, this run will not be able to update the cached values for the project, and the updateCache setting (below) will be ignored.", "example": { "text_input_1": "Hello World", "numeric_input_1": 123 } }, "dryRun": { "type": "boolean", "description": "When true, this endpoint will perform a dry run that does not run the project. This can be useful for validating the structure of an API call, and inspecting a dummy response, without running a project.", "default": "false" }, "updateCache": { "type": "boolean", "deprecated": true }, "notifications": { "items": { "$ref": "#/components/schemas/ProjectRunNotification" }, "type": "array", "description": "Optionally specify a list of notification details that will be delivered once a project run completes.\nNotifications can be configured for delivery to Slack channels, Hex users, or Hex groups.", "example": [ { "type": "ALL", "includeSuccessScreenshot": "true", "slackChannelIds": [ "C0000000" ], "userIds": [ "uuid-user-1", "uuid-user-2" ] }, { "type": "FAILURE", "includeSuccessScreenshot": "false", "userIds": [ "uuid-user-1" ], "groupIds": [ "uuid-group-1" ] } ] }, "updatePublishedResults": { "type": "boolean", "description": "When true, the cached state of the published app will be updated with the latest\nrun results. You must have at least \"Can Edit\" permissions on the project to do so.\nNote: this cannot be set to true if custom input parameters are provided.", "default": "false" }, "useCachedSqlResults": { "type": "boolean", "description": "When false, the project will run without using any cached SQL results, and will\nupdate those cached SQL results.", "default": "true" }, "viewId": { "type": "string", "description": "Optionally specify a SavedView viewId to use for the project run. If specified, the saved view's inputs will be used for the project run.\nIt is invalid to pass in both a viewId and inputParams.\nIf not specified, the default inputs will be used." } }, "type": "object", "additionalProperties": false }, "ProjectStatusRunTrigger": { "type": "string", "enum": [ "API", "SCHEDULED", "APP_REFRESH" ], "description": "How a run of a project was triggered (`API`, `SCHEDULED`, or `APP_REFRESH`)" }, "StateEvent": { "description": "Response format returned by the runProject endpoint", "properties": { "type": { "type": "string" }, "value": { "type": "string" }, "timestamp": { "type": "string" } }, "required": [ "type", "value", "timestamp" ], "type": "object", "additionalProperties": false }, "ProjectStatusResponsePayload": { "description": "Response format returned by the getRunStatus endpoint", "properties": { "projectId": { "$ref": "#/components/schemas/ProjectId" }, "projectVersion": { "$ref": "#/components/schemas/ProjectVersion" }, "runId": { "$ref": "#/components/schemas/ResponseRunId" }, "runUrl": { "$ref": "#/components/schemas/RunUrl" }, "status": { "$ref": "#/components/schemas/ProjectRunStatus" }, "runTrigger": { "$ref": "#/components/schemas/ProjectStatusRunTrigger", "description": "How the run was triggered: `API`, `SCHEDULED`, or `APP_REFRESH`" }, "startTime": { "type": "string", "format": "date-time", "nullable": true, "description": "UTC timestamp of when the project run started" }, "endTime": { "type": "string", "format": "date-time", "nullable": true, "description": "UTC timestamp of when the project run finished" }, "elapsedTime": { "type": "number", "format": "double", "nullable": true, "description": "Total elapsed time for the project run in milliseconds" }, "flagConfigOverride": { "type": "string" }, "traceId": { "$ref": "#/components/schemas/TraceId" }, "notifications": { "items": { "$ref": "#/components/schemas/ProjectRunNotificationRecipient" }, "type": "array" }, "stateEvents": { "items": { "$ref": "#/components/schemas/StateEvent" }, "type": "array" } }, "required": [ "projectId", "projectVersion", "runId", "runUrl", "status", "runTrigger", "startTime", "endTime", "elapsedTime", "traceId" ], "type": "object", "additionalProperties": false }, "InputRunId": { "type": "string", "format": "uuid", "description": "Unique ID for a run of a Hex project. This ID is part of the response returned by the RunProject endpoint. The GetProjectRuns endpoint can also be used to find the specific runs for a project.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "NextPageUrl": { "type": "string", "description": "URL to fetch the next page of results for a paginated API request" }, "ProjectRunsResponsePayload": { "properties": { "runs": { "items": { "$ref": "#/components/schemas/ProjectStatusResponsePayload" }, "type": "array", "description": "Array of run status payloads in the same format returned by the `GetRunStatus` endpoint" }, "nextPage": { "allOf": [ { "$ref": "#/components/schemas/NextPageUrl" } ], "nullable": true }, "previousPage": { "allOf": [ { "$ref": "#/components/schemas/NextPageUrl" } ], "nullable": true }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "runs", "nextPage", "previousPage", "traceId" ], "type": "object", "additionalProperties": false }, "Offset": { "type": "integer", "format": "int32", "default": "0", "description": "Offset for paginated requests", "minimum": 0 }, "EnumValues_typeofRunTypeFilter_": { "type": "string", "enum": [ "API", "SCHEDULED", "APP_REFRESH", "ALL" ] }, "RunTypeFilter": { "$ref": "#/components/schemas/EnumValues_typeofRunTypeFilter_" }, "StaticCellId": { "type": "string", "format": "uuid", "description": "Unique static ID for a cell. This can be found by going into the menu of a cell in the notebook.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "ChartImageFromRunResponsePayload": { "properties": { "projectId": { "$ref": "#/components/schemas/ProjectId" }, "runId": { "$ref": "#/components/schemas/InputRunId" }, "staticId": { "$ref": "#/components/schemas/StaticCellId" }, "imageBase64": { "type": "string" }, "mimeType": { "type": "string" } }, "required": [ "projectId", "runId", "staticId", "imageBase64", "mimeType" ], "type": "object", "additionalProperties": false }, "ChartImageDimension": { "type": "integer", "format": "int32", "description": "Chart image total dimension (width or height) in pixels.", "minimum": 100, "maximum": 2000 }, "GroupApiResource": { "properties": { "id": { "$ref": "#/components/schemas/GroupId" }, "name": { "type": "string" }, "createdAt": { "$ref": "#/components/schemas/Timestamp" } }, "required": [ "id", "name", "createdAt" ], "type": "object", "additionalProperties": false }, "ListGroupsResponse": { "properties": { "values": { "items": { "$ref": "#/components/schemas/GroupApiResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" } }, "required": [ "values", "pagination" ], "type": "object", "additionalProperties": false }, "LargerPageSize": { "type": "integer", "format": "int32", "default": "25", "description": "Number of results to fetch per page for paginated requests", "minimum": 1, "maximum": 500 }, "EnumValues_typeofListGroupsSortByEnum_": { "type": "string", "enum": [ "CREATED_AT", "NAME" ] }, "ListGroupsSortByEnum": { "$ref": "#/components/schemas/EnumValues_typeofListGroupsSortByEnum_" }, "Name": { "type": "string", "minLength": 1 }, "GroupMembers": { "properties": { "users": { "items": { "properties": { "id": { "$ref": "#/components/schemas/UserId" } }, "required": [ "id" ], "type": "object" }, "type": "array", "maxItems": 100 } }, "type": "object", "additionalProperties": false }, "CreateGroupResponse": { "properties": { "id": { "$ref": "#/components/schemas/GroupId" }, "name": { "$ref": "#/components/schemas/Name" }, "members": { "$ref": "#/components/schemas/GroupMembers" } }, "required": [ "id", "name", "members" ], "type": "object", "additionalProperties": false }, "ReadableConnectionDetails": { "anyOf": [ { "properties": { "athena": { "properties": { "accessKeyId": { "type": "string" }, "workgroup": { "type": "string", "nullable": true }, "catalog": { "type": "string", "nullable": true }, "s3OutputPath": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "athena" ], "type": "object" }, { "properties": { "bigquery": { "properties": { "enableStorageApi": { "type": "boolean" }, "enableDriveAccess": { "type": "boolean" }, "projectId": { "type": "string" } }, "type": "object" } }, "required": [ "bigquery" ], "type": "object" }, { "properties": { "clickhouse": { "properties": { "username": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "clickhouse" ], "type": "object" }, { "properties": { "databricks": { "properties": { "jdbcUrl": { "type": "string" } }, "type": "object" } }, "required": [ "databricks" ], "type": "object" }, { "properties": { "postgres": { "properties": { "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "postgres" ], "type": "object" }, { "properties": { "redshift": { "properties": { "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "host": { "type": "string" } }, "type": "object" } }, "required": [ "redshift" ], "type": "object" }, { "properties": { "snowflake": { "properties": { "role": { "type": "string", "nullable": true }, "username": { "type": "string" }, "schema": { "type": "string", "nullable": true }, "database": { "type": "string" }, "warehouse": { "type": "string" }, "accountName": { "type": "string" } }, "type": "object" } }, "required": [ "snowflake" ], "type": "object" }, { "properties": { "trino": { "properties": { "sessionProperties": { "items": { "properties": { "value": { "type": "string" }, "key": { "type": "string" } }, "required": [ "value", "key" ], "type": "object" }, "type": "array" }, "username": { "type": "string" }, "schema": { "type": "string" }, "catalog": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "trino" ], "type": "object" } ] }, "EnumValues_typeofSchemaFilterMatchType_": { "type": "string", "enum": [ "EXACT", "PREFIX", "REGEX", "SUFFIX" ] }, "SchemaFilterMatchType": { "$ref": "#/components/schemas/EnumValues_typeofSchemaFilterMatchType_" }, "SchemaEntityFilter": { "properties": { "exclude": { "properties": { "values": { "items": { "type": "string" }, "type": "array" }, "matchType": { "$ref": "#/components/schemas/SchemaFilterMatchType" } }, "required": [ "values", "matchType" ], "type": "object" }, "include": { "properties": { "values": { "items": { "type": "string" }, "type": "array" }, "matchType": { "$ref": "#/components/schemas/SchemaFilterMatchType" } }, "required": [ "values", "matchType" ], "type": "object" } }, "type": "object" }, "TimezoneStringDesignator": { "type": "string" }, "SchemaRefreshScheduleApiResource": { "properties": { "cadence": { "$ref": "#/components/schemas/ScheduleCadenceApiEnum" }, "enabled": { "type": "boolean" }, "daily": { "properties": { "timezoneString": { "$ref": "#/components/schemas/TimezoneStringDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 } }, "required": [ "timezoneString", "minute", "hour" ], "type": "object", "nullable": true }, "weekly": { "properties": { "timezoneString": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 }, "dayOfWeek": { "$ref": "#/components/schemas/DayOfWeekApiEnum" } }, "required": [ "timezoneString", "minute", "hour", "dayOfWeek" ], "type": "object", "nullable": true }, "monthly": { "properties": { "timezoneString": { "$ref": "#/components/schemas/TimezoneDesignator" }, "minute": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 59 }, "hour": { "type": "integer", "format": "int32", "minimum": 0, "maximum": 23 }, "day": { "type": "integer", "format": "int32", "minimum": 1, "maximum": 28 } }, "required": [ "timezoneString", "minute", "hour", "day" ], "type": "object", "nullable": true }, "custom": { "properties": { "timezoneString": { "$ref": "#/components/schemas/TimezoneDesignator" }, "cron": { "type": "string" } }, "required": [ "timezoneString", "cron" ], "type": "object", "nullable": true } }, "required": [ "cadence", "enabled" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofDataConnectionSchemaRefreshAccess_": { "type": "string", "enum": [ "ADMINS", "USERS_WITH_QUERY_ACCESS" ] }, "DataConnectionSchemaRefreshAccess": { "$ref": "#/components/schemas/EnumValues_typeofDataConnectionSchemaRefreshAccess_" }, "EnumValues_typeofDataConnectionSharingAccessLevelEnum_": { "type": "string", "enum": [ "NONE", "QUERY", "VIEW_RESULTS" ] }, "DataConnectionSharingAccessLevelEnum": { "$ref": "#/components/schemas/EnumValues_typeofDataConnectionSharingAccessLevelEnum_" }, "EnumValues_typeofDataConnectionApiType_": { "type": "string", "enum": [ "athena", "bigquery", "clickhouse", "databricks", "postgres", "redshift", "snowflake", "trino" ] }, "DataConnectionApiType": { "$ref": "#/components/schemas/EnumValues_typeofDataConnectionApiType_" }, "DataConnectionWithSensitiveFieldsApiResource": { "properties": { "id": { "$ref": "#/components/schemas/DataConnectionId" }, "name": { "$ref": "#/components/schemas/Name" }, "type": { "$ref": "#/components/schemas/DataConnectionApiType" }, "description": { "type": "string" }, "connectionDetails": { "allOf": [ { "$ref": "#/components/schemas/ReadableConnectionDetails" } ], "nullable": true }, "connectViaSsh": { "type": "boolean" }, "includeMagic": { "type": "boolean" }, "allowWritebackCells": { "type": "boolean" }, "schemaFilters": { "properties": { "tables": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "schemas": { "$ref": "#/components/schemas/SchemaEntityFilter" }, "databases": { "$ref": "#/components/schemas/SchemaEntityFilter" } }, "type": "object" }, "schemaRefreshSchedule": { "$ref": "#/components/schemas/SchemaRefreshScheduleApiResource" }, "schemaRefreshAccess": { "$ref": "#/components/schemas/DataConnectionSchemaRefreshAccess" }, "sharing": { "properties": { "workspace": { "properties": { "public": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "guests": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "members": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" } }, "type": "object" }, "groups": { "items": { "properties": { "access": { "$ref": "#/components/schemas/DataConnectionSharingAccessLevelEnum" }, "group": { "properties": { "name": { "type": "string" }, "id": { "$ref": "#/components/schemas/GroupId" } }, "required": [ "name", "id" ], "type": "object" } }, "required": [ "access", "group" ], "type": "object" }, "type": "array" } }, "type": "object" } }, "required": [ "id", "name", "type", "connectionDetails", "connectViaSsh", "includeMagic", "allowWritebackCells", "schemaRefreshAccess", "sharing" ], "type": "object", "additionalProperties": false }, "DataConnectionApiResource": { "properties": { "id": { "$ref": "#/components/schemas/DataConnectionId" }, "name": { "$ref": "#/components/schemas/Name" }, "type": { "$ref": "#/components/schemas/DataConnectionApiType" }, "description": { "type": "string" } }, "required": [ "id", "name", "type" ], "type": "object", "additionalProperties": false }, "ListDataConnectionsResponse": { "properties": { "values": { "items": { "anyOf": [ { "$ref": "#/components/schemas/DataConnectionApiResource" }, { "$ref": "#/components/schemas/DataConnectionWithSensitiveFieldsApiResource" } ] }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" } }, "required": [ "values", "pagination" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofListDataConnectionsSortByEnum_": { "type": "string", "enum": [ "CREATED_AT", "NAME" ] }, "ListDataConnectionsSortByEnum": { "$ref": "#/components/schemas/EnumValues_typeofListDataConnectionsSortByEnum_" }, "CreateConnectionDetails": { "anyOf": [ { "properties": { "athena": { "properties": { "secretAccessKey": { "type": "string" }, "accessKeyId": { "type": "string" }, "workgroup": { "type": "string", "nullable": true }, "catalog": { "type": "string", "nullable": true }, "s3OutputPath": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "required": [ "secretAccessKey", "accessKeyId", "s3OutputPath", "port", "hostname" ], "type": "object" } }, "required": [ "athena" ], "type": "object" }, { "properties": { "bigquery": { "properties": { "serviceAccountJsonConfig": { "type": "string" }, "enableStorageApi": { "type": "boolean" }, "enableDriveAccess": { "type": "boolean" }, "projectId": { "type": "string" } }, "required": [ "serviceAccountJsonConfig", "projectId" ], "type": "object" } }, "required": [ "bigquery" ], "type": "object" }, { "properties": { "databricks": { "properties": { "accessToken": { "type": "string" }, "jdbcUrl": { "type": "string" } }, "required": [ "accessToken", "jdbcUrl" ], "type": "object" } }, "required": [ "databricks" ], "type": "object" }, { "properties": { "postgres": { "properties": { "password": { "type": "string" }, "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "required": [ "password", "username", "database", "port", "hostname" ], "type": "object" } }, "required": [ "postgres" ], "type": "object" }, { "properties": { "redshift": { "properties": { "sslRootCert": { "type": "string", "nullable": true }, "password": { "type": "string" }, "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "host": { "type": "string" } }, "required": [ "password", "username", "database", "port", "host" ], "type": "object" } }, "required": [ "redshift" ], "type": "object" }, { "properties": { "snowflake": { "properties": { "role": { "type": "string", "nullable": true }, "passphrase": { "type": "string" }, "privateKey": { "type": "string" }, "username": { "type": "string" }, "schema": { "type": "string", "nullable": true }, "database": { "type": "string" }, "warehouse": { "type": "string" }, "accountName": { "type": "string" } }, "required": [ "passphrase", "privateKey", "username", "database", "warehouse", "accountName" ], "type": "object" } }, "required": [ "snowflake" ], "type": "object" }, { "properties": { "trino": { "properties": { "sessionProperties": { "items": { "properties": { "value": { "type": "string" }, "key": { "type": "string" } }, "required": [ "value", "key" ], "type": "object" }, "type": "array", "nullable": true }, "password": { "type": "string" }, "username": { "type": "string" }, "schema": { "type": "string" }, "catalog": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "required": [ "username", "port", "hostname" ], "type": "object" } }, "required": [ "trino" ], "type": "object" } ] }, "EnumValues_typeofDataConnectionPublicSharingAccessLevelEnum_": { "type": "string", "enum": [ "NONE", "VIEW_RESULTS" ] }, "DataConnectionPublicSharingAccessLevelEnum": { "$ref": "#/components/schemas/EnumValues_typeofDataConnectionPublicSharingAccessLevelEnum_" }, "EditConnectionDetails": { "anyOf": [ { "properties": { "athena": { "properties": { "secretAccessKey": { "type": "string" }, "accessKeyId": { "type": "string" }, "workgroup": { "type": "string", "nullable": true }, "catalog": { "type": "string", "nullable": true }, "s3OutputPath": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "athena" ], "type": "object" }, { "properties": { "bigquery": { "properties": { "serviceAccountJsonConfig": { "type": "string" }, "enableStorageApi": { "type": "boolean" }, "enableDriveAccess": { "type": "boolean" }, "projectId": { "type": "string" } }, "type": "object" } }, "required": [ "bigquery" ], "type": "object" }, { "properties": { "databricks": { "properties": { "accessToken": { "type": "string" }, "jdbcUrl": { "type": "string" } }, "type": "object" } }, "required": [ "databricks" ], "type": "object" }, { "properties": { "postgres": { "properties": { "password": { "type": "string" }, "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "postgres" ], "type": "object" }, { "properties": { "redshift": { "properties": { "sslRootCert": { "type": "string", "nullable": true }, "password": { "type": "string" }, "username": { "type": "string" }, "database": { "type": "string" }, "port": { "type": "number", "format": "double" }, "host": { "type": "string" } }, "type": "object" } }, "required": [ "redshift" ], "type": "object" }, { "properties": { "snowflake": { "properties": { "role": { "type": "string", "nullable": true }, "passphrase": { "type": "string" }, "privateKey": { "type": "string" }, "username": { "type": "string" }, "schema": { "type": "string", "nullable": true }, "database": { "type": "string" }, "warehouse": { "type": "string" }, "accountName": { "type": "string" } }, "type": "object" } }, "required": [ "snowflake" ], "type": "object" }, { "properties": { "trino": { "properties": { "sessionProperties": { "items": { "properties": { "value": { "type": "string" }, "key": { "type": "string" } }, "required": [ "value", "key" ], "type": "object" }, "type": "array", "nullable": true }, "password": { "type": "string" }, "username": { "type": "string" }, "schema": { "type": "string" }, "catalog": { "type": "string" }, "port": { "type": "number", "format": "double" }, "hostname": { "type": "string" } }, "type": "object" } }, "required": [ "trino" ], "type": "object" } ] }, "UpdateDataConnectionSchemaResponse": { "description": "Response body for successful schema object status updates", "properties": { "updated": { "properties": { "tables": { "items": { "properties": { "status": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "status", "name" ], "type": "object" }, "type": "array" }, "schemas": { "items": { "properties": { "status": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "status", "name" ], "type": "object" }, "type": "array" }, "databases": { "items": { "properties": { "status": { "type": "string", "nullable": true }, "name": { "type": "string" } }, "required": [ "status", "name" ], "type": "object" }, "type": "array" } }, "required": [ "tables", "schemas", "databases" ], "type": "object" } }, "required": [ "updated" ], "type": "object", "additionalProperties": false }, "SchemaObjectUpdate": { "description": "Schema object update request - specifies a status change for a database, schema, or table.\nCurrently, only status updates are supported.", "properties": { "type": { "type": "string", "enum": [ "DATABASE", "SCHEMA", "TABLE" ], "description": "The type of object to update" }, "name": { "type": "string", "description": "The name of the object - simple for DATABASE, qualified for SCHEMA/TABLE" }, "status": { "type": "string", "nullable": true, "description": "The status name to apply, or null to remove the current status" } }, "required": [ "type", "name", "status" ], "type": "object", "additionalProperties": false }, "UpdateDataConnectionSchemaRequest": { "description": "Request body for updating data connection schema object statuses\nCurrently, only status updates are supported.", "properties": { "updates": { "items": { "$ref": "#/components/schemas/SchemaObjectUpdate" }, "type": "array", "description": "Array of updates to apply" } }, "required": [ "updates" ], "type": "object", "additionalProperties": false }, "UpdateSchemaObjectErrorDetail": { "description": "Details about a failed update", "properties": { "name": { "type": "string", "description": "The name of the object" }, "type": { "type": "string", "enum": [ "DATABASE", "SCHEMA", "TABLE" ], "description": "The type of object" }, "reason": { "type": "string", "enum": [ "not_found", "invalid_status", "ambiguous_name", "database_not_supported", "invalid_name_format" ], "description": "The reason for the failure" }, "value": { "type": "string", "description": "The invalid value (for invalid_status errors) or additional context" } }, "required": [ "name", "type", "reason" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofCollectionAccess_": { "type": "string" }, "CollectionAccess": { "$ref": "#/components/schemas/EnumValues_typeofCollectionAccess_" }, "CollectionApiResourceSharing": { "properties": { "users": { "items": { "properties": { "access": { "$ref": "#/components/schemas/CollectionAccess" }, "id": { "$ref": "#/components/schemas/UserId" } }, "required": [ "access", "id" ], "type": "object" }, "type": "array" }, "groups": { "items": { "properties": { "access": { "$ref": "#/components/schemas/CollectionAccess" }, "id": { "$ref": "#/components/schemas/GroupId" } }, "required": [ "access", "id" ], "type": "object" }, "type": "array" }, "workspace": { "properties": { "members": { "$ref": "#/components/schemas/CollectionAccess" } }, "type": "object" } }, "type": "object", "additionalProperties": false }, "CollectionApiResource": { "properties": { "id": { "$ref": "#/components/schemas/CollectionId" }, "name": { "$ref": "#/components/schemas/Name" }, "description": { "type": "string" }, "creator": { "properties": { "email": { "type": "string" }, "id": { "$ref": "#/components/schemas/UserId" } }, "required": [ "email", "id" ], "type": "object" }, "sharing": { "$ref": "#/components/schemas/CollectionApiResourceSharing" } }, "required": [ "id", "name", "sharing" ], "type": "object", "additionalProperties": false }, "ListCollectionsResponse": { "properties": { "values": { "items": { "$ref": "#/components/schemas/CollectionApiResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" } }, "required": [ "values", "pagination" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofListCollectionsSortByEnum_": { "type": "string", "enum": [ "NAME" ], "nullable": false }, "ListCollectionsSortByEnum": { "$ref": "#/components/schemas/EnumValues_typeofListCollectionsSortByEnum_" }, "OrgGuideFileId": { "type": "string", "format": "uuid", "description": "Unique ID for a guide file. This can be found by going into the menu of a guide file in the guide files side bar.", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$" }, "GuideFileApiResource": { "properties": { "id": { "$ref": "#/components/schemas/OrgGuideFileId", "description": "The unique ID of the guide file." }, "filePath": { "type": "string", "description": "The file path of the guide file.\nexample: \"guide.md\"" } }, "required": [ "id", "filePath" ], "type": "object", "additionalProperties": false }, "ListDraftGuidesResponse": { "properties": { "values": { "items": { "$ref": "#/components/schemas/GuideFileApiResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "values", "pagination", "traceId" ], "type": "object", "additionalProperties": false }, "UpsertGuideDraftResponsePayload": { "properties": { "files": { "items": { "$ref": "#/components/schemas/GuideFileApiResource" }, "type": "array" }, "warnings": { "items": { "properties": { "message": { "type": "string" }, "filePath": { "type": "string" } }, "required": [ "message", "filePath" ], "type": "object" }, "type": "array" }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "files", "warnings", "traceId" ], "type": "object", "additionalProperties": false }, "UnknownExternalSourceLocatorInput": { "properties": { "id": { "type": "string", "description": "An optional identifier that can be used to distinguish between different unspecified external sources." }, "source": { "type": "string", "enum": [ "unknown" ], "nullable": false } }, "required": [ "source" ], "type": "object" }, "UnknownExternalSourceInput": { "$ref": "#/components/schemas/UnknownExternalSourceLocatorInput" }, "GithubExternalSourceLocatorInput": { "properties": { "repo": { "type": "string", "description": "The name of the github repository." }, "owner": { "type": "string", "description": "The owner of the github repository." }, "base": { "type": "string", "description": "The base URL of the github instance. This is usually `https://github.com` (default) unless uploaded from a self-hosted github instance." }, "source": { "type": "string", "enum": [ "github" ], "nullable": false } }, "required": [ "repo", "owner", "source" ], "type": "object" }, "GithubExternalSourceLocatorWithMetadataInput": { "allOf": [ { "$ref": "#/components/schemas/GithubExternalSourceLocatorInput" }, { "properties": { "branch": { "type": "string", "description": "The git branch for the uploaded version of the guide file\ne.g. `main`" }, "commitHash": { "type": "string", "description": "The git commit hash for the uploaded version of the guide file" } }, "required": [ "branch", "commitHash" ], "type": "object" } ] }, "GithubExternalSourceInput": { "allOf": [ { "$ref": "#/components/schemas/GithubExternalSourceLocatorWithMetadataInput" }, { "properties": { "path": { "type": "string", "description": "The path to the guide file within the github repository\ne.g. `guides/guide.md`" } }, "required": [ "path" ], "type": "object" } ] }, "ExternalSourceInput": { "anyOf": [ { "$ref": "#/components/schemas/UnknownExternalSourceInput" }, { "$ref": "#/components/schemas/GithubExternalSourceInput" } ], "description": "A unique identifier for a file that is sourced from an external source.\nThis is used to track the where the guide file was authored from and where we expect updates to come from." }, "UpsertGuideDraftRequestBody": { "properties": { "forceWrite": { "type": "boolean", "description": "If true, will overwrite an existing guide that is synced from a different source if there is a guide of the same name\ne.g. guide1.md is authored in Hex, request.files includes guide1.md -> this will overwrite the guide that was authored in Hex\n\ndefault: false" }, "files": { "items": { "properties": { "externalSource": { "$ref": "#/components/schemas/ExternalSourceInput", "description": "The external source identifier for the guide file. This is used to track the where the guide file was authored from and where we expect updates to come from." }, "contents": { "type": "string", "description": "The contents of the guide file. Maximum length is 100000 characters.", "maxLength": 100000 }, "filePath": { "type": "string", "description": "The file path of the guide file.\nexample: \"guide.md\"" } }, "additionalProperties": {}, "required": [ "contents", "filePath" ], "type": "object" }, "type": "array", "description": "A mapping from filePath -> contents" } }, "required": [ "files" ], "type": "object", "additionalProperties": false }, "PublishGuidesResponsePayload": { "properties": { "message": { "type": "string" }, "publishedGuides": { "items": { "$ref": "#/components/schemas/GuideFileApiResource" }, "type": "array" }, "traceId": { "$ref": "#/components/schemas/TraceId" } }, "required": [ "message", "publishedGuides", "traceId" ], "type": "object", "additionalProperties": false }, "PublishGuidesRequestBody": { "properties": { "orgGuideFileIds": { "items": { "$ref": "#/components/schemas/OrgGuideFileId" }, "type": "array", "description": "The IDs of the guides to publish if publishAllGuides is false." }, "publishAllDraftGuides": { "type": "boolean", "description": "Publish all draft guides (ignores the orgGuideFileIds field if true)" } }, "type": "object", "additionalProperties": false }, "CreateContextVersionResponse": { "properties": { "contextVersionId": { "type": "string" }, "orgId": { "type": "string" }, "traceId": { "type": "string" } }, "required": [ "contextVersionId", "orgId", "traceId" ], "type": "object", "additionalProperties": false }, "UnknownExternalSourceLocatorWithMetadataInput": { "$ref": "#/components/schemas/UnknownExternalSourceLocatorInput" }, "ExternalSourceLocatorWithMetadataInput": { "anyOf": [ { "$ref": "#/components/schemas/UnknownExternalSourceLocatorWithMetadataInput" }, { "$ref": "#/components/schemas/GithubExternalSourceLocatorWithMetadataInput" } ] }, "CreateContextVersionRequestBody": { "properties": { "externalSource": { "$ref": "#/components/schemas/ExternalSourceLocatorWithMetadataInput", "description": "The external source that the context changeset is sourced from" } }, "required": [ "externalSource" ], "type": "object", "additionalProperties": false }, "UpdateContextVersionOperationResult": { "anyOf": [ { "properties": { "warnings": { "items": { "properties": { "message": { "type": "string" }, "filePath": { "type": "string" } }, "required": [ "message", "filePath" ], "type": "object" }, "type": "array" }, "noops": { "items": { "properties": { "filePath": { "type": "string" } }, "required": [ "filePath" ], "type": "object" }, "type": "array" }, "files": { "items": { "properties": { "result": { "type": "string", "enum": [ "created", "updated" ] }, "filePath": { "type": "string" }, "id": { "type": "string" } }, "required": [ "result", "filePath", "id" ], "type": "object" }, "type": "array" }, "type": { "type": "string", "enum": [ "upsert_guide" ], "nullable": false } }, "required": [ "warnings", "noops", "files", "type" ], "type": "object" }, { "properties": { "removedGuides": { "items": { "properties": { "externalSource": { "allOf": [ { "$ref": "#/components/schemas/ExternalSourceInput" } ], "nullable": true }, "hexFilePath": { "type": "string" } }, "required": [ "externalSource", "hexFilePath" ], "type": "object" }, "type": "array" }, "type": { "type": "string", "enum": [ "prune_guides" ], "nullable": false } }, "required": [ "removedGuides", "type" ], "type": "object" } ] }, "UpdateContextVersionResponse": { "properties": { "contextVersionId": { "type": "string" }, "result": { "$ref": "#/components/schemas/UpdateContextVersionOperationResult" }, "traceId": { "type": "string" } }, "required": [ "contextVersionId", "result", "traceId" ], "type": "object", "additionalProperties": false }, "ExternalSourceLocatorInput": { "anyOf": [ { "$ref": "#/components/schemas/UnknownExternalSourceLocatorInput" }, { "$ref": "#/components/schemas/GithubExternalSourceLocatorInput" } ], "description": "A locator that points to an external source that could include a bunch of context. For example, a github repository" }, "UpdateContextVersionOperation": { "anyOf": [ { "properties": { "forceWrite": { "type": "boolean", "description": "If true, will overwrite an existing guide that is synced from a different source if there is a guide of the same name" }, "files": { "items": { "properties": { "externalSource": { "$ref": "#/components/schemas/ExternalSourceInput", "description": "The external source that the guide is sourced from" }, "contents": { "type": "string", "description": "The contents of the guide" }, "filePath": { "type": "string", "description": "The file path of the guide that will show up in Hex" } }, "required": [ "contents", "filePath" ], "type": "object" }, "type": "array" }, "type": { "type": "string", "enum": [ "upsert_guide" ], "nullable": false, "description": "Upsert one or more guides against the draft version" } }, "required": [ "files", "type" ], "type": "object" }, { "properties": { "externalSource": { "$ref": "#/components/schemas/ExternalSourceLocatorInput", "description": "The external source that the guides are sourced from - this is used to figure out which guides Hex expects to be synced and which guides should be deleted" }, "guideFilePaths": { "items": { "type": "string" }, "type": "array", "description": "The file paths of the guides that currently exist in the repo" }, "type": { "type": "string", "enum": [ "prune_guides" ], "nullable": false, "description": "Prune guides that are not present in the supplied guidesFilePaths" } }, "required": [ "externalSource", "guideFilePaths", "type" ], "type": "object" } ] }, "UpdateContextVersionRequestBody": { "properties": { "operation": { "$ref": "#/components/schemas/UpdateContextVersionOperation" } }, "required": [ "operation" ], "type": "object", "additionalProperties": false }, "PublishContextVersionResponse": { "properties": { "contextVersionId": { "type": "string" } }, "required": [ "contextVersionId" ], "type": "object", "additionalProperties": false }, "PublishContextVersionRequestBody": { "properties": { "updateLatestVersion": { "type": "boolean", "description": "If true, will also update the latest version of the context with the changes from the draft version" }, "title": { "type": "string", "description": "A short, human-readable name for the version." }, "description": { "type": "string", "description": "A long, human-readable representation for the version." } }, "required": [ "updateLatestVersion" ], "type": "object", "additionalProperties": false }, "EnumValues_typeofCellType_": { "type": "string", "enum": [ "CODE", "MARKDOWN", "DISPLAY_TABLE", "INPUT", "SQL", "VEGA_CHART", "CELL_GROUP", "METRIC", "TEXT", "MAP", "WRITEBACK", "DBT_METRIC", "PIVOT", "FILTER", "COMPONENT_IMPORT", "CHART", "BLOCK", "EXPLORE", "COLLAPSIBLE" ] }, "CellType": { "$ref": "#/components/schemas/EnumValues_typeofCellType_" }, "CellApiResource": { "properties": { "id": { "$ref": "#/components/schemas/CellId" }, "staticId": { "$ref": "#/components/schemas/StaticCellId" }, "cellType": { "$ref": "#/components/schemas/CellType" }, "label": { "type": "string", "nullable": true }, "dataConnectionId": { "allOf": [ { "$ref": "#/components/schemas/DataConnectionId" } ], "nullable": true }, "contents": { "properties": { "markdownCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object", "nullable": true }, "sqlCell": { "properties": { "outputDataframe": { "type": "string" }, "source": { "type": "string" } }, "required": [ "outputDataframe", "source" ], "type": "object", "nullable": true }, "codeCell": { "properties": { "source": { "type": "string" } }, "required": [ "source" ], "type": "object", "nullable": true } }, "required": [ "markdownCell", "sqlCell", "codeCell" ], "type": "object" }, "projectId": { "$ref": "#/components/schemas/ProjectId" } }, "required": [ "id", "staticId", "cellType", "label", "dataConnectionId", "contents", "projectId" ], "type": "object", "additionalProperties": false }, "CellsListApiResource": { "properties": { "values": { "items": { "$ref": "#/components/schemas/CellApiResource" }, "type": "array" }, "pagination": { "$ref": "#/components/schemas/PaginationApiResource" } }, "required": [ "values", "pagination" ], "type": "object", "additionalProperties": false }, "CellRunResponsePayload": { "properties": { "cellId": { "$ref": "#/components/schemas/CellId" }, "runId": { "allOf": [ { "$ref": "#/components/schemas/ResponseRunId" } ], "nullable": true, "description": "The run ID. Null when dryRun is true." }, "status": { "type": "string", "enum": [ "PENDING", "RUNNING" ] }, "runUrl": { "allOf": [ { "$ref": "#/components/schemas/RunUrl" } ], "nullable": true, "description": "URL to view the run. Null when dryRun is true." }, "runStatusUrl": { "allOf": [ { "$ref": "#/components/schemas/RunStatusUrl" } ], "nullable": true, "description": "URL to check run status. Null when dryRun is true." }, "traceId": { "$ref": "#/components/schemas/TraceId" }, "dryRun": { "type": "boolean", "description": "True if this was a dry run (validation only, no execution)." } }, "required": [ "cellId", "runId", "status", "runUrl", "runStatusUrl", "traceId" ], "type": "object", "additionalProperties": false }, "ChartImageResponsePayload": { "properties": { "cellId": { "$ref": "#/components/schemas/CellId" }, "imageBase64": { "type": "string" }, "mimeType": { "type": "string" } }, "required": [ "cellId", "imageBase64", "mimeType" ], "type": "object", "additionalProperties": false }, "error.BAD_REQUEST": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message", "example": "Invalid input data" }, "code": { "type": "string", "description": "The error code", "example": "BAD_REQUEST" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "description": "An array of issues that were responsible for the error", "example": [] } }, "required": [ "message", "code" ], "title": "Invalid input data error (400)", "description": "The error information", "example": { "code": "BAD_REQUEST", "message": "Invalid input data", "issues": [] } }, "error.UNAUTHORIZED": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message", "example": "Authorization not provided" }, "code": { "type": "string", "description": "The error code", "example": "UNAUTHORIZED" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "description": "An array of issues that were responsible for the error", "example": [] } }, "required": [ "message", "code" ], "title": "Authorization not provided error (401)", "description": "The error information", "example": { "code": "UNAUTHORIZED", "message": "Authorization not provided", "issues": [] } }, "error.FORBIDDEN": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message", "example": "Insufficient access" }, "code": { "type": "string", "description": "The error code", "example": "FORBIDDEN" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "description": "An array of issues that were responsible for the error", "example": [] } }, "required": [ "message", "code" ], "title": "Insufficient access error (403)", "description": "The error information", "example": { "code": "FORBIDDEN", "message": "Insufficient access", "issues": [] } }, "error.INTERNAL_SERVER_ERROR": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message", "example": "Internal server error" }, "code": { "type": "string", "description": "The error code", "example": "INTERNAL_SERVER_ERROR" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "description": "An array of issues that were responsible for the error", "example": [] } }, "required": [ "message", "code" ], "title": "Internal server error error (500)", "description": "The error information", "example": { "code": "INTERNAL_SERVER_ERROR", "message": "Internal server error", "issues": [] } }, "error.NOT_FOUND": { "type": "object", "properties": { "message": { "type": "string", "description": "The error message", "example": "Not found" }, "code": { "type": "string", "description": "The error code", "example": "NOT_FOUND" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "message": { "type": "string" } }, "required": [ "message" ] }, "description": "An array of issues that were responsible for the error", "example": [] } }, "required": [ "message", "code" ], "title": "Not found error (404)", "description": "The error information", "example": { "code": "NOT_FOUND", "message": "Not found", "issues": [] } } }, "responses": {}, "parameters": {}, "examples": {}, "requestBodies": {}, "headers": {}, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } }