{ "swagger": "2.0", "info": { "description": "This is Data API server", "title": "DataAPI API", "contact": {}, "version": "1.0" }, "host": "127.0.0.1:8080", "basePath": "/api/v1/dataservices/central", "paths": { "/external/appexport/openapi": { "get": { "description": "Export dataapp to openapi doc", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "dataapi" ], "summary": "Export dataapp to openapi doc", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataappPostmanCollection" } } } } }, "/external/appexport/postman": { "get": { "description": "Export dataapp to postman collection", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "dataapi" ], "summary": "Export dataapp to postman collection", "parameters": [ { "type": "string", "description": "app ID", "name": "app_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DataappPostmanCollection" } } } } }, "/orgs/:org_id/projects/:project_id/apps/:app_id/auto/endpoints": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps": { "get": { "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": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListDataAppRes" } } } }, "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}": { "get": { "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": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys": { "get": { "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": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListAPIKeysRes" } } } }, "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/expire_all": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/{apikey_id}": { "put": { "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 }, { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/apikeys/{apikey_id}/expire_key": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/authorize-url": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/batchexample": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters": { "get": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}": { "delete": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs/{db_name}/tables": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/clusters/{cluster_id}/dbs/{db_name}/tables/{table_name}/vector/fields": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/custom-domains": { "get": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/custom-domains/{custom_domain_id}": { "put": { "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 }, { "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": { "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 } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonApiResp" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/default-domains": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/config": { "get": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/diff": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs": { "get": { "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", "required": true }, { "type": "string", "description": "limit", "name": "limit", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.ListDataAppDeployLogsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/:log_id/deploy": { "post": { "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 }, { "description": "request_body", "name": "request_body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/entity.DeployDataAppParam" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/{log_id}": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/logs/{log_id}/diff": { "get": { "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": "query" }, { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/deploy/status": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/discard": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/download_log_task": { "post": { "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": "endpoint filter", "name": "endpoint_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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/download_log_task/{task_id}": { "get": { "description": "get download log task status", "produces": [ "application/json" ], "tags": [ "dataapi" ], "summary": "get download log task status", "parameters": [ { "type": "string", "description": "download task id", "name": "task_id", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.DownloadDataAPPLogTaskStatusRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints": { "get": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}": { "get": { "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": { "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.UpdateEndpointRes" } } } }, "delete": { "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": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/baseurl": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/discard": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/draft/diff": { "post": { "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}/apps/{app_id}/endpoints/{endpoint_id}/dump": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/example": { "get": { "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 }, { "type": "string", "description": "enum: basic/digest, default value is digest", "name": "auth_type", "in": "query" }, { "type": "string", "description": "enum: curl/js, default value is curl", "name": "language", "in": "query" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.TestEndpointRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/offline": { "put": { "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.BaseResp" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/online": { "post": { "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.EndpointPublishRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/sessions": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/statements": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/test": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/version/{version}/status": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/endpoints/{endpoint_id}/versions": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/exportlink": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github/link": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/github/unlink": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/log": { "get": { "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": "string", "description": "endpoint filter", "name": "endpoint_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": "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/log_response_body_switch": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/avg_request_rate": { "get": { "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": "integer", "description": "invertal duration sec", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/avg_response_time": { "get": { "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": "integer", "description": "invertal duration sec", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/high_latency": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/most_error": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/endpoints_rank/most_request": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/error_rate": { "get": { "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": "integer", "description": "invertal duration sec", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/misc_statistic": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/response_time_tp99": { "get": { "description": "get DataApp tp99 response time", "produces": [ "application/json" ], "tags": [ "dataapi" ], "summary": "get DataApp tp99 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": "integer", "description": "invertal duration sec", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/metrics/unauth_req_num": { "get": { "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": "integer", "description": "invertal duration sec", "name": "step", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.CommonPromMetricsRes" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas/authorize": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/oas/download": { "get": { "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": {} } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/postmanstatus": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories/{repo_id}/branches": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/repositories/{repo_id}/validate": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/samplestatus": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/systemendpoint": { "get": { "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/dto.GetSystemEndpointConfigResp" } } } }, "post": { "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/dto.SystemEndpointConfigData" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.GenericSuccessApiResponse" } } } } }, "/orgs/{org_id}/projects/{project_id}/apps/{app_id}/updatestatus": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/clusters/{cluster_id}/apps": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/external-apps/{external_app_id}/oas": { "get": { "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": "external_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" } } } } }, "/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 }, { "type": "string", "description": "Type", "name": "type", "in": "path", "required": true }, { "type": "integer", "description": "month", "name": "month", "in": "path", "required": true }, { "type": "integer", "description": "year", "name": "year", "in": "path", "required": true }, { "type": "string", "description": "class", "name": "class", "in": "path", "required": true }, { "type": "string", "description": "region", "name": "region", "in": "path", "required": true }, { "type": "integer", "description": "dataapp_id", "name": "dataapp_id", "in": "path", "required": true }, { "type": "integer", "description": "start", "name": "start", "in": "path", "required": true }, { "type": "integer", "description": "end", "name": "end", "in": "path", "required": true }, { "type": "integer", "description": "step", "name": "step", "in": "path", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/dto.OKType" } } } } }, "/orgs/{org_id}/projects/{project_id}/preflight-request": { "post": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories/{repo_id}/branches": { "get": { "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" } } } } }, "/orgs/{org_id}/projects/{project_id}/preflight-request/{request_id}/repositories/{repo_id}/validate": { "post": { "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" } } } } } }, "definitions": { "dto.AppClusterInfo": { "type": "object", "properties": { "cloud": { "type": "string" }, "cluster_id": { "type": "string", "example": "0" }, "cluster_name": { "type": "string" }, "dataapp_id": { "type": "integer" }, "region": { "type": "string" }, "tier_type": { "type": "string" } } }, "dto.BaseResp": { "type": "object", "properties": { "err_code": { "type": "integer" }, "err_msg": { "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.CheckPostmanStatusRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "boolean" }, "message": { "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.SampleDataTaskRecord" } } } }, "message": { "type": "string" } } }, "dto.ClusterLinkedAPPResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DataAppInfo" } } } }, "dto.CodeExample": { "type": "object", "properties": { "code": { "type": "string" }, "type": { "type": "string" } } }, "dto.CommonApiResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" } } }, "dto.CommonEndpointsRankRes": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "rank": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointsRankItem" } } } }, "dto.CommonPromMetricsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.PromData" }, "message": { "type": "string" }, "status": { "type": "string" } } }, "dto.CreateAPIKeyRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.RbacApiKey" }, "message": { "type": "string" } } }, "dto.CreateAppClusterReq": { "type": "object", "required": [ "cluster_ids" ], "properties": { "cluster_ids": { "type": "array", "items": { "type": "string" } }, "org_id": { "type": "integer" }, "project_id": { "type": "integer" } } }, "dto.CreateAutoGenerateEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointFormat" } }, "message": { "type": "string" } } }, "dto.CreateDataAppOut": { "type": "object", "properties": { "app_info": { "$ref": "#/definitions/dto.DataAppInfo" }, "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.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.DBColumn": { "type": "object", "properties": { "col": { "type": "string" }, "data_type": { "type": "string" }, "nullable": { "type": "boolean" } } }, "dto.DBRow": { "type": "object", "additionalProperties": { "type": "string" } }, "dto.DataAppInfo": { "type": "object", "properties": { "apikey_max_rpm": { "type": "integer" }, "app_name": { "type": "string" }, "app_type": { "type": "string" }, "app_version": { "type": "string" }, "base_url": { "type": "string" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "created_by": { "type": "string" }, "deployment_region": { "type": "string" }, "description": { "type": "string" }, "endpoints": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointSummary" } }, "external_app_id": { "type": "string" }, "id": { "type": "integer" }, "oas_authorized": { "type": "boolean" }, "open_api_link": { "type": "string" }, "org_id": { "type": "string" }, "project_id": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.DataAppSettings" }, "status": { "description": "dataapp current status: normal,initializing", "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" } } }, "dto.DataAppLogEntry": { "type": "object", "properties": { "client_info": { "type": "string" }, "date_time": { "type": "integer" }, "endpoint_id": { "type": "string" }, "endpoint_name": { "type": "string" }, "http_code": { "type": "integer" }, "http_code_message": { "type": "string" }, "method": { "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" } } }, "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.DataappExportLinkRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.DataappPostmanAPI": { "type": "object", "properties": { "name": { "type": "string" }, "protocolProfileBehavior": { "type": "object", "properties": { "followAuthorizationHeader": { "type": "boolean" }, "followOriginalHttpMethod": { "type": "boolean" }, "followRedirects": { "type": "boolean" } } }, "request": { "type": "object", "properties": { "body": { "$ref": "#/definitions/dto.DataappPostmanBody" }, "header": { "type": "array", "items": { "$ref": "#/definitions/dto.DataappPostmanVal" } }, "method": { "type": "string" }, "url": { "type": "string" } } } } }, "dto.DataappPostmanBody": { "type": "object", "properties": { "mode": { "type": "string" }, "options": { "type": "object", "additionalProperties": true }, "raw": { "type": "string" } } }, "dto.DataappPostmanCollection": { "type": "object", "properties": { "auth": { "type": "object", "properties": { "digest": { "type": "array", "items": { "$ref": "#/definitions/dto.DataappPostmanVal" } }, "type": { "type": "string" } } }, "info": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "schema": { "type": "string" } } }, "item": { "type": "array", "items": { "$ref": "#/definitions/dto.DataappPostmanCollectionFolder" } }, "variable": { "type": "array", "items": { "$ref": "#/definitions/dto.DataappPostmanVal" } } } }, "dto.DataappPostmanCollectionFolder": { "type": "object", "properties": { "item": { "type": "array", "items": { "$ref": "#/definitions/dto.DataappPostmanAPI" } }, "name": { "type": "string" } } }, "dto.DataappPostmanVal": { "type": "object", "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "value": { "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.DumpEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "endpoint": { "$ref": "#/definitions/dto.EndpointFormat" }, "message": { "type": "string" } } }, "dto.EndpointBaseUrlRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.EndpointCodeExample": { "type": "object", "properties": { "examples": { "type": "array", "items": { "$ref": "#/definitions/dto.CodeExample" } }, "method": { "type": "string" }, "path": { "type": "string" } } }, "dto.EndpointConfig": { "type": "object", "required": [ "key" ], "properties": { "is_enabled": { "type": "boolean" }, "key": { "type": "string" }, "type": { "type": "string" } } }, "dto.EndpointDataRes": { "type": "object", "properties": { "columns": { "type": "array", "items": { "$ref": "#/definitions/dto.DBColumn" } }, "end_ms": { "type": "integer" }, "err_code": { "type": "integer" }, "err_message": { "type": "string" }, "latency": { "type": "string" }, "limit": { "type": "integer" }, "query": { "type": "string" }, "row_affect": { "type": "integer" }, "row_count": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "start_ms": { "type": "integer" }, "warn_count": { "type": "integer" }, "warn_messages": { "type": "array", "items": { "type": "string" } } } }, "dto.EndpointDeployRes": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "object", "properties": { "completed": { "type": "boolean" }, "version": { "type": "string" } } } } }, "dto.EndpointFormat": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointArgs" } }, "batch": { "type": "boolean" }, "cluster_id": { "type": "string" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "created_by": { "type": "string" }, "dataappp_id": { "type": "integer" }, "database": { "type": "string" }, "description": { "type": "string" }, "endpoint": { "type": "string" }, "has_modified": { "type": "boolean" }, "id": { "type": "integer" }, "is_online": { "type": "boolean" }, "method": { "type": "string" }, "name": { "type": "string" }, "service_url": { "type": "string" }, "settings": { "$ref": "#/definitions/entity.EndpointSettings" }, "sql_template": { "type": "string" }, "tag": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" }, "vid": { "type": "string", "example": "0" } } }, "dto.EndpointPublishHistory": { "type": "object", "properties": { "dataappp_id": { "type": "integer" }, "endpoint_id": { "type": "integer" }, "is_online": { "type": "integer" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "version": { "type": "string" } } }, "dto.EndpointPublishRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "object", "properties": { "version": { "type": "string" } } }, "message": { "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" }, "row_affect": { "type": "integer" }, "row_count": { "type": "integer" }, "start_ms": { "type": "integer" } } }, "rows": { "type": "array", "items": { "$ref": "#/definitions/dto.DBRow" } } } }, "type": { "type": "string" } } }, "dto.EndpointStatistic": { "type": "object", "properties": { "deployed": { "type": "integer" }, "draft": { "type": "integer" } } }, "dto.EndpointSummary": { "type": "object", "properties": { "cluster_id": { "type": "string" }, "dataappp_id": { "type": "integer" }, "endpoint": { "type": "string" }, "has_modified": { "type": "boolean" }, "id": { "type": "integer" }, "is_online": { "type": "integer" }, "method": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "vid": { "type": "string", "example": "0" } } }, "dto.EndpointsRankItem": { "type": "object", "properties": { "endpoint_id": { "type": "string" }, "endpoint_name": { "type": "string" }, "rank_value": { "type": "string" } } }, "dto.FieldError": { "type": "object", "properties": { "error": { "type": "string" }, "field": { "type": "string" } } }, "dto.GenericSuccessApiResponse": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "string" }, "message": { "type": "string" } } }, "dto.GetAuthorizeUrl": { "type": "object", "properties": { "preflight_request_id": { "type": "string" }, "url": { "type": "string" } } }, "dto.GetAuthorizeUrlResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.GetAuthorizeUrl" } } }, "dto.GetDataAppDeployDiffRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.SnapshotDiff" }, "message": { "type": "string" } } }, "dto.GetDataAppDeploySettingRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DataAppDeploymentSetting" }, "message": { "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.GetDataAppRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DataApp" }, "message": { "type": "string" } } }, "dto.GetDeploymentStatus": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/entity.DeploymentStatus" }, "message": { "type": "string" } } }, "dto.GetEndpointRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.EndpointFormat" }, "message": { "type": "string" } } }, "dto.GetOpenApiSpecificationResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.OpenApiSpecification" } } }, "dto.GetSystemEndpointConfigResp": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "$ref": "#/definitions/dto.SystemEndpointConfigData" }, "message": { "type": "string" } } }, "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" }, "enable_automatic_deployment": { "type": "boolean" }, "installation_id": { "type": "integer" }, "repository_full_name": { "type": "string" }, "repository_id": { "type": "integer" } } }, "dto.GithubRepository": { "type": "object", "properties": { "full_name": { "type": "string" }, "id": { "type": "integer" }, "installation_id": { "type": "integer" }, "private": { "type": "boolean" } } }, "dto.GithubRepositoryBranch": { "type": "object", "properties": { "name": { "type": "string" }, "protected": { "type": "boolean" } } }, "dto.ListAPIKeysRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.RbacApiKey" } }, "message": { "type": "string" } } }, "dto.ListAppClusterResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.AppClusterInfo" } } } }, "dto.ListAuthorizedRepositoriesResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.GithubRepository" } } } }, "dto.ListBranchesResp": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.GithubRepositoryBranch" } } } }, "dto.ListCustomDomainsResponse": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.CustomDomain" } } } }, "dto.ListDataAppDeployLogsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/entity.DataAppDeploymentLog" } }, "message": { "type": "string" } } }, "dto.ListDataAppRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.DataAppInfo" } }, "message": { "type": "string" } } }, "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.ListDefaultDomainsResponse": { "type": "object", "properties": { "base_resp": { "$ref": "#/definitions/dto.BaseResp" }, "data": { "$ref": "#/definitions/dto.ListDefaultDomainsData" } } }, "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" } } }, "dto.OKType": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } }, "dto.OpenApiSpecification": { "type": "object", "properties": { "document": { "type": "string" }, "filename": { "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", "type": "object", "additionalProperties": { "type": "string" } }, "values": { "description": "see https://prometheus.io/docs/prometheus/latest/querying/api/#range-vectors", "type": "array", "items": { "type": "array", "items": {} } } } }, "dto.RbacApiKey": { "type": "object", "properties": { "access_key": { "type": "string" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "created_by": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": "string" }, "rate_limit_rpm": { "type": "integer" }, "role": { "type": "string" }, "secret_key": { "type": "string" }, "source": { "description": "Base64Key string `json:\"base64_key,omitempty\"`", "type": "string" }, "ttl_in_min": { "type": "integer" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" } } }, "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.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.ShowVectorFieldsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "type": "string" } }, "message": { "type": "string" } } }, "dto.StatementsRes": { "type": "object", "properties": { "code": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointDataRes" } }, "message": { "type": "string" } } }, "dto.SubmitDownloadDataAPPLogTaskRes": { "type": "object", "properties": { "code": { "type": "integer" }, "message": { "type": "string" }, "task_id": { "type": "string" } } }, "dto.SystemEndpointConfigData": { "type": "object", "properties": { "data_endpoints": { "type": "array", "items": { "$ref": "#/definitions/dto.EndpointConfig" } } } }, "dto.TestEndpointRes": { "type": "object", "properties": { "data": { "$ref": "#/definitions/dto.EndpointResult" } } }, "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" } } }, "entity.AppClusterDiff": { "type": "object", "properties": { "added": { "type": "array", "items": { "type": "integer" } }, "deleted": { "type": "array", "items": { "type": "integer" } } } }, "entity.AutoGenerateConfiguration": { "type": "object", "properties": { "batch": { "type": "boolean" }, "is_deploy": { "type": "boolean" }, "tag": { "type": "string" }, "timeout": { "type": "integer" } } }, "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.ChangeLogResponseBodySwitchParam": { "type": "object", "properties": { "new_status": { "description": "Enum: [on off]", "type": "string" } } }, "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", "app_type" ], "properties": { "app_name": { "type": "string" }, "app_type": { "type": "string", "enum": [ "dataapi", "chat2query" ] }, "app_version": { "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" } } }, "entity.CreateEndpointParam": { "type": "object", "properties": { "args": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointArgs" } }, "batch": { "type": "boolean" }, "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", "example": "0" }, "database": { "type": "string" } } }, "entity.CustomDomain": { "type": "object", "properties": { "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "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" }, "reason": { "type": "string" }, "state": { "description": "Additional not persisted status", "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" } } }, "entity.DataApp": { "type": "object", "properties": { "app_name": { "type": "string" }, "app_type": { "type": "string" }, "app_version": { "type": "string" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "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" }, "settings": { "$ref": "#/definitions/entity.DataAppSettings" }, "status": { "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" } } }, "entity.DataAppDeploymentLog": { "type": "object", "properties": { "commit_id": { "type": "string" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "created_by": { "type": "string" }, "dataapp_id": { "type": "integer" }, "deployed_at": { "$ref": "#/definitions/utils.JsonTime" }, "diff_url": { "type": "string" }, "finished_at": { "$ref": "#/definitions/utils.JsonTime" }, "id": { "type": "integer" }, "name": { "type": "string" }, "origin": { "type": "string" }, "ran_at": { "$ref": "#/definitions/utils.JsonTime" }, "redeploy_from_id": { "type": "integer" }, "snapshot": { "type": "string" }, "status": { "type": "string" }, "status_error_msg": { "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" } } }, "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.DataAppDiff": { "type": "object", "properties": { "modify": { "$ref": "#/definitions/entity.DataApp" } } }, "entity.DataAppSettings": { "type": "object", "properties": { "log_exec_result": { "type": "boolean" } } }, "entity.DeployDataAppParam": { "type": "object", "properties": { "deploy_name": { "type": "string" } } }, "entity.DeployEndpointReq": { "type": "object", "properties": { "deploy_name": { "type": "string" } } }, "entity.DeploymentStatus": { "type": "object", "properties": { "action_time": { "$ref": "#/definitions/utils.JsonTime" }, "action_type": { "type": "string" }, "button_status": { "type": "string" }, "message": { "type": "string" }, "origin": { "type": "string" } } }, "entity.DeploymentSwithConfig": { "type": "object", "properties": { "enable_automatic_deployment": { "type": "boolean" }, "enable_ui_drafts": { "type": "boolean" } } }, "entity.Endpoint": { "type": "object", "properties": { "args": { "type": "string" }, "batch": { "type": "boolean" }, "cluster_id": { "type": "integer" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "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" }, "tag": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" }, "vid": { "type": "integer" } } }, "entity.EndpointArgs": { "type": "object", "properties": { "default": { "type": "string" }, "description": { "type": "string" }, "enum": { "type": "string" }, "is_path_parameter": { "type": "boolean" }, "item_type": { "type": "string" }, "name": { "type": "string" }, "required": { "type": "integer" }, "type": { "type": "string" } } }, "entity.EndpointPublish": { "type": "object", "properties": { "args": { "type": "string" }, "batch": { "type": "boolean" }, "cluster_id": { "type": "integer" }, "created_at": { "$ref": "#/definitions/utils.JsonTime" }, "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" }, "tag": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "$ref": "#/definitions/utils.JsonTime" }, "updated_by": { "type": "string" }, "version": { "type": "string" } } }, "entity.EndpointSettings": { "type": "object", "properties": { "cache_enabled": { "type": "integer" }, "cache_ttl": { "type": "integer" }, "enable_pagination": { "description": "enable pagination, 0 or 1", "type": "integer" }, "row_limit": { "type": "integer" }, "timeout": { "type": "integer" } } }, "entity.EndpointsDiff": { "type": "object", "properties": { "added": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "deleted": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "deleted_publish": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointPublish" } }, "modified": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } }, "modified_detail": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "modified_publish": { "type": "array", "items": { "$ref": "#/definitions/entity.EndpointPublish" } }, "no_change": { "type": "array", "items": { "$ref": "#/definitions/entity.Endpoint" } } } }, "entity.LinkGithubParam": { "type": "object", "properties": { "branch": { "type": "string" }, "directory": { "type": "string" }, "enable_automatic_deployment": { "type": "boolean" }, "installation_id": { "type": "integer" }, "repository_id": { "type": "integer" } } }, "entity.SampleDataTaskRecord": { "type": "object", "properties": { "message": { "type": "string" }, "start_time": { "$ref": "#/definitions/utils.JsonTime" }, "state": { "description": "import_data,create_endpoint,deploy_endpoint,success,fail", "type": "string" } } }, "entity.SaveDeploymentLogParam": { "type": "object", "required": [ "deploy_name" ], "properties": { "deploy_name": { "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.StatementArgs": { "type": "object", "properties": { "default": { "type": "string" }, "description": { "type": "string" }, "enum": { "type": "string" }, "is_path_parameter": { "type": "boolean" }, "item_type": { "type": "string" }, "name": { "type": "string" }, "required": { "type": "integer" }, "type": { "type": "string" }, "value": {} } }, "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.TestEndpointArgs": { "type": "object", "required": [ "name", "type" ], "properties": { "name": { "type": "string" }, "type": { "type": "string" }, "value": {} } }, "entity.TestEndpointParamV2": { "type": "object", "properties": { "args": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/definitions/entity.TestEndpointArgs" } } } } }, "entity.UpdateAPIKeyParam": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string" }, "new_role": { "type": "string" }, "new_ttl_in_min": { "type": "integer" }, "old_role": { "type": "string" }, "old_ttl_in_min": { "type": "integer" }, "rate_limit_rpm": { "type": "integer" } } }, "entity.UpdateDataAppParam": { "type": "object", "required": [ "app_name" ], "properties": { "app_name": { "type": "string" }, "app_version": { "type": "string" }, "deployment_region": { "type": "string" }, "description": { "type": "string" } } }, "entity.VectorSearchOperations": { "type": "object", "properties": { "distance_func": { "type": "string" }, "field": { "type": "string" }, "is_enabled": { "type": "boolean" } } }, "utils.JsonTime": { "type": "object", "properties": { "time.Time": { "type": "string" } } } } }