Entries schemas

api/server/app-env.ts

@@ -4,4 +4,5 @@ export {
     isDatalensMode,
     isFullMode,
     isApiMode,
+    isPublicApiMode,
 } from '../../src/server/app-env';

api/server/components.ts

@@ -19,3 +19,12 @@ export {
 } from '../../src/server/components/charts-engine';
 
 export {renderHTML} from '../../src/server/components/charts-engine/components/markdown';
+
+export {initPublicApiSwagger} from '../../src/server/components/public-api';
+
+export {PUBLIC_API_PROXY_MAP, PUBLIC_API_ROUTE} from '../../src/server/components/public-api';
+export type {
+    PublicApiRpcMap,
+    PublicApiConfig,
+    PublicApiSecuritySchemes,
+} from '../../src/server/components/public-api/types';

api/server/constants.ts

@@ -1,2 +1,3 @@
 export {SERVICE_NAME_DATALENS} from '../../src/server/constants';
 export {IPV6_AXIOS_OPTIONS} from '../../src/server/constants/axios';
+export {PUBLIC_API_ORG_ID_HEADER} from '../../src/server/constants/public-api';

api/server/controllers.ts

@@ -1,2 +1,3 @@
 export {ping} from '../../src/server/controllers/ping';
 export {chartsController} from '../../src/server/components/charts-engine/controllers/charts';
+export {createPublicApiController} from '../../src/server/controllers';

package.json

@@ -54,6 +54,7 @@
   "author": "DataLens Team <https://github.com/datalens-tech>",
   "license": "Apache-2.0",
   "dependencies": {
+    "@asteasolutions/zod-to-openapi": "^7.3.4",
     "@braintree/sanitize-url": "^6.0.0",
     "@datalens-tech/ui-sandbox-modules": "^0.36.0",
     "@datalens-tech/xlsx": "^0.20.1",
@@ -118,7 +119,9 @@
     "request-ip": "^3.3.0",
     "request-promise-native": "^1.0.9",
     "set-cookie-parser": "^2.7.1",
-    "workerpool": "^9.1.1"
+    "swagger-ui-express": "^5.0.1",
+    "workerpool": "^9.1.1",
+    "zod": "^3.25.64"
   },
   "devDependencies": {
     "@floating-ui/react": "^0.27.13",
@@ -181,6 +184,7 @@
     "@types/request-ip": "^0.0.41",
     "@types/request-promise-native": "^1.0.21",
     "@types/set-cookie-parser": "^2.4.10",
+    "@types/swagger-ui-express": "^4.1.8",
     "@types/uuid": "^9.0.8",
     "@types/webpack-env": "^1.16.0",
     "bem-cn-lite": "^4.0.0",

src/server/app-env.ts

@@ -10,4 +10,6 @@ export const isFullMode = mode === AppMode.Full;
 export const isDatalensMode = mode === AppMode.Datalens;
 export const isChartsMode = mode === AppMode.Charts;
 export const isApiMode = mode === AppMode.Api;
+export const isPublicApiMode = mode === AppMode.PublicApi;
+
 export const isOpensourceInstallation = appInstallation === AppInstallation.Opensource;

src/server/components/api-docs/constants.ts

@@ -0,0 +1 @@
+export const CONTENT_TYPE_JSON = 'application/json';

src/server/components/api-docs/index.ts

@@ -0,0 +1 @@
+export type {SecuritySchemeObject} from './types';

src/server/components/api-docs/types.ts

@@ -0,0 +1,14 @@
+// Copied from @asteasolutions/zod-to-openapi
+export type Method = 'get' | 'post' | 'put' | 'delete' | 'patch' | 'head' | 'options' | 'trace';
+
+export type SecuritySchemeType = 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+
+export type SecuritySchemeObject = {
+    type: SecuritySchemeType;
+    description?: string;
+    name?: string;
+    in?: string;
+    scheme?: string;
+    bearerFormat?: string;
+    openIdConnectUrl?: string;
+};

src/server/components/public-api/constants.ts

@@ -0,0 +1,87 @@
+import {OpenAPIRegistry} from '@asteasolutions/zod-to-openapi';
+
+import type {PublicApiRpcMap} from './types';
+
+export const publicApiOpenApiRegistry = new OpenAPIRegistry();
+
+export const PUBLIC_API_HTTP_METHOD = 'POST';
+export const PUBLIC_API_URL = '/rpc/:version/:action';
+export const PUBLIC_API_ROUTE = `${PUBLIC_API_HTTP_METHOD} ${PUBLIC_API_URL}`;
+
+enum ApiTag {
+    Connection = 'Connection',
+    Dataset = 'Dataset',
+    Wizard = 'Wizard',
+    Editor = 'Editor',
+    Dashboard = 'Dashboard',
+}
+
+export const PUBLIC_API_PROXY_MAP = {
+    v0: {
+        // Connection
+        deleteConnection: {
+            resolve: (api) => api.bi.deleteConnection,
+            openApi: {
+                summary: 'Delete connection',
+                tags: [ApiTag.Connection],
+            },
+        },
+
+        // Dataset
+        getDataset: {
+            resolve: (api) => api.bi.getDatasetByVersion,
+            openApi: {
+                summary: 'Get dataset',
+                tags: [ApiTag.Dataset],
+            },
+        },
+        updateDataset: {
+            resolve: (api) => api.bi.updateDataset,
+            openApi: {
+                summary: 'Update dataset',
+                tags: [ApiTag.Dataset],
+            },
+        },
+        createDataset: {
+            resolve: (api) => api.bi.createDataset,
+            openApi: {
+                summary: 'Create dataset',
+                tags: [ApiTag.Dataset],
+            },
+        },
+        deleteDataset: {
+            resolve: (api) => api.bi.deleteDataset,
+            openApi: {
+                summary: 'Delete dataset',
+                tags: [ApiTag.Dataset],
+            },
+        },
+
+        // Wizard
+        deleteWizardChart: {
+            resolve: (api) => api.mix.__deleteWizardChart__,
+            openApi: {
+                summary: 'Delete wizard chart',
+                tags: [ApiTag.Wizard],
+            },
+        },
+
+        // Editor
+        deleteEditorChart: {
+            resolve: (api) => api.mix.__deleteEditorChart__,
+            openApi: {
+                summary: 'Delete editor chart',
+                tags: [ApiTag.Editor],
+            },
+        },
+
+        // Dashboard
+        deleteDashboard: {
+            resolve: (api) => api.mix.__deleteDashboard__,
+            openApi: {
+                summary: 'Delete dashboard',
+                tags: [ApiTag.Dashboard],
+            },
+        },
+    },
+} satisfies PublicApiRpcMap;

src/server/components/public-api/index.ts

@@ -0,0 +1,7 @@
+export {
+    PUBLIC_API_PROXY_MAP,
+    PUBLIC_API_HTTP_METHOD,
+    PUBLIC_API_ROUTE,
+    PUBLIC_API_URL,
+} from './constants';
+export {initPublicApiSwagger, registerActionToOpenApi} from './utils';

src/server/components/public-api/types.ts

@@ -0,0 +1,29 @@
+import type {Request, Response} from '@gravity-ui/expresskit';
+import type {ApiWithRoot, GatewayActionUnaryResponse, SchemasByScope} from '@gravity-ui/gateway';
+
+import type {DatalensGatewaySchemas} from '../../types/gateway';
+import type {SecuritySchemeObject} from '../api-docs';
+
+export type PublicApiRpcMap<TSchema extends SchemasByScope = DatalensGatewaySchemas> = Record<
+    string,
+    Record<
+        string,
+        {
+            resolve: (
+                api: ApiWithRoot<TSchema, Request['ctx'], Request, Response>,
+            ) => (params: any) => Promise<GatewayActionUnaryResponse<unknown>>;
+            openApi: {
+                summary: string;
+                tags?: string[];
+            };
+        }
+    >
+>;
+
+export type PublicApiSecuritySchemes = Record<string, SecuritySchemeObject>;
+
+export type PublicApiConfig<TSchema extends SchemasByScope = DatalensGatewaySchemas> = {
+    proxyMap: PublicApiRpcMap<TSchema>;
+    securitySchemes: PublicApiSecuritySchemes;
+    securityTypes: string[];
+};

src/server/components/public-api/utils/index.ts

@@ -0,0 +1,2 @@
+export {initPublicApiSwagger} from './init-public-api-swagger';
+export {registerActionToOpenApi} from './register-action-to-open-api';