Attending PR comments

packages/kbn-check-mappings-update-cli/current_mappings.json

@@ -2249,6 +2249,9 @@
   },
   "observability-onboarding-state": {
     "properties": {
+      "type": {
+        "type": "keyword"
+      },
       "state": {
         "type": "object",
         "dynamic": false

x-pack/plugins/observability_onboarding/public/components/app/custom_logs/wizard/api_key_banner.tsx

@@ -21,7 +21,7 @@ import React from 'react';
 import { APIReturnType } from '../../../../services/rest/create_call_api';
 
 type ApiKeyPayload =
-  APIReturnType<'POST /internal/observability_onboarding/logs/flow/create'>;
+  APIReturnType<'POST /internal/observability_onboarding/logs/flow'>;
 
 export type HasPrivileges = boolean;
 

x-pack/plugins/observability_onboarding/public/components/app/custom_logs/wizard/install_elastic_agent.tsx

@@ -87,23 +87,20 @@ export function InstallElasticAgent() {
         logFilePaths,
       } = getState();
       if (!hasAlreadySavedFlow(getState()) && monitoringRole?.hasPrivileges) {
-        return callApi(
-          'POST /internal/observability_onboarding/logs/flow/create',
-          {
-            params: {
-              body: {
-                name: datasetName,
-                state: {
-                  datasetName,
-                  serviceName,
-                  namespace,
-                  customConfigurations,
-                  logFilePaths,
-                },
+        return callApi('POST /internal/observability_onboarding/logs/flow', {
+          params: {
+            body: {
+              name: datasetName,
+              state: {
+                datasetName,
+                serviceName,
+                namespace,
+                customConfigurations,
+                logFilePaths,
               },
             },
-          }
-        );
+          },
+        });
       }
     },
     [monitoringRole?.hasPrivileges]
@@ -120,7 +117,7 @@ export function InstallElasticAgent() {
     } = getState();
     if (onboardingId) {
       return callApi(
-        'PUT /internal/observability_onboarding/flow/{onboardingId}/save',
+        'PUT /internal/observability_onboarding/flow/{onboardingId}',
         {
           params: {
             path: { onboardingId },

x-pack/plugins/observability_onboarding/server/lib/state/get_observability_onboarding_state.ts → x-pack/plugins/observability_onboarding/server/lib/state/get_observability_onboarding_flow.ts

@@ -7,20 +7,20 @@
 
 import { SavedObjectsClientContract } from '@kbn/core/server';
 import {
-  ObservabilityOnboardingState,
+  ObservabilityOnboardingFlow,
   OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
-  SavedObservabilityOnboardingState,
+  SavedObservabilityOnboardingFlow,
 } from '../../saved_objects/observability_onboarding_status';
 
-export async function getObservabilityOnboardingState({
+export async function getObservabilityOnboardingFlow({
   savedObjectsClient,
   savedObjectId,
 }: {
   savedObjectsClient: SavedObjectsClientContract;
   savedObjectId: string;
-}): Promise<SavedObservabilityOnboardingState | undefined> {
+}): Promise<SavedObservabilityOnboardingFlow | undefined> {
   try {
-    const result = await savedObjectsClient.get<ObservabilityOnboardingState>(
+    const result = await savedObjectsClient.get<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       savedObjectId
     );

x-pack/plugins/observability_onboarding/server/lib/state/index.ts

@@ -5,5 +5,5 @@
  * 2.0.
  */
 
-export * from './get_observability_onboarding_state';
-export * from './save_observability_onboarding_state';
+export * from './get_observability_onboarding_flow';
+export * from './save_observability_onboarding_flow';

x-pack/plugins/observability_onboarding/server/lib/state/save_observability_onboarding_state.ts → x-pack/plugins/observability_onboarding/server/lib/state/save_observability_onboarding_flow.ts

@@ -8,26 +8,26 @@
 import { SavedObjectsClientContract, SavedObject } from '@kbn/core/server';
 import {
   OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
-  ObservabilityOnboardingState,
-  SavedObservabilityOnboardingState,
+  ObservabilityOnboardingFlow,
+  SavedObservabilityOnboardingFlow,
 } from '../../saved_objects/observability_onboarding_status';
 
 interface Options {
   savedObjectsClient: SavedObjectsClientContract;
-  observabilityOnboardingState: ObservabilityOnboardingState;
+  observabilityOnboardingState: ObservabilityOnboardingFlow;
   savedObjectId?: string;
 }
-export async function saveObservabilityOnboardingState({
+export async function saveObservabilityOnboardingFlow({
   savedObjectsClient,
   observabilityOnboardingState,
   savedObjectId,
-}: Options): Promise<SavedObservabilityOnboardingState> {
+}: Options): Promise<SavedObservabilityOnboardingFlow> {
   let savedObject: Omit<
-    SavedObject<ObservabilityOnboardingState>,
+    SavedObject<ObservabilityOnboardingFlow>,
     'attributes' | 'references'
   >;
   if (savedObjectId) {
-    savedObject = await savedObjectsClient.update<ObservabilityOnboardingState>(
+    savedObject = await savedObjectsClient.update<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       savedObjectId,
       {
@@ -37,7 +37,7 @@ export async function saveObservabilityOnboardingState({
       }
     );
   } else {
-    savedObject = await savedObjectsClient.create<ObservabilityOnboardingState>(
+    savedObject = await savedObjectsClient.create<ObservabilityOnboardingFlow>(
       OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
       observabilityOnboardingState
     );

x-pack/plugins/observability_onboarding/server/plugin.ts

@@ -23,7 +23,7 @@ import {
   ObservabilityOnboardingPluginStartDependencies,
 } from './types';
 import { ObservabilityOnboardingConfig } from '.';
-import { observabilityOnboardingState } from './saved_objects/observability_onboarding_status';
+import { observabilityOnboardingFlow } from './saved_objects/observability_onboarding_status';
 import { EsLegacyConfigService } from './services/es_legacy_config_service';
 
 export class ObservabilityOnboardingPlugin
@@ -52,7 +52,7 @@ export class ObservabilityOnboardingPlugin
     this.logger.debug('observability_onboarding: Setup');
     this.esLegacyConfigService.setup(core.elasticsearch.legacy.config$);
 
-    core.savedObjects.registerType(observabilityOnboardingState);
+    core.savedObjects.registerType(observabilityOnboardingFlow);
 
     const resourcePlugins = mapValues(plugins, (value, key) => {
       return {

x-pack/plugins/observability_onboarding/server/routes/elastic_agent/route.ts

@@ -10,7 +10,7 @@ import { getAuthenticationAPIKey } from '../../lib/get_authentication_api_key';
 import { createObservabilityOnboardingServerRoute } from '../create_observability_onboarding_server_route';
 import { generateYml } from './generate_yml';
 import { getFallbackESUrl } from '../../lib/get_fallback_urls';
-import { getObservabilityOnboardingState } from '../../lib/state';
+import { getObservabilityOnboardingFlow } from '../../lib/state';
 
 const generateConfig = createObservabilityOnboardingServerRoute({
   endpoint: 'GET /internal/observability_onboarding/elastic_agent/config',
@@ -38,7 +38,7 @@ const generateConfig = createObservabilityOnboardingServerRoute({
       ? [plugins.cloud?.setup?.elasticsearchUrl]
       : await getFallbackESUrl(esLegacyConfigService);
 
-    const savedState = await getObservabilityOnboardingState({
+    const savedState = await getObservabilityOnboardingFlow({
       savedObjectsClient,
       savedObjectId: onboardingId,
     });

x-pack/plugins/observability_onboarding/server/routes/flow/route.ts

@@ -8,15 +8,15 @@
 import Boom from '@hapi/boom';
 import * as t from 'io-ts';
 import {
-  getObservabilityOnboardingState,
-  saveObservabilityOnboardingState,
+  getObservabilityOnboardingFlow,
+  saveObservabilityOnboardingFlow,
 } from '../../lib/state';
-import { ObservabilityOnboardingState } from '../../saved_objects/observability_onboarding_status';
+import { ObservabilityOnboardingFlow } from '../../saved_objects/observability_onboarding_status';
 import { createObservabilityOnboardingServerRoute } from '../create_observability_onboarding_server_route';
 import { getHasLogs } from './get_has_logs';
 
 const updateOnboardingFlowRoute = createObservabilityOnboardingServerRoute({
-  endpoint: 'PUT /internal/observability_onboarding/flow/{onboardingId}/save',
+  endpoint: 'PUT /internal/observability_onboarding/flow/{onboardingId}',
   options: { tags: [] },
   params: t.type({
     path: t.type({
@@ -37,14 +37,14 @@ const updateOnboardingFlowRoute = createObservabilityOnboardingServerRoute({
     } = resources;
     const coreStart = await core.start();
     const savedObjectsClient = coreStart.savedObjects.getScopedClient(request);
-    const { id } = await saveObservabilityOnboardingState({
+    const { id } = await saveObservabilityOnboardingFlow({
       savedObjectsClient,
       savedObjectId: onboardingId,
       observabilityOnboardingState: {
         type: 'logFiles',
         state,
         progress: {},
-      } as ObservabilityOnboardingState,
+      } as ObservabilityOnboardingFlow,
     });
     return { onboardingId: id };
   },
@@ -78,7 +78,7 @@ const stepProgressUpdateRoute = createObservabilityOnboardingServerRoute({
       coreStart.savedObjects.createInternalRepository();
 
     const savedObservabilityOnboardingState =
-      await getObservabilityOnboardingState({
+      await getObservabilityOnboardingFlow({
         savedObjectsClient,
         savedObjectId: id,
       });
@@ -95,7 +95,7 @@ const stepProgressUpdateRoute = createObservabilityOnboardingServerRoute({
       ...observabilityOnboardingState
     } = savedObservabilityOnboardingState;
 
-    await saveObservabilityOnboardingState({
+    await saveObservabilityOnboardingFlow({
       savedObjectsClient,
       savedObjectId,
       observabilityOnboardingState: {
@@ -132,7 +132,7 @@ const getProgressRoute = createObservabilityOnboardingServerRoute({
     const coreStart = await core.start();
     const savedObjectsClient = coreStart.savedObjects.getScopedClient(request);
     const savedObservabilityOnboardingState =
-      await getObservabilityOnboardingState({
+      await getObservabilityOnboardingFlow({
         savedObjectsClient,
         savedObjectId: onboardingId,
       });

x-pack/plugins/observability_onboarding/server/routes/logs/route.ts

@@ -9,9 +9,9 @@ import * as t from 'io-ts';
 import { createObservabilityOnboardingServerRoute } from '../create_observability_onboarding_server_route';
 import { getFallbackKibanaUrl } from '../../lib/get_fallback_urls';
 import { hasLogMonitoringPrivileges } from './api_key/has_log_monitoring_privileges';
-import { saveObservabilityOnboardingState } from '../../lib/state';
+import { saveObservabilityOnboardingFlow } from '../../lib/state';
 import { createShipperApiKey } from './api_key/create_shipper_api_key';
-import { ObservabilityOnboardingState } from '../../saved_objects/observability_onboarding_status';
+import { ObservabilityOnboardingFlow } from '../../saved_objects/observability_onboarding_status';
 
 const logMonitoringPrivilegesRoute = createObservabilityOnboardingServerRoute({
   endpoint: 'GET /internal/observability_onboarding/logs/setup/privileges',
@@ -59,7 +59,7 @@ const installShipperSetupRoute = createObservabilityOnboardingServerRoute({
 });
 
 const createFlowRoute = createObservabilityOnboardingServerRoute({
-  endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+  endpoint: 'POST /internal/observability_onboarding/logs/flow',
   options: { tags: [] },
   params: t.type({
     body: t.intersection([
@@ -93,11 +93,11 @@ const createFlowRoute = createObservabilityOnboardingServerRoute({
 
     const savedObjectsClient = coreStart.savedObjects.getScopedClient(request);
 
-    const { id } = await saveObservabilityOnboardingState({
+    const { id } = await saveObservabilityOnboardingFlow({
       savedObjectsClient,
       observabilityOnboardingState: {
         type: 'logFiles',
-        state: state as ObservabilityOnboardingState['state'],
+        state: state as ObservabilityOnboardingFlow['state'],
         progress: {},
       },
     });

x-pack/plugins/observability_onboarding/server/saved_objects/observability_onboarding_status.ts

@@ -8,7 +8,7 @@
 import { SavedObjectsType } from '@kbn/core/server';
 
 export const OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE =
-  'observability-onboarding-state';
+  'observability-onboarding-flow';
 export interface LogFilesState {
   datasetName: string;
   serviceName?: string;
@@ -19,7 +19,7 @@ export interface LogFilesState {
 
 type ObservabilityOnboardingFlowState = LogFilesState | undefined;
 
-export interface ObservabilityOnboardingState {
+export interface ObservabilityOnboardingFlow {
   type: 'logFiles';
   state: ObservabilityOnboardingFlowState;
   progress: Record<
@@ -31,13 +31,13 @@ export interface ObservabilityOnboardingState {
   >;
 }
 
-export interface SavedObservabilityOnboardingState
-  extends ObservabilityOnboardingState {
+export interface SavedObservabilityOnboardingFlow
+  extends ObservabilityOnboardingFlow {
   id: string;
   updatedAt: number;
 }
 
-export const observabilityOnboardingState: SavedObjectsType = {
+export const observabilityOnboardingFlow: SavedObjectsType = {
   name: OBSERVABILITY_ONBOARDING_STATE_SAVED_OBJECT_TYPE,
   hidden: false,
   namespaceType: 'agnostic',

x-pack/test/observability_onboarding_api_integration/tests/elastic_agent/config.spec.ts

@@ -33,7 +33,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
 
     before(async () => {
       const req = await observabilityOnboardingApiClient.logMonitoringUser({
-        endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+        endpoint: 'POST /internal/observability_onboarding/logs/flow',
         params: {
           body: {
             name: 'name',

x-pack/test/observability_onboarding_api_integration/tests/flow/progress/progress.spec.ts

@@ -41,7 +41,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
 
     before(async () => {
       const req = await observabilityOnboardingApiClient.logMonitoringUser({
-        endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+        endpoint: 'POST /internal/observability_onboarding/logs/flow',
         params: {
           body: {
             name: 'name',

x-pack/test/observability_onboarding_api_integration/tests/logs/create.spec.ts

@@ -18,7 +18,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
 
   async function callApiWithoutPrivileges(state = {}) {
     return await observabilityOnboardingApiClient.readUser({
-      endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+      endpoint: 'POST /internal/observability_onboarding/logs/flow',
       params: {
         body: {
           name: 'name',
@@ -30,7 +30,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
 
   async function callApiWithPrivileges(state = {}) {
     return await observabilityOnboardingApiClient.logMonitoringUser({
-      endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+      endpoint: 'POST /internal/observability_onboarding/logs/flow',
       params: {
         body: {
           name: 'name',

x-pack/test/observability_onboarding_api_integration/tests/logs/update_step_progress.spec.ts

@@ -64,7 +64,7 @@ export default function ApiTest({ getService }: FtrProviderContext) {
 
       beforeEach(async () => {
         const req = await observabilityOnboardingApiClient.logMonitoringUser({
-          endpoint: 'POST /internal/observability_onboarding/logs/flow/create',
+          endpoint: 'POST /internal/observability_onboarding/logs/flow',
           params: {
             body: {
               name: 'name',