| { |
| "responses": { |
| "200": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { |
| "columns": { "items": { "type": "object" }, "type": "array" }, |
| "data": { "items": { "type": "object" }, "type": "array" }, |
| "expanded_columns": { |
| "items": { "type": "object" }, |
| "type": "array" |
| }, |
| "query": { |
| "properties": { |
| "changed_on": { "format": "date-time", "type": "string" }, |
| "ctas": { "type": "boolean" }, |
| "db": { "type": "string" }, |
| "dbId": { "type": "integer" }, |
| "endDttm": { "type": "number" }, |
| "errorMessage": { "nullable": true, "type": "string" }, |
| "executedSql": { "type": "string" }, |
| "extra": { "type": "object" }, |
| "id": { "type": "string" }, |
| "limit": { "type": "integer" }, |
| "limitingFactor": { "type": "string" }, |
| "progress": { "type": "integer" }, |
| "queryId": { "type": "integer" }, |
| "resultsKey": { "type": "string" }, |
| "rows": { "type": "integer" }, |
| "schema": { "type": "string" }, |
| "serverId": { "type": "integer" }, |
| "sql": { "type": "string" }, |
| "sqlEditorId": { "type": "string" }, |
| "startDttm": { "type": "number" }, |
| "state": { "type": "string" }, |
| "tab": { "type": "string" }, |
| "tempSchema": { "nullable": true, "type": "string" }, |
| "tempTable": { "nullable": true, "type": "string" }, |
| "trackingUrl": { "nullable": true, "type": "string" }, |
| "user": { "type": "string" }, |
| "userId": { "type": "integer" } |
| }, |
| "type": "object", |
| "title": "QueryResult" |
| }, |
| "query_id": { "type": "integer" }, |
| "selected_columns": { |
| "items": { "type": "object" }, |
| "type": "array" |
| }, |
| "status": { "type": "string" } |
| }, |
| "type": "object", |
| "title": "QueryExecutionResponseSchema" |
| }, |
| "example": { |
| "columns": [{}], |
| "data": [{}], |
| "expanded_columns": [{}], |
| "query": {}, |
| "query_id": 1, |
| "selected_columns": [{}], |
| "status": "string" |
| } |
| } |
| }, |
| "description": "Query execution result" |
| }, |
| "202": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { |
| "columns": { "items": { "type": "object" }, "type": "array" }, |
| "data": { "items": { "type": "object" }, "type": "array" }, |
| "expanded_columns": { |
| "items": { "type": "object" }, |
| "type": "array" |
| }, |
| "query": { |
| "properties": { |
| "changed_on": { "format": "date-time", "type": "string" }, |
| "ctas": { "type": "boolean" }, |
| "db": { "type": "string" }, |
| "dbId": { "type": "integer" }, |
| "endDttm": { "type": "number" }, |
| "errorMessage": { "nullable": true, "type": "string" }, |
| "executedSql": { "type": "string" }, |
| "extra": { "type": "object" }, |
| "id": { "type": "string" }, |
| "limit": { "type": "integer" }, |
| "limitingFactor": { "type": "string" }, |
| "progress": { "type": "integer" }, |
| "queryId": { "type": "integer" }, |
| "resultsKey": { "type": "string" }, |
| "rows": { "type": "integer" }, |
| "schema": { "type": "string" }, |
| "serverId": { "type": "integer" }, |
| "sql": { "type": "string" }, |
| "sqlEditorId": { "type": "string" }, |
| "startDttm": { "type": "number" }, |
| "state": { "type": "string" }, |
| "tab": { "type": "string" }, |
| "tempSchema": { "nullable": true, "type": "string" }, |
| "tempTable": { "nullable": true, "type": "string" }, |
| "trackingUrl": { "nullable": true, "type": "string" }, |
| "user": { "type": "string" }, |
| "userId": { "type": "integer" } |
| }, |
| "type": "object", |
| "title": "QueryResult" |
| }, |
| "query_id": { "type": "integer" }, |
| "selected_columns": { |
| "items": { "type": "object" }, |
| "type": "array" |
| }, |
| "status": { "type": "string" } |
| }, |
| "type": "object", |
| "title": "QueryExecutionResponseSchema" |
| }, |
| "example": { |
| "columns": [{}], |
| "data": [{}], |
| "expanded_columns": [{}], |
| "query": {}, |
| "query_id": 1, |
| "selected_columns": [{}], |
| "status": "string" |
| } |
| } |
| }, |
| "description": "Query execution result, query still running" |
| }, |
| "400": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { "message": { "type": "string" } }, |
| "type": "object" |
| }, |
| "example": { "message": "Bad request: Invalid parameters provided" } |
| } |
| }, |
| "description": "Bad request" |
| }, |
| "401": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { "message": { "type": "string" } }, |
| "type": "object" |
| }, |
| "example": { "message": "Unauthorized: Authentication required" } |
| } |
| }, |
| "description": "Unauthorized" |
| }, |
| "403": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { "message": { "type": "string" } }, |
| "type": "object" |
| }, |
| "example": { |
| "message": "Forbidden: You don't have permission to access this resource" |
| } |
| } |
| }, |
| "description": "Forbidden" |
| }, |
| "404": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { "message": { "type": "string" } }, |
| "type": "object" |
| }, |
| "example": { |
| "message": "Not found: The requested resource does not exist" |
| } |
| } |
| }, |
| "description": "Not found" |
| }, |
| "500": { |
| "content": { |
| "application/json": { |
| "schema": { |
| "properties": { "message": { "type": "string" } }, |
| "type": "object" |
| }, |
| "example": { |
| "message": "Internal server error: An unexpected error occurred" |
| } |
| } |
| }, |
| "description": "Fatal error" |
| } |
| } |
| } |