{ "swagger": "2.0", "info": { "description": "This is Data API server", "title": "DataAPI API", "contact": {}, "version": "1.0" }, "paths": { "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/chat2query/log": { "get": { "operationId": "GetChat2Querylogs", "description": "Get Chat2Query logs", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["chat2query"], "summary": "Get Chat2Query logs", "parameters": [ { "name": "org_id", "in": "path", "required": true, "type": "string" }, { "name": "project_id", "in": "path", "required": true, "type": "string" }, { "name": "app_id", "in": "path", "required": true, "type": "string" }, { "name": "start", "in": "query", "required": false, "type": "integer" }, { "name": "end", "in": "query", "required": false, "type": "integer" }, { "name": "type", "in": "query", "required": false, "type": "string" }, { "name": "status", "in": "query", "required": false, "type": "string" }, { "name": "question", "in": "query", "required": false, "type": "string" }, { "name": "page", "in": "query", "required": false, "type": "integer" }, { "name": "download", "in": "query", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetChat2QueryLogResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs/{db_name}/tables/{table_name}/vector/fields": { "get": { "operationId": "getVectorFieldList", "description": "show vector field list", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "show vector field list", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true }, { "type": "string", "description": "table name", "name": "table_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowVectorFieldsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/misc_statistic": { "get": { "operationId": "getAppMetricsStatistic", "description": "Query DataApp misc statistic", "produces": ["application/json"], "tags": ["dataapi"], "summary": "Query DataApp misc statistic", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "from", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "to", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataAppMiscStatusRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/avg_request_rate": { "get": { "operationId": "getAppMetricsAvgRequestRate", "description": "get DataApp average request rate", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp average request rate", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "invertal duration, duration format, see https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/avg_response_time": { "get": { "operationId": "getAppMetricsAvgResponseTime", "description": "get DataApp avg response time", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp avg response time", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "invertal duration, duration format, see https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/error_rate": { "get": { "operationId": "getAppMetricsErrorRate", "description": "get DataApp error rate", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp error rate", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "invertal duration, duration format, see https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/unauth_req_num": { "get": { "operationId": "getAppMetricsUnauthReqNum", "description": "get DataApp unauth req num", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp unauth req num", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "invertal duration, duration format, see https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/most_request": { "get": { "operationId": "getAppMetricsMostRequestEndpointsRank", "description": "get DataApp most request endpoints rank", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp most request endpoints rank", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "top k", "name": "topK", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonEndpointsRankRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/high_latency": { "get": { "operationId": "getAppMetricsHighLatencyEndpointsRank", "description": "get DataApp high latency endpoints rank", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp high latency endpoints rank", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "top k", "name": "topK", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonEndpointsRankRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/most_error": { "get": { "operationId": "getAppMetricsMostErrorEndpointsRank", "description": "get DataApp most error endpoints rank", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get DataApp most error endpoints rank", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "integer", "description": "top k", "name": "topK", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonEndpointsRankRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/log_response_body_switch": { "post": { "operationId": "UpdateAppLogResponseBody", "description": "change log response body switch status", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "change log response body switch status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.ChangeLogResponseBodySwitchParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/download_log_task/{task_id}": { "get": { "operationId": "getAppLogDownloadLinkByTaskId", "description": "get download log task status", "produces": ["application/json"], "tags": ["dataapi"], "summary": "get download log task status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "download task id", "name": "task_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DownloadDataAPPLogTaskStatusRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/download_log_task": { "post": { "operationId": "SubmitAppDownloadLogTask", "description": "submit download log task", "produces": ["application/json"], "tags": ["dataapi"], "summary": "submit download log task", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "cluster filter", "name": "cluster_id", "in": "query", "required": true }, { "type": "string", "description": "enum OK/Error/All", "name": "status", "in": "query" }, { "type": "string", "description": "type filter,enum all/endpoints", "name": "type", "in": "query" }, { "type": "string", "description": "request id filter", "name": "request_id", "in": "query" }, { "type": "string", "description": "trace id filter", "name": "trace_id", "in": "query" }, { "type": "string", "description": "passback, fetch from the latest query result, omit when create new query: first query/user change query conditions/click Refresh button", "name": "passback", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.SubmitDownloadDataAPPLogTaskRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/log": { "get": { "operationId": "getAppRequestLog", "description": "query dataapp log", "produces": ["application/json"], "tags": ["dataapi"], "summary": "query dataapp log", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "query start timestamp", "name": "start", "in": "query", "required": true }, { "type": "integer", "description": "query end timestamp", "name": "end", "in": "query", "required": true }, { "type": "string", "description": "cluster filter", "name": "cluster_id", "in": "query", "required": true }, { "type": "integer", "description": "page number, starts from 1", "name": "page", "in": "query", "required": true }, { "type": "string", "description": "enum OK/Error/All", "name": "status", "in": "query" }, { "type": "string", "description": "type filter,enum all/endpoints", "name": "type", "in": "query" }, { "type": "integer", "description": "endpoint filter", "name": "endpoint_id", "in": "query" }, { "type": "string", "description": "request id filter", "name": "request_id", "in": "query" }, { "type": "string", "description": "trace id filter", "name": "trace_id", "in": "query" }, { "type": "string", "description": "passback, fetch from the latest query result, omit when create new query: first query/user change query conditions/click Refresh button", "name": "passback", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppLogRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/{apikey_id}/expire_key": { "post": { "operationId": "expireApiKey", "description": "expire api key", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "expire assigned api key", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "apikey ID", "name": "apikey_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/expire_all": { "post": { "operationId": "expireAllApiKeys", "description": "expire all api keys", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "expire all api keys", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/custom-domains": { "get": { "operationId": "getCustomDomains", "description": "list custom domain", "produces": ["application/json"], "tags": ["customdomain"], "summary": "list custom domain", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListCustomDomainsResponse" } } } }, "post": { "operationId": "createCustomDomain", "description": "create custom domain", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["customdomain"], "summary": "create custom domain", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CustomDomainRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CustomDomainResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/custom-domains/{custom_domain_id}": { "put": { "operationId": "editCustomDomain", "description": "edit custom domain", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["customdomain"], "summary": "edit custom domain", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "custom domain ID", "name": "custom_domain_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CustomDomainRequest" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CustomDomainResponse" } } } }, "delete": { "operationId": "deleteCustomDomain", "description": "delete custom domain", "produces": ["application/json"], "tags": ["customdomain"], "summary": "delete custom domain", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "integer", "description": "custom domain ID", "name": "custom_domain_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/default-domains": { "get": { "operationId": "listDefaultDomains", "description": "list default domain", "produces": ["application/json"], "tags": ["customdomain"], "summary": "list default domain", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListDefaultDomainsResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/updatestatus": { "post": { "operationId": "UpdateDataAppStatus", "description": "update sample dataapp status to normal", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "update sample dataapp status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/batchexample": { "get": { "operationId": "GetBatchExample", "description": "batch get sample dataapp code example", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "batch get sample dataapp code example", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.BatchGetCodeExampleRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/samplestatus": { "get": { "operationId": "GetSampleDataAppStatus", "description": "check sample dataapp status", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "check sample dataapp status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CheckSampleStatusRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/postmanstatus": { "get": { "operationId": "GetDataappPostmanStatus", "description": "check run in postman status", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "run in postman status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CheckPostmanStatusRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/exportlink": { "get": { "operationId": "GetDataappExportUrl", "description": "Get dataapp export url", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "Get dataapp export url", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataappExportLinkRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas": { "get": { "operationId": "GetOas", "description": "get oas", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["oas"], "summary": "get oas", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "openapi specification format", "name": "format", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetOpenApiSpecificationResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas/authorize": { "post": { "operationId": "AuthorizeOas", "description": "authorize oas", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["oas"], "summary": "authorize oas", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas/download": { "get": { "operationId": "DownloadOas", "description": "download oas", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["oas"], "summary": "download oas", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "openapi specification format", "name": "format", "in": "query", "required": true } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/draft/diff": { "post": { "operationId": "GetEndpointDraftDiff", "description": "Get endpoint draft diff", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "Get endpoint draft diff", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "type": "string", "description": "options: struct/text. default is struct", "name": "diff_type", "in": "query" }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateEndpointParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppDeployDiffRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/list_dataapp_usage": { "get": { "description": "list data app Usage", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list data app Usage", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dataservices_internal_entity.DataUsageQueryParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.OKType" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/discard": { "post": { "operationId": "DiscardEndpoint", "description": "discard endpoint", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "discard endpoint", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/{log_id}": { "put": { "operationId": "UpdateDeployLogName", "description": "save deployment log name", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "save deployment log name", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "deployment log ID", "name": "log_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.SaveDeploymentLogParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/discard": { "post": { "operationId": "DataappDiscardChanges", "description": "discard dataapp", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "discard dataapp", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/{log_id}/deploy": { "post": { "operationId": "DataappReDeploy", "description": "redeploy dataapp", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "redeploy dataapp", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "log ID", "name": "log_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/status": { "get": { "operationId": "GetDeployStatus", "description": "get deployment status (message bar)", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get deployment status (message bar)", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDeploymentStatus" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/{log_id}/diff": { "get": { "operationId": "GetDataappDeployLogDiff", "description": "get dataapp deploy log diff", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get dataapp deploy log diff", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "log ID", "name": "log_id", "in": "path", "required": true }, { "type": "string", "description": "options: struct/text. default is struct", "name": "diff_type", "in": "query" }, { "type": "string", "description": "options: redeploy/detail", "name": "sence", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppDeployDiffRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/diff": { "get": { "operationId": "GetDataappDeployDiff", "description": "get dataapp deploy diff", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get dataapp deploy diff", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "struct/text", "name": "diff_type", "in": "query", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppDeployDiffRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy": { "post": { "operationId": "DataappDeploy", "description": "deploy dataapp", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "deploy dataapp", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github/unlink": { "post": { "operationId": "UnlinkedGithubDataapp", "description": "unlink dataapp with github", "produces": ["application/json"], "tags": ["github_integration"], "summary": "unlink dataapp with github", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github/link": { "post": { "operationId": "LinkedGithubDataapp", "description": "link dataapp with github", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["github_integration"], "summary": "link dataapp with github", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.LinkGithubParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github": { "get": { "operationId": "IsGithubLinked", "description": "get github linkage status", "produces": ["application/json"], "tags": ["github_integration"], "summary": "get github linkage status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GithubLinkageStatusResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/config": { "get": { "operationId": "GetDataappDeployConfig", "description": "get dataapp deployment setting", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get dataapp deployment setting", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppDeploySettingRes" } } } }, "put": { "operationId": "UpdateDataappDeployConfig", "description": "save dataapp deployment setting", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "save dataapp deployment setting", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeploymentSwithConfig" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs": { "get": { "operationId": "GetDataappDeployList", "description": "list dataapp deploy logs", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list dataapp deploy logs", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "before timestamp", "name": "before", "in": "query" }, { "type": "string", "description": "limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListDataAppDeployLogsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/authorize-url": { "get": { "operationId": "GetDataappAuthorizeUrl", "description": "get url of authoriztion", "produces": ["application/json"], "tags": ["github_integration"], "summary": "get url of authoriztion", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetAuthorizeUrlResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories": { "get": { "operationId": "GetDataappAuthorizedRepos", "description": "list authorized github repositories of a dataapp", "produces": ["application/json"], "tags": ["github_integration"], "summary": "list authorized github repositories of a dataapp", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListAuthorizedRepositoriesResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories/{repo_id}/branches": { "get": { "operationId": "GetAuthorizedGithubBranches", "description": "list authorized github branches of a dataapp", "produces": ["application/json"], "tags": ["github_integration"], "summary": "list authorized github branches of a data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "ghtub repository ID", "name": "repo_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListBranchesResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories/{repo_id}/validate": { "post": { "operationId": "ValidateRepos", "description": "validate repo/branch/direcotory a preflight request", "produces": ["application/json"], "tags": ["github_integration"], "summary": "validate repo/branch/direcotory a preflight request", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "ghtub repository ID", "name": "repo_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.RepoBranchDirValidateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RepoBranchDirValidateResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/preflight-request": { "post": { "operationId": "PreflightDataApp", "description": "generate the preflight request", "produces": ["application/json"], "tags": ["github_integration"], "summary": "generate the preflight request", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetAuthorizeUrlResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories": { "get": { "operationId": "GetPreflightRepos", "description": "list authorized github repositories of a preflight request", "produces": ["application/json"], "tags": ["github_integration"], "summary": "list authorized github repositories of a preflight request", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "preflight request ID", "name": "request_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListAuthorizedRepositoriesResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories/{repo_id}/branches": { "get": { "operationId": "GetPreGithubBranches", "description": "list authorized github branches of a dataapp", "produces": ["application/json"], "tags": ["github_integration"], "summary": "list authorized github branches of a data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "preflight request ID", "name": "request_id", "in": "path", "required": true }, { "type": "string", "description": "ghtub repository ID", "name": "repo_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListBranchesResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories/{repo_id}/validate": { "post": { "operationId": "ValidatePreRepos", "description": "validate repo/branch/direcotory a data app", "produces": ["application/json"], "tags": ["github_integration"], "summary": "validate repo/branch/direcotory a data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "preflight request ID", "name": "request_id", "in": "path", "required": true }, { "type": "string", "description": "ghtub repository ID", "name": "repo_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.RepoBranchDirValidateReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.RepoBranchDirValidateResp" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/enter/audit": { "get": { "operationId": "Chat2queryAuditLog", "description": "enter chat2query audit log", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "enter chat2query audit log", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/version/{version}/status": { "get": { "operationId": "GetEndpointDeployStatus", "description": "check endpoint deploy status", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "check endpoint deploy status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "type": "string", "description": "version", "name": "version", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.EndpointDeployRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/baseurl": { "get": { "operationId": "GetEndpointBaseUrl", "description": "get endpoint base url", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get endpoint base url", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.EndpointBaseUrlRes" } } } } }, "/api/v1/dataapps/sqleditor/orgs/{org_id}/projects/{project_id}/clusters/status": { "get": { "operationId": "GetClusterPrivateLinkStatus", "description": "check cluster status", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["sqleditor"], "summary": "check cluster status", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster_id list, separate with commas", "name": "cluster_ids", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dataapps_internal_dto_sqleditor.ClusterStatusRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/apps": { "get": { "operationId": "GetClusterLinkedApps", "description": "count app cluster", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "count app cluster", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ClusterLinkedAPPResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters": { "get": { "operationId": "ListAppCluster", "description": "list app cluster", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list app cluster", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListAppClusterResp" } } } }, "post": { "operationId": "CreateAppCluster", "description": "create app cluster", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create app cluster", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "dataapp ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.CreateAppClusterReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}": { "delete": { "operationId": "DeleteAppCluster", "description": "delete app cluster", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "delete app cluster", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps": { "get": { "operationId": "GetDataApps", "description": "list data app", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app type, multiple split by commas. Example: dataapi,chat2query", "name": "apptype", "in": "query", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListDataAppRes" } } } }, "post": { "operationId": "CreateDataApp", "description": "create data app", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateDataAppRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}": { "get": { "operationId": "GetDataAppDetail", "description": "show data app", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "show data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetDataAppRes" } } } }, "put": { "operationId": "UpdateDataApp", "description": "update data app", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "update data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.UpdateDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } }, "delete": { "operationId": "DeleteDataApp", "description": "delete data app", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "delete data app", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys": { "get": { "operationId": "GetListApiKeys", "description": "list api keys", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list api keys", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "app key source, multiple split by commas", "name": "source", "in": "query", "required": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListAPIKeysRes" } } } }, "post": { "operationId": "CreateAPIKey", "description": "create api key", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create api key", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateAPIKeyParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateAPIKeyRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/{apikey_id}": { "put": { "operationId": "UpdateDataAppKey", "description": "update api key", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "update api key", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "apikey ID", "name": "apikey_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.UpdateAPIKeyParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } }, "delete": { "operationId": "DeleteApiKey", "description": "delete api key", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "delete api key", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "apikey ID", "name": "apikey_id", "in": "path", "required": true }, { "type": "string", "description": "current role", "name": "role", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints": { "get": { "operationId": "GetEndpoints", "description": "list endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListEndpointRes" } } } }, "post": { "operationId": "CreateEndpoint", "description": "create endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateEndpointParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}": { "get": { "operationId": "GetDataApiEndpointDetail", "description": "get endpoint by id", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get endpoint by id", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GetEndpointRes" } } } }, "put": { "operationId": "UpdateDataApiEndpoint", "description": "update endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "update endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateEndpointParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpdateSuccessApiResponse" } } } }, "delete": { "operationId": "DeleteDataApiEndpoint", "description": "delete endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "delete endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } }, "patch": { "operationId": "patchEndpoint", "description": "patch endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "patch endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateEndpointParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.UpdateEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/dump": { "post": { "operationId": "dumpDataApiEndpoint", "description": "dump endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "dump endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DumpEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/example": { "get": { "operationId": "GetEndpointCodeExample", "description": "get endpoint code example", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "get endpoint code example", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "name": "cluster_id", "in": "query", "required": false, "type": "string", "format": "string" }, { "name": "database", "in": "query", "required": false, "type": "string", "format": "string" }, { "type": "string", "description": "enum: basic/digest, default value is digest", "name": "auth_type", "in": "query" }, { "type": "string", "description": "enum: curl/js", "name": "language", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.TestEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/offline": { "put": { "operationId": "OfflineDataApiEndpoint", "description": "offline endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "offline endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/online": { "post": { "operationId": "OnlineDataApiEndpoint", "description": "online endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "online endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployEndpointReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/sessions": { "post": { "operationId": "createsDataAppSession", "description": "create session", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create session", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.CreateSessionParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateSessionRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/statements": { "post": { "operationId": "dataApiSQLExecute", "description": "run endpoint sql", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "run endpoint sql", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.StatementParamV2" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.StatementsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/test": { "post": { "operationId": "TestDataApiEndpoint", "description": "test endpoint", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "test endpoint", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.TestEndpointParamV2" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.TestEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/versions": { "get": { "operationId": "GetEndpointVersions", "description": "list endpoint versions by endpointid", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "list endpoint versions by endpointid", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListEndpointPublishLogRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/auto/endpoints": { "post": { "operationId": "CreateAutoEndpoints", "description": "create auto generate endpoints", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "create auto generate endpoints", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.AutoGenerateEndpoint" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CreateAutoGenerateEndpointRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs": { "get": { "operationId": "getDbsByCluster", "description": "show db list", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "show db list", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "value: true or false", "name": "show_system_db", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowDBsRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs/{db_name}/tables": { "get": { "operationId": "getTablesByDb", "description": "show table list", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "show table list", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "cluster ID", "name": "cluster_id", "in": "path", "required": true }, { "type": "string", "description": "db name", "name": "db_name", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ShowTablesRes" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/verification/batch": { "post": { "operationId": "verificationBatch", "description": "verify batch", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "verify batch", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "type": "string", "description": "endpoint ID", "name": "endpoint_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.VerifyBatch" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/systemendpoint": { "get": { "operationId": "getSystemEnpoint", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "Get system endpoint configuration", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.GetSystemEndpointConfigResp" } } } }, "post": { "operationId": "createSystemEndpoint", "consumes": ["application/json"], "produces": ["application/json"], "tags": ["dataapi"], "summary": "Save system endpoint configuration", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.SystemEndpointConfigData" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.GenericSuccessApiResponse" } } } } }, "/api/v1/dataservices/central/orgs/{org_id}/projects/{project_id}/apps/{app_id}/chat2query/settings": { "get": { "operationId": "getChat2QuerySettings", "description": "get Chat2Query Settings", "produces": ["application/json"], "tags": ["chat2query"], "summary": "get Chat2Query Settings", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.EdaResponse" } } } }, "put": { "operationId": "updateChat2QuerySettings", "description": "update Chat2Query Settings", "produces": ["application/json"], "tags": ["chat2query"], "summary": "update Chat2Query Settings", "parameters": [ { "type": "string", "description": "org ID", "name": "org_id", "in": "path", "required": true }, { "type": "string", "description": "project ID", "name": "project_id", "in": "path", "required": true }, { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/dto.Chat2QuerySettings" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.EdaResponse" } } } } } }, "definitions": { "dataservices_commons_utils.JsonTime": { "type": "object", "properties": { "time.Time": { "type": "string" }, "withTZ": { "type": "boolean" } } }, "dto.AppClusterInfo": { "type": "object", "properties": { "cloud": { "type": "string" }, "cluster_id": { "type": "string" }, "cluster_name": { "type": "string" }, "nullable": { "type": "boolean" }, "dataapp_id": { "type": "integer" }, "region": { "type": "string" }, "tier_type": { "type": "string" } } }, "dto.BaseResp": { "type": "object", "properties": { "err_code": { "type": "integer" }, "err_msg": { "type": "string" } } }, "entity.LinkGithubParam": { "type": "object", "properties": { "branch": { "type": "string" }, "directory": { "type": "string" }, "installation_id": { "type": "integer" }, "repository_id": { "type": "integer" }, "enable_automatic_deployment": { "type": "boolean" } } }, "dto.CommonApiResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" } } }, "dto.CreateAppClusterReq": { "type": "object", "required": ["cluster_ids"], "properties": { "cluster_ids": { "type": "array", "items": { "type": "string" } }, "org_id": { "type": "integer" }, "project_id": { "type": "integer" } } }, "dto.DBColumn": { "type": "object", "properties": { "col": { "type": "string" }, "data_type": { "type": "string" }, "nullable": { "type": "boolean" } } }, "dto.DBRow": { "type": "object", "additionalProperties": true }, "dto.CreateAPIKeyRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.RbacApiKey" }, "message": { "type": "string" } } }, "dto.CreateDataAppOut": { "type": "object", "properties": { "app_info": { "$ref": "#/definitions/entity.DataApp" }, "endpoint": { "$ref": "#/definitions/dto.EndpointSummary" } } }, "dto.CreateDataAppRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.CreateDataAppOut" }, "message": { "type": "string" } } }, "dto.CreateEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointFormat" }, "message": { "type": "string" } } }, "dto.CreateSessionOut": { "type": "object", "properties": { "session_id": { "type": "string" } } }, "dto.CreateSessionRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.CreateSessionOut" }, "message": { "type": "string" } } }, "dto.DataAppInfo": { "type": "object", "properties": { "app_name": { "type": "string" }, "app_version": { "type": "string" }, "app_type": { "$ref": "#/definitions/entity.DataAppType" }, "base_url": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "deployment_region": { "type": "string" }, "endpoints": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointSummary" } }, "external_app_id": { "type": "string" }, "id": { "type": "integer" }, "oas_authorized": { "type": "boolean" }, "org_id": { "type": "string" }, "project_id": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.DataAppSettings" }, "status": { "description": "dataapp current status: normal,initializing", "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" }, "open_api_link": { "type": "string" }, "apikey_max_rpm": { "type": "number" } } }, "dto.UpdateEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointFormat" }, "field_errors": { "type": "array", "items": { "$ref": "#/definitions/dto.FieldError" } }, "message": { "type": "string" } } }, "dto.DumpEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointFormat" }, "message": { "type": "string" } } }, "dto.EndpointDataRes": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/dto.DBColumn" } }, "end_ms": { "type": "integer" }, "limit": { "type": "integer" }, "query": { "type": "string" }, "row_affect": { "type": "integer" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "start_time": { "type": "integer" }, "err_code": { "type": "integer" }, "err_msg": { "type": "string" }, "latency": { "type": "string" }, "warn_count": { "type": "integer" }, "warn_messages": { "type": "array", "items": { "type": "string" } } } }, "entity.DataAppSettings": { "type": "object", "properties": { "log_exec_result": { "type": "boolean" } } }, "dto.EndpointFormat": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointArgs" } }, "cluster_id": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "dataappp_id": { "type": "integer" }, "database": { "type": "string" }, "description": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "integer" }, "method": { "type": "string" }, "name": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.EndpointSettings" }, "sql_template": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" }, "has_modified": { "type": "boolean" }, "vid": { "type": "string", "example": "0" } } }, "dto.FieldError": { "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } } }, "dto.EndpointResult": { "type": "object", "properties": { "data": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/dto.DBColumn" } }, "result": { "type": "object", "properties": { "code": { "type": "integer" }, "end_ms": { "type": "integer" }, "latency": { "type": "string" }, "limit": { "type": "integer" }, "message": { "type": "string" }, "query": { "type": "string" }, "row_affect": { "type": "integer" }, "row_count": { "type": "integer" }, "start_ms": { "type": "integer" } } }, "rows": { "type": "array", "items": { "$ref": "#/definitions/dto.DBRow" } } } }, "type": { "type": "string" } } }, "dto.ListAppClusterResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.DataAppInfo" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.AppClusterInfo" } } } }, "dto.EndpointPublishHistory": { "type": "object", "properties": { "dataappp_id": { "type": "integer" }, "endpoint_id": { "type": "integer" }, "is_online": { "type": "integer" }, "updated_at": { "type": "string" }, "version": { "type": "string" } } }, "dto.EndpointSummary": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "dataappp_id": { "type": "integer" }, "endpoint": { "type": "string" }, "has_modified": { "type": "boolean" }, "id": { "type": "integer" }, "method": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "is_online": { "type": "integer" }, "vid": { "type": "string", "example": "0" } } }, "dto.GetDataAppRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DataApp" }, "message": { "type": "string" } } }, "dto.GetEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.EndpointFormat" }, "message": { "type": "string" } } }, "dto.ListAPIKeysRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.RbacApiKey" } }, "message": { "type": "string" } } }, "dto.ListDataAppRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DataAppInfo" } }, "message": { "type": "string" } } }, "dto.ListEndpointPublishLogRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointPublishHistory" } }, "message": { "type": "string" } } }, "dto.ListEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointSummary" } }, "message": { "type": "string" } } }, "dataservices_internal_dto_dataapi.OKType": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } }, "dto.RbacApiKey": { "type": "object", "properties": { "access_key": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "rate_limit_rpm": { "type": "integer" }, "role": { "type": "string" }, "secret_key": { "type": "string" }, "source": { "type": "string" }, "ttl_in_min": { "type": "integer" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" } } }, "dto.StatementsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointDataRes" } }, "message": { "type": "string" } } }, "dto.TestEndpointRes": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.EndpointResult" } } }, "entity.CreateAPIKeyParam": { "type": "object", "required": ["name", "role"], "properties": { "name": { "type": "string" }, "rate_limit_rpm": { "type": "integer" }, "role": { "type": "string" }, "ttl_in_min": { "type": "integer" } } }, "entity.CreateDataAppParam": { "type": "object", "required": ["app_name"], "properties": { "app_name": { "type": "string" }, "cluster_ids": { "type": "array", "items": { "type": "string" } }, "deployment_config": { "type": "object", "properties": { "branch": { "type": "string" }, "directory": { "type": "string" }, "installation_id": { "type": "integer" }, "preflight_request_id": { "type": "string" }, "repository_id": { "type": "integer" } } }, "deployment_region": { "type": "string" }, "description": { "type": "string" }, "is_sample": { "type": "boolean" }, "app_type": { "type": "string" } } }, "dto.GetOpenApiSpecificationResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.OpenApiSpecification" } } }, "dto.OpenApiSpecification": { "type": "object", "properties": { "document": { "type": "string" }, "filename": { "type": "string" } } }, "dto.BatchGetCodeExampleRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "object", "properties": { "endpoint_examples": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointCodeExample" } } } }, "message": { "type": "string" } } }, "dto.EndpointCodeExample": { "type": "object", "properties": { "examples": { "type": "array", "items": { "$ref": "#/definitions/dto.CodeExample" } }, "path": { "type": "string" } } }, "dto.CodeExample": { "type": "object", "properties": { "code": { "type": "string" }, "type": { "type": "string" } } }, "dto.CheckSampleStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "object", "properties": { "app_status": { "description": "dataapp current status: normal,initializing", "type": "string" }, "task_records": { "type": "array", "items": { "$ref": "#/definitions/entity.StampleDataTaskRecord" } } } }, "message": { "type": "string" } } }, "entity.StampleDataTaskRecord": { "type": "object", "properties": { "start_time": { "$ref": "#/definitions/dataservices_commons_utils.JsonTime" }, "state": { "description": "import_data,create_endpoint,deploy_endpoint,success,fail", "type": "string" }, "message": { "type": "string" } } }, "dto.CheckPostmanStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "boolean" }, "message": { "type": "string" } } }, "dto.DataappExportLinkRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "entity.CreateEndpointParam": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointArgs" } }, "cluster_id": { "type": "string" }, "database": { "type": "string" }, "description": { "type": "string" }, "endpoint": { "type": "string" }, "method": { "type": "string" }, "name": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.EndpointSettings" }, "sql_template": { "type": "string" }, "tag": { "type": "string" }, "vid": { "type": "string", "example": "0" } } }, "entity.CreateSessionParam": { "type": "object", "required": ["cluster_id"], "properties": { "cluster_id": { "type": "string" }, "database": { "type": "string" } } }, "entity.DataAppType": { "type": "string", "enum": ["dataapi", "trigger", "chat2query", "common"], "x-enum-varnames": ["DataAppTypeDataapi", "DataAppTypeTrigger", "DataAppTypeChat2Query", "DataAppTypeCommon"] }, "entity.EndpointArgs": { "type": "object", "required": ["name", "type"], "properties": { "default": { "type": "string" }, "description": { "type": "string" }, "enum": { "type": "string" }, "item_type": { "type": "string" }, "name": { "type": "string" }, "pattern": { "description": "regexp match pattern", "type": "string" }, "required": { "type": "integer" }, "type": { "description": "string/bigint/bigint unsigned/double/array/enum/replace, if type is array/enum, should also specify the value-type.", "type": "string" } } }, "entity.EndpointSettings": { "type": "object", "properties": { "enable_pagination": { "description": "enable pagination, 0 or 1", "type": "integer" }, "cache_enabled": { "type": "integer" }, "cache_ttl": { "type": "integer" }, "row_limit": { "type": "integer" }, "timeout": { "type": "integer" } } }, "entity.StatementArgs": { "type": "object", "properties": { "default": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "pattern": { "description": "regexp match pattern", "type": "string" }, "required": { "type": "integer" }, "type": { "description": "string/bigint/bigint unsigned/double/array/enum/replace, if type is array/enum, should also specify the value-type.", "type": "string" }, "value": { "type": "string" }, "value_map": { "description": "enum/replace will use this map to verify enum value or replace.", "type": "object", "additionalProperties": { "type": "string" } }, "value_type": { "description": "string/bigint/bigint unsigned/double, optional, the default is string.", "type": "string" } } }, "entity.StatementParam": { "type": "object", "required": ["cluster_id", "session_id", "sql"], "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.StatementArgs" } }, "cluster_id": { "type": "string" }, "database": { "type": "string" }, "session_id": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.EndpointSettings" }, "sql": { "type": "string" } } }, "entity.TestEndpointArgs": { "type": "object", "required": ["name", "type"], "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } } }, "entity.TestEndpointParam": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.TestEndpointArgs" } } } }, "entity.UpdateAPIKeyParam": { "type": "object", "required": ["name", "new_role", "old_role"], "properties": { "name": { "type": "string" }, "new_role": { "type": "string" }, "old_role": { "type": "string" }, "rate_limit_rpm": { "type": "integer" }, "old_ttl_in_min": { "type": "integer" }, "new_ttl_in_min": { "type": "integer" } } }, "entity.UpdateDataAppParam": { "type": "object", "required": ["app_name"], "properties": { "app_name": { "type": "string" }, "deployment_region": { "type": "string" }, "app_version": { "type": "string" }, "description": { "type": "string" } } }, "dto.ClusterLinkedAPPResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DataAppInfo" } } } }, "dataapps_internal_dto_sqleditor.ClusterStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dataapps_internal_dto_sqleditor.ClusterStatus" } }, "message": { "type": "string" } } }, "dataapps_internal_dto_sqleditor.ClusterStatus": { "type": "object", "properties": { "cluster_id": { "type": "string", "example": "0" }, "link_status": { "description": "private link status, 0=Unsupported, 1=NeedCreate, 2=Creating, 3=Normal", "type": "integer" } } }, "dto.EndpointBaseUrlRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.EndpointDeployRes": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "object", "properties": { "completed": { "type": "boolean" }, "version": { "type": "string" } } } } }, "dto.ListDefaultDomainsResponse": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.ListDefaultDomainsData" } } }, "dto.ListDefaultDomainsData": { "type": "object", "properties": { "base_urls": { "type": "array", "items": { "type": "string" } }, "default_domain_names": { "type": "array", "items": { "type": "string" } }, "default_path": { "type": "string" } } }, "dto.CustomDomainRequest": { "type": "object", "properties": { "custom_domain_name": { "type": "string" }, "custom_path": { "type": "string" }, "default_domain_name": { "type": "string" } } }, "dto.CustomDomainResponse": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/entity.CustomDomain" } } }, "dto.ListCustomDomainsResponse": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.CustomDomain" } } } }, "entity.CustomDomain": { "type": "object", "properties": { "created_at": { "type": "string" }, "created_by": { "type": "string" }, "custom_domain_name": { "type": "string" }, "custom_path": { "type": "string" }, "dataapp_id": { "type": "integer" }, "default_domain_name": { "type": "string" }, "expired": { "type": "boolean" }, "external_app_id": { "type": "string" }, "id": { "type": "integer" }, "state": { "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" }, "reason": { "type": "string" } } }, "dto.DataAppMiscStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "dataapp_available": { "type": "boolean" }, "endpoint": { "$ref": "#/definitions/dto.EndpointStatistic" }, "message": { "type": "string" }, "unique_user": { "type": "integer" } } }, "dto.GetChat2QueryLogResp": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "logs": { "type": "array", "items": { "$ref": "#/definitions/dto.Chat2QueryLog" } } } }, "dto.Chat2QueryLog": { "type": "object", "properties": { "type": { "type": "string" }, "log_time": { "type": "integer" }, "status": { "type": "string" }, "request_id": { "type": "string" }, "start_at": { "type": "integer" }, "session_id": { "type": "string" }, "data_summary_id": { "type": "integer" }, "cluster_id": { "type": "string" }, "database": { "type": "string" }, "token_count": { "type": "integer" }, "input": { "type": "object", "properties": { "feedback": { "type": "string" }, "question": { "type": "string" }, "sql_generate_mode": { "type": "string" } } }, "output": { "type": "object", "properties": { "chart_options": { "type": "object" }, "data": { "type": "object" }, "sql": { "type": "string" }, "sql_error": { "type": "string" }, "status": { "type": "string" }, "task_id": { "type": "string" }, "type": { "type": "string" }, "sub_tasks": { "type": "array", "items": { "$ref": "#/definitions/dto.Chat2QueryLogOutputItems" } } } }, "settings": { "type": "object", "properties": { "language_code": { "type": "string" }, "llm_api_key": { "type": "string" }, "llm_model": { "type": "string" } } }, "recalled_knowledge_data": { "type": "object" } } }, "dto.Chat2QueryLogOutputItems": { "type": "object", "properties": { "sql": { "type": "string" }, "type": { "type": "string" }, "task_id": { "type": "string" } } }, "dto.ShowVectorFieldsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "dto.EndpointStatistic": { "type": "object", "properties": { "code": { "type": "integer" }, "deployed": { "type": "integer" }, "draft": { "type": "integer" }, "message": { "type": "string" } } }, "dto.CommonPromMetricsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.PromData" }, "message": { "type": "string" }, "status": { "type": "string" } } }, "dto.CommonEndpointsRankRes": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "rank": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointsRankItem" } } } }, "dto.EndpointsRankItem": { "type": "object", "properties": { "endpoint_name": { "type": "string" }, "rank_value": { "type": "string" }, "endpoint_id": { "type": "string" }, "operation_id": { "type": "string" } } }, "dto.PromData": { "type": "object", "properties": { "result": { "type": "array", "items": { "$ref": "#/definitions/dto.PromResult" } }, "resultType": { "type": "string" } } }, "dto.PromResult": { "type": "object", "properties": { "metric": { "description": "not used", "allOf": [ { "$ref": "#/definitions/dto.PromMetric" } ] }, "values": { "description": "see https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors", "type": "array", "items": { "type": "array", "items": {} } } } }, "dto.PromMetric": { "type": "object" }, "entity.ChangeLogResponseBodySwitchParam": { "type": "object", "properties": { "new_status": { "description": "Enum: [on off]", "type": "string" } } }, "dto.GenericSuccessApiResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointSummary" }, "message": { "type": "string" } } }, "dto.DownloadDataAPPLogTaskStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "download_url": { "description": "only availiable when status is sucess", "type": "string" }, "message": { "type": "string" }, "status": { "description": "Enum: [processing failed success]", "type": "string" } } }, "dto.SubmitDownloadDataAPPLogTaskRes": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "task_id": { "type": "string" } } }, "dto.GetDataAppLogRes": { "type": "object", "properties": { "code": { "type": "integer" }, "has_more": { "type": "boolean" }, "logs": { "type": "array", "items": { "$ref": "#/definitions/dto.DataAppLogEntry" } }, "message": { "type": "string" }, "passback": { "type": "string" } } }, "dto.DataAppLogEntry": { "type": "object", "properties": { "client_info": { "type": "string" }, "date_time": { "type": "integer" }, "endpoint_name": { "type": "string" }, "http_code": { "type": "integer" }, "http_code_message": { "type": "string" }, "query_param": { "type": "string" }, "req_body": { "type": "string" }, "req_header": { "type": "string" }, "req_url": { "type": "string" }, "request_id": { "type": "string" }, "resp_row_count": { "type": "integer" }, "response_body": { "type": "string" }, "response_size": { "type": "string" }, "response_time": { "type": "string" }, "rsp_cached": { "type": "boolean" }, "status": { "type": "string" }, "trace_id": { "type": "string" }, "type": { "type": "string" }, "endpoint_id": { "type": "integer" } } }, "dto.UpdateSuccessApiResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointFormat" }, "field_errors": { "type": "array", "items": { "$ref": "#/definitions/dto.FieldError" } }, "message": { "type": "string" } } }, "entity.DeployEndpointReq": { "type": "object", "properties": { "deploy_name": { "type": "string" } } }, "dto.GetAuthorizeUrlResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.GetAuthorizeUrl" } } }, "dto.GetAuthorizeUrl": { "type": "object", "properties": { "preflight_request_id": { "type": "integer" }, "url": { "type": "string" } } }, "dto.ListAuthorizedRepositoriesResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.GithubRepository" } } } }, "dto.GithubRepository": { "type": "object", "properties": { "full_name": { "type": "string" }, "id": { "type": "integer" }, "installation_id": { "type": "integer" } } }, "dto.GithubRepositoryBranch": { "type": "object", "properties": { "name": { "type": "string" }, "protected": { "type": "boolean" } } }, "dto.ListBranchesResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.GithubRepositoryBranch" } } } }, "dto.RepoBranchDirValidateReq": { "type": "object", "properties": { "branch": { "type": "string" }, "directory": { "type": "string" } } }, "dto.RepoBranchDirValidateResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.RepoBranchDirValidateResult" } } }, "dto.RepoBranchDirValidateResult": { "type": "object", "properties": { "conflict": { "type": "boolean" }, "external_app_id": { "type": "string" } } }, "dto.ListDataAppDeployLogsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.DataAppDeploymentLog" } }, "message": { "type": "string" } } }, "entity.DataAppDeploymentLog": { "type": "object", "properties": { "commit_id": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "dataapp_id": { "type": "integer" }, "deployed_at": { "type": "string" }, "diff_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "origin": { "$ref": "#/definitions/entity.DataAppDeploymentLogOrigin" }, "snapshot": { "type": "string" }, "status": { "$ref": "#/definitions/entity.DataAppDeploymentLogStatus" }, "status_error_msg": { "type": "string" }, "updated_at": { "type": "string" } } }, "entity.DataAppDeploymentLogOrigin": { "type": "string", "enum": ["UI", "Github"], "x-enum-varnames": ["DataAppDeploymentLogOriginUI", "DataAppDeploymentLogOriginGithub"] }, "entity.DataAppDeploymentLogStatus": { "type": "string", "enum": ["pending", "running", "success", "failed"], "x-enum-varnames": [ "DataAppDeploymentStatusPending", "DataAppDeploymentStatusRunning", "DataAppDeploymentStatusSuccess", "DataAppDeploymentStatusFailed" ] }, "dto.GetDataAppDeploySettingRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DataAppDeploymentSetting" }, "message": { "type": "string" } } }, "entity.DataAppDeploymentSetting": { "type": "object", "properties": { "automatic_deployment_provider": { "type": "string" }, "automatic_deployment_setting": { "type": "string" }, "dataapp_id": { "type": "integer" }, "enable_automatic_deployment": { "type": "boolean" }, "enable_ui_drafts": { "type": "boolean" }, "github_branch": { "type": "string" }, "github_directory": { "type": "string" }, "github_installation_id": { "type": "integer" }, "github_repo_id": { "type": "integer" }, "has_deploy_conflict": { "type": "boolean" }, "id": { "type": "integer" } } }, "entity.DeploymentSwithConfig": { "type": "object", "properties": { "enable_automatic_deployment": { "type": "boolean" }, "enable_ui_drafts": { "type": "boolean" } } }, "entity.TestEndpointParamV2": { "type": "object", "properties": { "args": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/entity.TestEndpointArgs" } } } } }, "dto.GithubLinkageStatusResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.GithubLinkageStatusResult" } } }, "dto.GithubLinkageStatusResult": { "type": "object", "properties": { "authorized": { "type": "boolean" }, "branch": { "type": "string" }, "directory": { "type": "string" }, "installation_id": { "type": "integer" }, "repository_full_name": { "type": "string" }, "repository_id": { "type": "integer" }, "enable_automatic_deployment": { "type": "boolean" } } }, "dataservices_internal_entity.DataUsageQueryParam": { "type": "object", "properties": { "class": { "type": "string" }, "dataapp_id": { "type": "integer" }, "month": { "type": "integer" }, "type": { "type": "string" }, "year": { "type": "integer" } } }, "entity.DeployDataAppParam": { "type": "object", "required": ["deploy_name"], "properties": { "deploy_name": { "type": "string" } } }, "dto.GetDataAppDeployDiffRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.SnapshotDiff" }, "message": { "type": "string" } } }, "entity.SnapshotDiff": { "type": "object", "properties": { "app_clusters_diff": { "$ref": "#/definitions/entity.AppClusterDiff" }, "data_app_diff": { "$ref": "#/definitions/entity.DataAppDiff" }, "endpoints_diff": { "$ref": "#/definitions/entity.EndpointsDiff" }, "has_diff": { "type": "boolean" }, "text_diff": { "type": "string" } } }, "entity.AppClusterDiff": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "integer" } }, "deleted": { "type": "array", "items": { "type": "integer" } } } }, "entity.DataAppDiff": { "type": "object", "properties": { "modify": { "$ref": "#/definitions/entity.DataApp" } } }, "entity.DataApp": { "type": "object", "properties": { "app_name": { "type": "string" }, "app_type": { "$ref": "#/definitions/entity.DataAppType" }, "app_version": { "type": "string" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "deployment_region": { "type": "string" }, "description": { "type": "string" }, "external_app_id": { "type": "string" }, "id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "oas_authorized": { "type": "boolean" }, "org_id": { "type": "integer" }, "project_id": { "type": "integer" }, "status": { "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" } } }, "entity.Endpoint": { "type": "object", "properties": { "args": { "type": "string" }, "cluster_id": { "type": "integer" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "dataappp_id": { "type": "integer" }, "database": { "type": "string" }, "description": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "method": { "type": "string" }, "name": { "type": "string" }, "rw_mode": { "type": "string" }, "settings": { "type": "string" }, "sql_template": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" } } }, "entity.EndpointPublish": { "type": "object", "properties": { "args": { "type": "string" }, "cluster_id": { "type": "integer" }, "created_at": { "type": "string" }, "created_by": { "type": "string" }, "dataappp_id": { "type": "integer" }, "database": { "type": "string" }, "endpoint": { "type": "string" }, "endpoint_id": { "type": "integer" }, "id": { "type": "integer" }, "method": { "type": "string" }, "rw_mode": { "type": "string" }, "settings": { "type": "string" }, "sql_template": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "type": "string" }, "updated_by": { "type": "string" }, "version": { "type": "string" } } }, "entity.EndpointsDiff": { "type": "object", "properties": { "added": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "deleted": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "deletedPublish": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointPublish" } }, "modified": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "modifiedPublish": { "description": "Deleted []*Endpoint", "type": "array", "items": { "$ref": "#/definitions/entity.EndpointPublish" } }, "noChange": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } } } }, "dto.GetDeploymentStatus": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DeploymentStatus" }, "message": { "type": "string" } } }, "entity.DeploymentStatus": { "type": "object", "properties": { "action_time": { "type": "integer" }, "action_type": { "$ref": "#/definitions/entity.ActionType" }, "button_status": { "$ref": "#/definitions/entity.DeploymentButtonStatus" }, "message": { "type": "string" }, "origin": { "type": "string" } } }, "entity.ActionType": { "type": "string", "enum": ["doing", "succeed", "failed"], "x-enum-varnames": ["ActionDoing", "ActionSucceed", "ActionFailed"] }, "entity.DeploymentButtonStatus": { "type": "string", "enum": ["hidden", "review_deploy", "deploy", "review_draft"], "x-enum-varnames": ["ButtonHidden", "ButtonReviewAndDeploy", "ButtonDeploy", "ButtonReviewDraft"] }, "entity.SaveDeploymentLogParam": { "type": "object", "required": ["deploy_name"], "properties": { "deploy_name": { "type": "string" } } }, "entity.AutoGenerateEndpoint": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "configuration": { "$ref": "#/definitions/entity.AutoGenerateConfiguration" }, "db": { "type": "string" }, "operations": { "type": "array", "items": { "type": "string" } }, "region": { "type": "string" }, "table": { "type": "string" }, "vector_search_operations": { "$ref": "#/definitions/entity.VectorSearchOperations" } } }, "entity.VectorSearchOperations": { "type": "object", "properties": { "distance_func": { "type": "string" }, "field": { "type": "string" }, "is_enabled": { "type": "boolean" } } }, "entity.AutoGenerateConfiguration": { "type": "object", "properties": { "batch": { "type": "boolean" }, "is_deploy": { "type": "boolean" }, "tag": { "type": "string" }, "timeout": { "type": "integer" } } }, "entity.StatementParamV2": { "type": "object", "required": ["cluster_id", "session_id", "sql"], "properties": { "args": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/entity.StatementArgs" } } }, "cluster_id": { "type": "string" }, "database": { "type": "string" }, "session_id": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.EndpointSettings" }, "sql": { "type": "string" } } }, "entity.VerifyBatch": { "type": "object", "properties": { "method": { "type": "string" }, "sql": { "type": "string" } } }, "dto.CreateAutoGenerateEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointFormat" } }, "message": { "type": "string" } } }, "dto.ShowDBsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "dto.ShowTablesRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "dto.Chat2QuerySettings": { "type": "object", "additionalProperties": true, "properties": { "llm_api_key": { "type": "string", "x-nullable": true }, "llm_model": { "type": "string" }, "language_code": { "type": "string" } } }, "dto.EdaResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "data": { "$ref": "#/definitions/dto.Chat2QuerySettings" } } }, "dataservices_internal_dto_dataapi.GetSystemEndpointConfigResp": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.SystemEndpointConfigData" }, "message": { "type": "string" } } }, "dataservices_internal_dto_dataapi.SystemEndpointConfigData": { "type": "object", "properties": { "data_endpoints": { "type": "array", "items": { "$ref": "#/definitions/dataservices_internal_dto_dataapi.EndpointConfig" } } } }, "dataservices_internal_dto_dataapi.EndpointConfig": { "type": "object", "properties": { "is_enabled": { "type": "boolean" }, "key": { "type": "string" }, "type": { "type": "string" } } }, "dataservices_internal_dto_dataapi.GenericSuccessApiResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } } } }