[data views] data_views REST API

src/plugins/data_views/server/constants.ts

@@ -0,0 +1,27 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+export const SERVICE_PATH = '/api/data_views';
+export const SERVICE_PATH_LEGACY = '/api/index_patterns';
+export const DATA_VIEW_PATH = `${SERVICE_PATH}/data_view`;
+export const DATA_VIEW_PATH_LEGACY = `${SERVICE_PATH_LEGACY}/index_pattern`;
+export const SPECIFIC_DATA_VIEW_PATH = `${DATA_VIEW_PATH}/{id}`;
+export const SPECIFIC_DATA_VIEW_PATH_LEGACY = `${DATA_VIEW_PATH_LEGACY}/{id}`;
+export const RUNTIME_FIELD_PATH = `${SPECIFIC_DATA_VIEW_PATH}/runtime_field`;
+export const RUNTIME_FIELD_PATH_LEGACY = `${SPECIFIC_DATA_VIEW_PATH_LEGACY}/runtime_field`;
+export const SPECIFIC_RUNTIME_FIELD_PATH = `${RUNTIME_FIELD_PATH}/{name}`;
+export const SPECIFIC_RUNTIME_FIELD_PATH_LEGACY = `${RUNTIME_FIELD_PATH_LEGACY}/{name}`;
+
+export const SCRIPTED_FIELD_PATH = `${SPECIFIC_DATA_VIEW_PATH}/scripted_field`;
+export const SCRIPTED_FIELD_PATH_LEGACY = `${SPECIFIC_DATA_VIEW_PATH_LEGACY}/scripted_field`;
+export const SPECIFIC_SCRIPTED_FIELD_PATH = `${SCRIPTED_FIELD_PATH}/{name}`;
+export const SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY = `${SCRIPTED_FIELD_PATH_LEGACY}/{name}`;
+
+export const SERVICE_KEY = 'data_view';
+export const SERVICE_KEY_LEGACY = 'index_pattern';
+export type SERVICE_KEY_TYPE = typeof SERVICE_KEY | typeof SERVICE_KEY_LEGACY;

src/plugins/data_views/server/index.ts

@@ -35,3 +35,24 @@ export type {
   DataViewsServerPluginStart as PluginStart,
 };
 export { DataViewsServerPlugin as Plugin };
+
+export {
+  SERVICE_PATH,
+  SERVICE_PATH_LEGACY,
+  DATA_VIEW_PATH,
+  DATA_VIEW_PATH_LEGACY,
+  SPECIFIC_DATA_VIEW_PATH,
+  SPECIFIC_DATA_VIEW_PATH_LEGACY,
+  RUNTIME_FIELD_PATH,
+  RUNTIME_FIELD_PATH_LEGACY,
+  SPECIFIC_RUNTIME_FIELD_PATH,
+  SPECIFIC_RUNTIME_FIELD_PATH_LEGACY,
+  SCRIPTED_FIELD_PATH,
+  SCRIPTED_FIELD_PATH_LEGACY,
+  SPECIFIC_SCRIPTED_FIELD_PATH,
+  SPECIFIC_SCRIPTED_FIELD_PATH_LEGACY,
+  SERVICE_KEY,
+  SERVICE_KEY_LEGACY,
+} from './constants';
+
+export type { SERVICE_KEY_TYPE } from './constants';

src/plugins/data_views/server/routes.ts

@@ -9,24 +9,60 @@
 import { schema } from '@kbn/config-schema';
 import { HttpServiceSetup, StartServicesAccessor } from 'kibana/server';
 import { IndexPatternsFetcher } from './fetcher';
-import { registerCreateIndexPatternRoute } from './routes/create_index_pattern';
-import { registerGetIndexPatternRoute } from './routes/get_index_pattern';
-import { registerDeleteIndexPatternRoute } from './routes/delete_index_pattern';
-import { registerUpdateIndexPatternRoute } from './routes/update_index_pattern';
-import { registerUpdateFieldsRoute } from './routes/fields/update_fields';
+import {
+  registerCreateDataViewRoute,
+  registerCreateDataViewRouteLegacy,
+} from './routes/create_index_pattern';
+import {
+  registerGetDataViewRoute,
+  registerGetDataViewRouteLegacy,
+} from './routes/get_index_pattern';
+import {
+  registerDeleteDataViewRoute,
+  registerDeleteDataViewRouteLegacy,
+} from './routes/delete_index_pattern';
+import {
+  registerUpdateDataViewRoute,
+  registerUpdateDataViewRouteLegacy,
+} from './routes/update_index_pattern';
+import {
+  registerUpdateFieldsRoute,
+  registerUpdateFieldsRouteLegacy,
+} from './routes/fields/update_fields';
 import { registerCreateScriptedFieldRoute } from './routes/scripted_fields/create_scripted_field';
 import { registerPutScriptedFieldRoute } from './routes/scripted_fields/put_scripted_field';
 import { registerGetScriptedFieldRoute } from './routes/scripted_fields/get_scripted_field';
 import { registerDeleteScriptedFieldRoute } from './routes/scripted_fields/delete_scripted_field';
 import { registerUpdateScriptedFieldRoute } from './routes/scripted_fields/update_scripted_field';
+import {
+  registerManageDefaultDataViewRoute,
+  registerManageDefaultDataViewRouteLegacy,
+} from './routes/default_index_pattern';
 import type { DataViewsServerPluginStart, DataViewsServerPluginStartDependencies } from './types';
-import { registerManageDefaultIndexPatternRoutes } from './routes/default_index_pattern';
-import { registerCreateRuntimeFieldRoute } from './routes/runtime_fields/create_runtime_field';
-import { registerGetRuntimeFieldRoute } from './routes/runtime_fields/get_runtime_field';
-import { registerDeleteRuntimeFieldRoute } from './routes/runtime_fields/delete_runtime_field';
-import { registerPutRuntimeFieldRoute } from './routes/runtime_fields/put_runtime_field';
-import { registerUpdateRuntimeFieldRoute } from './routes/runtime_fields/update_runtime_field';
-import { registerHasUserIndexPatternRoute } from './routes/has_user_index_pattern';
+import {
+  registerCreateRuntimeFieldRoute,
+  registerCreateRuntimeFieldRouteLegacy,
+} from './routes/runtime_fields/create_runtime_field';
+import {
+  registerGetRuntimeFieldRoute,
+  registerGetRuntimeFieldRouteLegacy,
+} from './routes/runtime_fields/get_runtime_field';
+import {
+  registerDeleteRuntimeFieldRoute,
+  registerDeleteRuntimeFieldRouteLegacy,
+} from './routes/runtime_fields/delete_runtime_field';
+import {
+  registerPutRuntimeFieldRoute,
+  registerPutRuntimeFieldRouteLegacy,
+} from './routes/runtime_fields/put_runtime_field';
+import {
+  registerUpdateRuntimeFieldRoute,
+  registerUpdateRuntimeFieldRouteLegacy,
+} from './routes/runtime_fields/update_runtime_field';
+import {
+  registerHasUserDataViewRoute,
+  registerHasUserDataViewRouteLegacy,
+} from './routes/has_user_index_pattern';
 
 export function registerRoutes(
   http: HttpServiceSetup,
@@ -47,17 +83,37 @@ export function registerRoutes(
 
   const router = http.createRouter();
 
-  // Index Patterns API
-  registerCreateIndexPatternRoute(router, getStartServices);
-  registerGetIndexPatternRoute(router, getStartServices);
-  registerDeleteIndexPatternRoute(router, getStartServices);
-  registerUpdateIndexPatternRoute(router, getStartServices);
-  registerManageDefaultIndexPatternRoutes(router, getStartServices);
-  registerHasUserIndexPatternRoute(router, getStartServices);
+  // Data Views API
+  registerCreateDataViewRoute(router, getStartServices);
+  registerGetDataViewRoute(router, getStartServices);
+  registerDeleteDataViewRoute(router, getStartServices);
+  registerUpdateDataViewRoute(router, getStartServices);
+  registerManageDefaultDataViewRoute(router, getStartServices);
+  registerHasUserDataViewRoute(router, getStartServices);
 
   // Fields API
   registerUpdateFieldsRoute(router, getStartServices);
 
+  // Runtime Fields API
+  registerCreateRuntimeFieldRoute(router, getStartServices);
+  registerGetRuntimeFieldRoute(router, getStartServices);
+  registerDeleteRuntimeFieldRoute(router, getStartServices);
+  registerPutRuntimeFieldRoute(router, getStartServices);
+  registerUpdateRuntimeFieldRoute(router, getStartServices);
+
+  // ###
+  // Legacy Index Pattern API
+  // ###
+  registerCreateDataViewRouteLegacy(router, getStartServices);
+  registerGetDataViewRouteLegacy(router, getStartServices);
+  registerDeleteDataViewRouteLegacy(router, getStartServices);
+  registerUpdateDataViewRouteLegacy(router, getStartServices);
+  registerManageDefaultDataViewRouteLegacy(router, getStartServices);
+  registerHasUserDataViewRouteLegacy(router, getStartServices);
+
+  // Fields API
+  registerUpdateFieldsRouteLegacy(router, getStartServices);
+
   // Scripted Field API
   registerCreateScriptedFieldRoute(router, getStartServices);
   registerPutScriptedFieldRoute(router, getStartServices);
@@ -66,11 +122,12 @@ export function registerRoutes(
   registerUpdateScriptedFieldRoute(router, getStartServices);
 
   // Runtime Fields API
-  registerCreateRuntimeFieldRoute(router, getStartServices);
-  registerGetRuntimeFieldRoute(router, getStartServices);
-  registerDeleteRuntimeFieldRoute(router, getStartServices);
-  registerPutRuntimeFieldRoute(router, getStartServices);
-  registerUpdateRuntimeFieldRoute(router, getStartServices);
+  registerCreateRuntimeFieldRouteLegacy(router, getStartServices);
+  registerGetRuntimeFieldRouteLegacy(router, getStartServices);
+  registerDeleteRuntimeFieldRouteLegacy(router, getStartServices);
+  registerPutRuntimeFieldRouteLegacy(router, getStartServices);
+  registerUpdateRuntimeFieldRouteLegacy(router, getStartServices);
+  // ###
 
   router.get(
     {

src/plugins/data_views/server/routes/create_index_pattern.ts

@@ -7,15 +7,21 @@
  */
 
 import { schema } from '@kbn/config-schema';
-import { IndexPatternSpec } from 'src/plugins/data_views/common';
+import { DataViewSpec } from 'src/plugins/data_views/common';
 import { handleErrors } from './util/handle_errors';
 import {
   fieldSpecSchema,
   runtimeFieldSpecSchema,
   serializedFieldFormatSchema,
 } from './util/schemas';
 import { IRouter, StartServicesAccessor } from '../../../../core/server';
-import type { DataViewsServerPluginStart, DataViewsServerPluginStartDependencies } from '../types';
+import type { DataViewsServerPluginStartDependencies, DataViewsServerPluginStart } from '../types';
+import {
+  DATA_VIEW_PATH,
+  DATA_VIEW_PATH_LEGACY,
+  SERVICE_KEY,
+  SERVICE_KEY_LEGACY,
+} from '../constants';
 
 const indexPatternSpecSchema = schema.object({
   title: schema.string(),
@@ -46,51 +52,63 @@ const indexPatternSpecSchema = schema.object({
   runtimeFieldMap: schema.maybe(schema.recordOf(schema.string(), runtimeFieldSpecSchema)),
 });
 
-export const registerCreateIndexPatternRoute = (
-  router: IRouter,
-  getStartServices: StartServicesAccessor<
-    DataViewsServerPluginStartDependencies,
-    DataViewsServerPluginStart
-  >
-) => {
-  router.post(
-    {
-      path: '/api/index_patterns/index_pattern',
-      validate: {
-        body: schema.object({
-          override: schema.maybe(schema.boolean({ defaultValue: false })),
-          refresh_fields: schema.maybe(schema.boolean({ defaultValue: false })),
-          index_pattern: indexPatternSpecSchema,
-        }),
+const registerCreateDataViewRouteFactory =
+  (path: string, serviceKey: string) =>
+  (
+    router: IRouter,
+    getStartServices: StartServicesAccessor<
+      DataViewsServerPluginStartDependencies,
+      DataViewsServerPluginStart
+    >
+  ) => {
+    router.post(
+      {
+        path,
+        validate: {
+          body: schema.object({
+            override: schema.maybe(schema.boolean({ defaultValue: false })),
+            refresh_fields: schema.maybe(schema.boolean({ defaultValue: false })),
+            [serviceKey]: indexPatternSpecSchema,
+          }),
+        },
       },
-    },
-    router.handleLegacyErrors(
-      handleErrors(async (ctx, req, res) => {
-        const savedObjectsClient = ctx.core.savedObjects.client;
-        const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
-        const [, , { indexPatternsServiceFactory }] = await getStartServices();
-        const indexPatternsService = await indexPatternsServiceFactory(
-          savedObjectsClient,
-          elasticsearchClient,
-          req
-        );
-        const body = req.body;
+      router.handleLegacyErrors(
+        handleErrors(async (ctx, req, res) => {
+          const savedObjectsClient = ctx.core.savedObjects.client;
+          const elasticsearchClient = ctx.core.elasticsearch.client.asCurrentUser;
+          const [, , { dataViewsServiceFactory }] = await getStartServices();
+          const indexPatternsService = await dataViewsServiceFactory(
+            savedObjectsClient,
+            elasticsearchClient,
+            req
+          );
+          const body = req.body;
 
-        const indexPattern = await indexPatternsService.createAndSave(
-          body.index_pattern as IndexPatternSpec,
-          body.override,
-          !body.refresh_fields
-        );
+          const indexPattern = await indexPatternsService.createAndSave(
+            body[serviceKey] as DataViewSpec,
+            body.override as boolean,
+            !body.refresh_fields
+          );
 
-        return res.ok({
-          headers: {
-            'content-type': 'application/json',
-          },
-          body: JSON.stringify({
-            index_pattern: indexPattern.toSpec(),
-          }),
-        });
-      })
-    )
-  );
-};
+          return res.ok({
+            headers: {
+              'content-type': 'application/json',
+            },
+            body: JSON.stringify({
+              [serviceKey]: indexPattern.toSpec(),
+            }),
+          });
+        })
+      )
+    );
+  };
+
+export const registerCreateDataViewRoute = registerCreateDataViewRouteFactory(
+  DATA_VIEW_PATH,
+  SERVICE_KEY
+);
+
+export const registerCreateDataViewRouteLegacy = registerCreateDataViewRouteFactory(
+  DATA_VIEW_PATH_LEGACY,
+  SERVICE_KEY_LEGACY
+);