From 57fcafb581973859f77c9828c340a526bc22ce7b Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 6 Jun 2024 09:49:42 -0700 Subject: [PATCH 01/10] [DOCS] Add descriptions to connector APIs --- x-pack/plugins/actions/server/routes/connector/get/get.ts | 2 ++ .../plugins/actions/server/routes/connector/get_all/get_all.ts | 2 ++ .../actions/server/routes/connector/list_types/list_types.ts | 1 + x-pack/plugins/actions/server/routes/create.ts | 2 ++ x-pack/plugins/actions/server/routes/delete.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/create.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/delete.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/execute.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/get.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/get_all.ts | 2 ++ .../plugins/actions/server/routes/legacy/list_action_types.ts | 2 ++ x-pack/plugins/actions/server/routes/legacy/update.ts | 2 ++ x-pack/plugins/actions/server/routes/update.ts | 2 ++ 13 files changed, 25 insertions(+) diff --git a/x-pack/plugins/actions/server/routes/connector/get/get.ts b/x-pack/plugins/actions/server/routes/connector/get/get.ts index bb15a2e2e5cf57..9f5b141eecf893 100644 --- a/x-pack/plugins/actions/server/routes/connector/get/get.ts +++ b/x-pack/plugins/actions/server/routes/connector/get/get.ts @@ -26,6 +26,8 @@ export const getConnectorRoute = ( options: { access: 'public', summary: `Get connector information`, + description: + 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { params: getConnectorParamsSchemaV1, diff --git a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts index b5ffb4499b0736..03ee2b3731ff0f 100644 --- a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts +++ b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts @@ -23,6 +23,8 @@ export const getAllConnectorsRoute = ( options: { access: 'public', summary: `Get all connectors`, + description: + 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts b/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts index 4632a6fb9e83ec..d4446e9a840d3c 100644 --- a/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts +++ b/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts @@ -27,6 +27,7 @@ export const listTypesRoute = ( options: { access: 'public', summary: `Get connector types`, + description: 'You do not need any Kibana feature privileges to run this API.', }, validate: { query: connectorTypesQuerySchemaV1, diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts index a18cf4c61ef2c2..b63a0e50dc671d 100644 --- a/x-pack/plugins/actions/server/routes/create.ts +++ b/x-pack/plugins/actions/server/routes/create.ts @@ -56,6 +56,8 @@ export const createActionRoute = ( options: { access: 'public', summary: 'Create a connector', + description: + 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { params: schema.maybe( diff --git a/x-pack/plugins/actions/server/routes/delete.ts b/x-pack/plugins/actions/server/routes/delete.ts index 950a3a8a60b172..ce09898ac47103 100644 --- a/x-pack/plugins/actions/server/routes/delete.ts +++ b/x-pack/plugins/actions/server/routes/delete.ts @@ -26,6 +26,8 @@ export const deleteActionRoute = ( options: { access: 'public', summary: `Delete a connector`, + description: + 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.', }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/create.ts b/x-pack/plugins/actions/server/routes/legacy/create.ts index d4a7da1420f7f0..6ac18063c7798d 100644 --- a/x-pack/plugins/actions/server/routes/legacy/create.ts +++ b/x-pack/plugins/actions/server/routes/legacy/create.ts @@ -32,6 +32,8 @@ export const createActionRoute = ( options: { access: 'public', summary: `Create a connector`, + description: + 'Deprecated in 7.13.0. Instead, use the create connector API with the `/api/actions/connector` path.', }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/delete.ts b/x-pack/plugins/actions/server/routes/legacy/delete.ts index 0639019f73278d..06053dbb669fdf 100644 --- a/x-pack/plugins/actions/server/routes/legacy/delete.ts +++ b/x-pack/plugins/actions/server/routes/legacy/delete.ts @@ -28,6 +28,8 @@ export const deleteActionRoute = ( options: { access: 'public', summary: `Delete a connector`, + description: + 'Deprecated in 7.13.0. Instead, use the delete connector API with the `api/actions/connector/` path. WARNING: When you delete a connector, it cannot be recovered.', }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/execute.ts b/x-pack/plugins/actions/server/routes/legacy/execute.ts index ecf036617a28a9..5b94c42f6306ae 100644 --- a/x-pack/plugins/actions/server/routes/legacy/execute.ts +++ b/x-pack/plugins/actions/server/routes/legacy/execute.ts @@ -34,6 +34,8 @@ export const executeActionRoute = ( options: { access: 'public', summary: `Run a connector`, + description: + 'Deprecated in 7.13.0. Instead, use the run connector API with the `api/actions/connector//_execute` path.', }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/get.ts b/x-pack/plugins/actions/server/routes/legacy/get.ts index 4c8d797205238b..d59c1cff72275c 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get.ts @@ -28,6 +28,8 @@ export const getActionRoute = ( options: { access: 'public', summary: `Get connector information`, + description: + 'Deprecated in 7.13.0. Instead, use the get connector API with the `api/actions/connector/` path.', }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/get_all.ts b/x-pack/plugins/actions/server/routes/legacy/get_all.ts index 2ecd570cb3e768..4355582a53f49e 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get_all.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get_all.ts @@ -23,6 +23,8 @@ export const getAllActionRoute = ( options: { access: 'public', summary: `Get all connectors`, + description: + 'Deprecated in 7.13.0. Instead, use the get all connectors API with the `api/actions/connectors` path.', }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts b/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts index fac078843e02dd..666b2d5a763a64 100644 --- a/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts +++ b/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts @@ -27,6 +27,8 @@ export const listActionTypesRoute = ( options: { access: 'public', summary: `Get connector types`, + description: + 'Deprecated in 7.13.0. Instead, use the get all connector types API with the `api/actions/connector_types` path.', }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/update.ts b/x-pack/plugins/actions/server/routes/legacy/update.ts index 59258434050e14..2a5d13bcdd1415 100644 --- a/x-pack/plugins/actions/server/routes/legacy/update.ts +++ b/x-pack/plugins/actions/server/routes/legacy/update.ts @@ -34,6 +34,8 @@ export const updateActionRoute = ( options: { access: 'public', summary: `Update a connector`, + description: + 'Deprecated in 7.13.0. Instead, use the update connector API with the `api/actions/connector/` path.', }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/update.ts b/x-pack/plugins/actions/server/routes/update.ts index 426deeb19aae31..9cb9885c492f5e 100644 --- a/x-pack/plugins/actions/server/routes/update.ts +++ b/x-pack/plugins/actions/server/routes/update.ts @@ -52,6 +52,8 @@ export const updateActionRoute = ( options: { access: 'public', summary: `Update a connector`, + description: + 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { body: bodySchema, From 91ebd87784c0c5720b88261af1366445f301f340 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 12 Jun 2024 19:07:31 -0700 Subject: [PATCH 02/10] Add parameter descriptions --- .../connector/apis/connector_types/schemas/v1.ts | 9 ++++++++- .../common/routes/connector/apis/get/schemas/v1.ts | 4 +++- .../actions/server/routes/connector/get/get.ts | 4 ++-- .../server/routes/connector/get_all/get_all.ts | 4 ++-- x-pack/plugins/actions/server/routes/create.ts | 14 ++++++++++---- x-pack/plugins/actions/server/routes/delete.ts | 8 +++++--- x-pack/plugins/actions/server/routes/execute.ts | 7 +++++-- .../plugins/actions/server/routes/legacy/create.ts | 8 ++++++-- .../plugins/actions/server/routes/legacy/delete.ts | 4 +++- .../actions/server/routes/legacy/execute.ts | 4 +++- x-pack/plugins/actions/server/routes/legacy/get.ts | 4 +++- .../plugins/actions/server/routes/legacy/update.ts | 4 +++- x-pack/plugins/actions/server/routes/update.ts | 13 +++++++++---- 13 files changed, 62 insertions(+), 25 deletions(-) diff --git a/x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts b/x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts index bdbc01efc4b7ac..035deaa4c023f3 100644 --- a/x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts +++ b/x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts @@ -8,5 +8,12 @@ import { schema } from '@kbn/config-schema'; export const connectorTypesQuerySchema = schema.object({ - feature_id: schema.maybe(schema.string()), + feature_id: schema.maybe( + schema.string({ + meta: { + description: + 'A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).', + }, + }) + ), }); diff --git a/x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts b/x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts index b999bb51c3d93c..c89b3ec7ce5873 100644 --- a/x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts +++ b/x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts @@ -8,5 +8,7 @@ import { schema } from '@kbn/config-schema'; export const getConnectorParamsSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); diff --git a/x-pack/plugins/actions/server/routes/connector/get/get.ts b/x-pack/plugins/actions/server/routes/connector/get/get.ts index 9f5b141eecf893..4abf857a7b750c 100644 --- a/x-pack/plugins/actions/server/routes/connector/get/get.ts +++ b/x-pack/plugins/actions/server/routes/connector/get/get.ts @@ -26,8 +26,8 @@ export const getConnectorRoute = ( options: { access: 'public', summary: `Get connector information`, - description: - 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', + // description: + // 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { params: getConnectorParamsSchemaV1, diff --git a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts index 03ee2b3731ff0f..8d80286c386024 100644 --- a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts +++ b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts @@ -23,8 +23,8 @@ export const getAllConnectorsRoute = ( options: { access: 'public', summary: `Get all connectors`, - description: - 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', + // description: + // 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts index b63a0e50dc671d..76c347db87c988 100644 --- a/x-pack/plugins/actions/server/routes/create.ts +++ b/x-pack/plugins/actions/server/routes/create.ts @@ -14,8 +14,14 @@ import { verifyAccessAndContext } from './verify_access_and_context'; import { CreateOptions } from '../actions_client'; export const bodySchema = schema.object({ - name: schema.string({ validate: validateEmptyStrings }), - connector_type_id: schema.string({ validate: validateEmptyStrings }), + name: schema.string({ + validate: validateEmptyStrings, + meta: { description: 'The display name for the connector.' }, + }), + connector_type_id: schema.string({ + validate: validateEmptyStrings, + meta: { description: 'The type of connector.' }, + }), config: schema.recordOf(schema.string(), schema.any({ validate: validateEmptyStrings }), { defaultValue: {}, }), @@ -56,8 +62,8 @@ export const createActionRoute = ( options: { access: 'public', summary: 'Create a connector', - description: - 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', + // description: + // 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { params: schema.maybe( diff --git a/x-pack/plugins/actions/server/routes/delete.ts b/x-pack/plugins/actions/server/routes/delete.ts index ce09898ac47103..620c73311b8625 100644 --- a/x-pack/plugins/actions/server/routes/delete.ts +++ b/x-pack/plugins/actions/server/routes/delete.ts @@ -13,7 +13,9 @@ import { ActionsRequestHandlerContext } from '../types'; import { verifyAccessAndContext } from './verify_access_and_context'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); export const deleteActionRoute = ( @@ -26,8 +28,8 @@ export const deleteActionRoute = ( options: { access: 'public', summary: `Delete a connector`, - description: - 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.', + description: 'WARNING: When you delete a connector, it cannot be recovered.', + // You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/execute.ts b/x-pack/plugins/actions/server/routes/execute.ts index 8b022e4d13f2c5..6bedc117f37b06 100644 --- a/x-pack/plugins/actions/server/routes/execute.ts +++ b/x-pack/plugins/actions/server/routes/execute.ts @@ -15,7 +15,9 @@ import { asHttpRequestExecutionSource } from '../lib/action_execution_source'; import { verifyAccessAndContext } from './verify_access_and_context'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); const bodySchema = schema.object({ @@ -43,7 +45,8 @@ export const executeActionRoute = ( access: 'public', summary: `Run a connector`, description: - 'You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.', + 'You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.', + // You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges. }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/create.ts b/x-pack/plugins/actions/server/routes/legacy/create.ts index 6ac18063c7798d..57efa1297331fb 100644 --- a/x-pack/plugins/actions/server/routes/legacy/create.ts +++ b/x-pack/plugins/actions/server/routes/legacy/create.ts @@ -15,8 +15,12 @@ import { verifyAccessAndContext } from '../verify_access_and_context'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; export const bodySchema = schema.object({ - name: schema.string(), - actionTypeId: schema.string(), + name: schema.string({ + meta: { description: 'The display name for the connector.' }, + }), + actionTypeId: schema.string({ + meta: { description: 'The connector type identifier.' }, + }), config: schema.recordOf(schema.string(), schema.any(), { defaultValue: {} }), secrets: schema.recordOf(schema.string(), schema.any(), { defaultValue: {} }), }); diff --git a/x-pack/plugins/actions/server/routes/legacy/delete.ts b/x-pack/plugins/actions/server/routes/legacy/delete.ts index 06053dbb669fdf..6d700f7854a50e 100644 --- a/x-pack/plugins/actions/server/routes/legacy/delete.ts +++ b/x-pack/plugins/actions/server/routes/legacy/delete.ts @@ -14,7 +14,9 @@ import { ActionsRequestHandlerContext } from '../../types'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); export const deleteActionRoute = ( diff --git a/x-pack/plugins/actions/server/routes/legacy/execute.ts b/x-pack/plugins/actions/server/routes/legacy/execute.ts index 5b94c42f6306ae..6edc967b9d5c9b 100644 --- a/x-pack/plugins/actions/server/routes/legacy/execute.ts +++ b/x-pack/plugins/actions/server/routes/legacy/execute.ts @@ -16,7 +16,9 @@ import { asHttpRequestExecutionSource } from '../../lib/action_execution_source' import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); const bodySchema = schema.object({ diff --git a/x-pack/plugins/actions/server/routes/legacy/get.ts b/x-pack/plugins/actions/server/routes/legacy/get.ts index d59c1cff72275c..c31376b196fe68 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get.ts @@ -14,7 +14,9 @@ import { ActionsRequestHandlerContext } from '../../types'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); export const getActionRoute = ( diff --git a/x-pack/plugins/actions/server/routes/legacy/update.ts b/x-pack/plugins/actions/server/routes/legacy/update.ts index 2a5d13bcdd1415..6a63a753eed37e 100644 --- a/x-pack/plugins/actions/server/routes/legacy/update.ts +++ b/x-pack/plugins/actions/server/routes/legacy/update.ts @@ -14,7 +14,9 @@ import { ActionsRequestHandlerContext } from '../../types'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); const bodySchema = schema.object({ diff --git a/x-pack/plugins/actions/server/routes/update.ts b/x-pack/plugins/actions/server/routes/update.ts index 9cb9885c492f5e..421a924fe5863f 100644 --- a/x-pack/plugins/actions/server/routes/update.ts +++ b/x-pack/plugins/actions/server/routes/update.ts @@ -13,11 +13,16 @@ import { ActionResult, ActionsRequestHandlerContext } from '../types'; import { verifyAccessAndContext } from './verify_access_and_context'; const paramSchema = schema.object({ - id: schema.string(), + id: schema.string({ + meta: { description: 'An identifier for the connector.' }, + }), }); export const bodySchema = schema.object({ - name: schema.string({ validate: validateEmptyStrings }), + name: schema.string({ + validate: validateEmptyStrings, + meta: { description: 'The display name for the connector.' }, + }), config: schema.recordOf(schema.string(), schema.any({ validate: validateEmptyStrings }), { defaultValue: {}, }), @@ -52,8 +57,8 @@ export const updateActionRoute = ( options: { access: 'public', summary: `Update a connector`, - description: - 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', + // description: + // 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, validate: { body: bodySchema, From 3bf66cbf71c2e720970b8481199b0f1714ad109a Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 23 Jul 2024 18:31:18 -0700 Subject: [PATCH 03/10] Add oas-tag and deprecated properties --- x-pack/plugins/actions/server/routes/connector/get/get.ts | 1 + .../actions/server/routes/connector/get_all/get_all.ts | 1 + .../actions/server/routes/connector/list_types/list_types.ts | 1 + x-pack/plugins/actions/server/routes/create.ts | 1 + x-pack/plugins/actions/server/routes/delete.ts | 1 + x-pack/plugins/actions/server/routes/execute.ts | 1 + x-pack/plugins/actions/server/routes/legacy/create.ts | 4 ++-- x-pack/plugins/actions/server/routes/legacy/delete.ts | 4 ++-- x-pack/plugins/actions/server/routes/legacy/execute.ts | 4 ++-- x-pack/plugins/actions/server/routes/legacy/get.ts | 4 ++-- x-pack/plugins/actions/server/routes/legacy/get_all.ts | 4 ++-- .../plugins/actions/server/routes/legacy/list_action_types.ts | 4 ++-- x-pack/plugins/actions/server/routes/legacy/update.ts | 4 ++-- x-pack/plugins/actions/server/routes/update.ts | 1 + 14 files changed, 21 insertions(+), 14 deletions(-) diff --git a/x-pack/plugins/actions/server/routes/connector/get/get.ts b/x-pack/plugins/actions/server/routes/connector/get/get.ts index 4abf857a7b750c..29d917702af4f1 100644 --- a/x-pack/plugins/actions/server/routes/connector/get/get.ts +++ b/x-pack/plugins/actions/server/routes/connector/get/get.ts @@ -26,6 +26,7 @@ export const getConnectorRoute = ( options: { access: 'public', summary: `Get connector information`, + tags: ['oas-tag:connectors'], // description: // 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, diff --git a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts index 8d80286c386024..27f43a75eb1519 100644 --- a/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts +++ b/x-pack/plugins/actions/server/routes/connector/get_all/get_all.ts @@ -23,6 +23,7 @@ export const getAllConnectorsRoute = ( options: { access: 'public', summary: `Get all connectors`, + tags: ['oas-tag:connectors'], // description: // 'You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, diff --git a/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts b/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts index d4446e9a840d3c..20ca0d9343608a 100644 --- a/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts +++ b/x-pack/plugins/actions/server/routes/connector/list_types/list_types.ts @@ -28,6 +28,7 @@ export const listTypesRoute = ( access: 'public', summary: `Get connector types`, description: 'You do not need any Kibana feature privileges to run this API.', + tags: ['oas-tag:connectors'], }, validate: { query: connectorTypesQuerySchemaV1, diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts index 76c347db87c988..2803c5d31d6033 100644 --- a/x-pack/plugins/actions/server/routes/create.ts +++ b/x-pack/plugins/actions/server/routes/create.ts @@ -62,6 +62,7 @@ export const createActionRoute = ( options: { access: 'public', summary: 'Create a connector', + tags: ['oas-tag:connectors'], // description: // 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, diff --git a/x-pack/plugins/actions/server/routes/delete.ts b/x-pack/plugins/actions/server/routes/delete.ts index 620c73311b8625..8e2dd21952ab6e 100644 --- a/x-pack/plugins/actions/server/routes/delete.ts +++ b/x-pack/plugins/actions/server/routes/delete.ts @@ -30,6 +30,7 @@ export const deleteActionRoute = ( summary: `Delete a connector`, description: 'WARNING: When you delete a connector, it cannot be recovered.', // You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. + tags: ['oas-tag:connectors'], }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/execute.ts b/x-pack/plugins/actions/server/routes/execute.ts index 6bedc117f37b06..83b6e72652b063 100644 --- a/x-pack/plugins/actions/server/routes/execute.ts +++ b/x-pack/plugins/actions/server/routes/execute.ts @@ -47,6 +47,7 @@ export const executeActionRoute = ( description: 'You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems.', // You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges. + tags: ['oas-tag:connectors'], }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/create.ts b/x-pack/plugins/actions/server/routes/legacy/create.ts index 57efa1297331fb..3fd8c77759122b 100644 --- a/x-pack/plugins/actions/server/routes/legacy/create.ts +++ b/x-pack/plugins/actions/server/routes/legacy/create.ts @@ -36,8 +36,8 @@ export const createActionRoute = ( options: { access: 'public', summary: `Create a connector`, - description: - 'Deprecated in 7.13.0. Instead, use the create connector API with the `/api/actions/connector` path.', + tags: ['oas-tag:connectors'], + deprecated: true, }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/delete.ts b/x-pack/plugins/actions/server/routes/legacy/delete.ts index 6d700f7854a50e..f5d1ed71001f2e 100644 --- a/x-pack/plugins/actions/server/routes/legacy/delete.ts +++ b/x-pack/plugins/actions/server/routes/legacy/delete.ts @@ -30,8 +30,8 @@ export const deleteActionRoute = ( options: { access: 'public', summary: `Delete a connector`, - description: - 'Deprecated in 7.13.0. Instead, use the delete connector API with the `api/actions/connector/` path. WARNING: When you delete a connector, it cannot be recovered.', + description: 'WARNING: When you delete a connector, it cannot be recovered.', + tags: ['oas-tag:connectors'], }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/execute.ts b/x-pack/plugins/actions/server/routes/legacy/execute.ts index 6edc967b9d5c9b..abe8971baf1cf8 100644 --- a/x-pack/plugins/actions/server/routes/legacy/execute.ts +++ b/x-pack/plugins/actions/server/routes/legacy/execute.ts @@ -36,8 +36,8 @@ export const executeActionRoute = ( options: { access: 'public', summary: `Run a connector`, - description: - 'Deprecated in 7.13.0. Instead, use the run connector API with the `api/actions/connector//_execute` path.', + deprecated: true, + tags: ['oas-tag:connectors'], }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/get.ts b/x-pack/plugins/actions/server/routes/legacy/get.ts index c31376b196fe68..e95c88fca7c45f 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get.ts @@ -30,8 +30,8 @@ export const getActionRoute = ( options: { access: 'public', summary: `Get connector information`, - description: - 'Deprecated in 7.13.0. Instead, use the get connector API with the `api/actions/connector/` path.', + deprecated: true, + tags: ['oas-tag:connectors'], }, validate: { params: paramSchema, diff --git a/x-pack/plugins/actions/server/routes/legacy/get_all.ts b/x-pack/plugins/actions/server/routes/legacy/get_all.ts index 4355582a53f49e..04ba20f4fb3c8a 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get_all.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get_all.ts @@ -23,8 +23,8 @@ export const getAllActionRoute = ( options: { access: 'public', summary: `Get all connectors`, - description: - 'Deprecated in 7.13.0. Instead, use the get all connectors API with the `api/actions/connectors` path.', + deprecated: true, + tags: ['oas-tag:connectors'], }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts b/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts index 666b2d5a763a64..f42cd7479286c3 100644 --- a/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts +++ b/x-pack/plugins/actions/server/routes/legacy/list_action_types.ts @@ -27,8 +27,8 @@ export const listActionTypesRoute = ( options: { access: 'public', summary: `Get connector types`, - description: - 'Deprecated in 7.13.0. Instead, use the get all connector types API with the `api/actions/connector_types` path.', + deprecated: true, + tags: ['oas-tag:connectors'], }, validate: {}, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/update.ts b/x-pack/plugins/actions/server/routes/legacy/update.ts index 6a63a753eed37e..f07682706fc19a 100644 --- a/x-pack/plugins/actions/server/routes/legacy/update.ts +++ b/x-pack/plugins/actions/server/routes/legacy/update.ts @@ -36,8 +36,8 @@ export const updateActionRoute = ( options: { access: 'public', summary: `Update a connector`, - description: - 'Deprecated in 7.13.0. Instead, use the update connector API with the `api/actions/connector/` path.', + deprecated: true, + tags: ['oas-tag:connectors'], }, validate: { body: bodySchema, diff --git a/x-pack/plugins/actions/server/routes/update.ts b/x-pack/plugins/actions/server/routes/update.ts index 421a924fe5863f..0077c1632877b0 100644 --- a/x-pack/plugins/actions/server/routes/update.ts +++ b/x-pack/plugins/actions/server/routes/update.ts @@ -57,6 +57,7 @@ export const updateActionRoute = ( options: { access: 'public', summary: `Update a connector`, + tags: ['oas-tag:connectors'], // description: // 'You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.', }, From 6433718e76c86ceada2fbda5eba8d4faedf13fbf Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 23 Jul 2024 18:49:31 -0700 Subject: [PATCH 04/10] Add elastic-api-version header to connector APIs --- x-pack/plugins/actions/docs/openapi/README.md | 17 ++--------------- .../openapi/paths/api@actions@connector.yaml | 1 + .../api@actions@connector@{connectorid}.yaml | 4 ++++ .../openapi/paths/api@actions@connectors.yaml | 2 ++ ...s@{spaceid}@api@actions@connector_types.yaml | 1 + 5 files changed, 10 insertions(+), 15 deletions(-) diff --git a/x-pack/plugins/actions/docs/openapi/README.md b/x-pack/plugins/actions/docs/openapi/README.md index 210bb719eb918d..723cefb19ed4f5 100644 --- a/x-pack/plugins/actions/docs/openapi/README.md +++ b/x-pack/plugins/actions/docs/openapi/README.md @@ -13,15 +13,7 @@ A guide about the openApi specification can be found at [https://swagger.io/docs ## Tools -It is possible to validate the docs before bundling them with the following -command in the `x-pack/plugins/actions/docs/openapi/` folder: - -``` -npx swagger-cli validate entrypoint.yaml -npx swagger-cli validate entrypoint_serverless.yaml -``` - -Then you can generate the `bundled` files by running the following commands: +You can generate the `bundled` files by running the following commands: ``` npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml @@ -30,9 +22,4 @@ npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.y npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json ``` -You can run additional linting with the following command: - -``` -npx @redocly/cli lint bundled.json -npx @redocly/cli lint bundled_serverless.json -``` +Then join these files with the rest of the Kibana APIs per `oas_docs/README.md` diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml index 5f82202bed5345..6a60da258c4bfe 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml @@ -4,6 +4,7 @@ post: tags: - connectors parameters: + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' requestBody: required: true diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml index c9b4c269e6cc25..733a1f26767e86 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml @@ -4,6 +4,7 @@ get: tags: - connectors parameters: + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/connector_id.yaml' responses: '200': @@ -27,6 +28,7 @@ delete: - connectors parameters: - $ref: '../components/headers/kbn_xsrf.yaml' + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/connector_id.yaml' responses: '204': @@ -42,6 +44,7 @@ post: tags: - connectors parameters: + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' - in: path name: connectorId @@ -80,6 +83,7 @@ put: tags: - connectors parameters: + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' - $ref: '../components/parameters/connector_id.yaml' requestBody: diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml index b94954173e22e9..787a8cac00b89e 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml @@ -3,6 +3,8 @@ get: operationId: getConnectors tags: - connectors + parameters: + - $ref: '../components/headers/elastic_api_version.yaml' responses: '200': description: Indicates a successful call. diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml index 88fbc1612e5078..b44756f12c42f6 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml @@ -6,6 +6,7 @@ get: tags: - connectors parameters: + - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/space_id.yaml' - in: query name: feature_id From 3685978118be31637a54425ff08474097c9b533c Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 23 Jul 2024 18:53:28 -0700 Subject: [PATCH 05/10] Regenerate output --- oas_docs/output/kibana.serverless.yaml | 27 +++++++++++-- oas_docs/output/kibana.yaml | 30 +++++++++++++-- .../plugins/actions/docs/openapi/bundled.json | 38 ++++++++++++++++++- .../plugins/actions/docs/openapi/bundled.yaml | 26 +++++++++++-- .../docs/openapi/bundled_serverless.json | 35 ++++++++++++++++- .../docs/openapi/bundled_serverless.yaml | 23 +++++++++-- .../headers/elastic_api_version.yaml | 9 +++++ 7 files changed, 172 insertions(+), 16 deletions(-) create mode 100644 x-pack/plugins/actions/docs/openapi/components/headers/elastic_api_version.yaml diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 7d0f39d390a9e1..3b1e48a85b4c06 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -278,6 +278,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' requestBody: required: true @@ -329,6 +330,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '200': @@ -353,6 +355,7 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '204': @@ -369,6 +372,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - in: path name: connectorId @@ -410,6 +414,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_connector_id' requestBody: @@ -443,6 +448,8 @@ paths: operationId: getConnectors tags: - connectors + parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' responses: '200': description: Indicates a successful call. @@ -2598,6 +2605,7 @@ paths: description: >- Kibana's operational status. A minimal response is sent for unauthorized users. + description: Overall status is OK and Kibana should be functioning normally. '503': content: application/json; Elastic-Api-Version=2023-10-31: @@ -2609,6 +2617,9 @@ paths: description: >- Kibana's operational status. A minimal response is sent for unauthorized users. + description: >- + Kibana or some of it's essential services are unavailable. Kibana + may be degraded or unavailable. summary: Get Kibana's current status tags: - system @@ -2663,6 +2674,16 @@ components: scheme: basic type: http parameters: + Connectors_elastic_api_version: + schema: + type: string + enum: + - '2023-10-31' + default: '2023-10-31' + in: header + name: elastic-api-version + description: In Elastic Serverless, indicates the version of the API to use. + required: true Connectors_kbn_xsrf: schema: type: string @@ -3683,7 +3704,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3693,7 +3714,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5361,7 +5382,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 4a31feb6602d2e..49135b8cedddb7 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -492,6 +492,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_space_id' - in: query name: feature_id @@ -663,6 +664,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' requestBody: required: true @@ -715,6 +717,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '200': @@ -740,6 +743,7 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '204': @@ -757,6 +761,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - in: path name: connectorId @@ -799,6 +804,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_connector_id' requestBody: @@ -941,6 +947,8 @@ paths: operationId: getConnectors tags: - connectors + parameters: + - $ref: '#/components/parameters/Connectors_elastic_api_version' responses: '200': description: Indicates a successful call. @@ -4073,6 +4081,7 @@ paths: description: >- Kibana's operational status. A minimal response is sent for unauthorized users. + description: Overall status is OK and Kibana should be functioning normally. '503': content: application/json; Elastic-Api-Version=2023-10-31: @@ -4084,6 +4093,9 @@ paths: description: >- Kibana's operational status. A minimal response is sent for unauthorized users. + description: >- + Kibana or some of it's essential services are unavailable. Kibana + may be degraded or unavailable. summary: Get Kibana's current status tags: - system @@ -4166,6 +4178,16 @@ components: schema: type: string example: df770e30-8b8b-11ed-a780-3b746c987a81 + Connectors_elastic_api_version: + schema: + type: string + enum: + - '2023-10-31' + default: '2023-10-31' + in: header + name: elastic-api-version + description: In Elastic Serverless, indicates the version of the API to use. + required: true Connectors_action_id: in: path name: actionId @@ -5161,7 +5183,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -5171,7 +5193,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -6839,7 +6861,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean @@ -7390,7 +7412,7 @@ components: type: string description: > A list of "carbon copy" email addresses. Addresses can be specified - in `user@host-name` format or in name `` format + in `user@host-name` format or in name `` format message: type: string description: The email message text. Markdown format is supported. diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index ee6cb7080627e2..f236b6f6140859 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -337,6 +337,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/space_id" }, @@ -552,6 +555,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" } @@ -619,6 +625,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/connector_id" } @@ -657,6 +666,9 @@ { "$ref": "#/components/parameters/kbn_xsrf" }, + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/connector_id" } @@ -680,6 +692,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -737,6 +752,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -924,6 +942,11 @@ "tags": [ "connectors" ], + "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + } + ], "responses": { "200": { "description": "Indicates a successful call.", @@ -1426,6 +1449,19 @@ "example": "df770e30-8b8b-11ed-a780-3b746c987a81" } }, + "elastic_api_version": { + "schema": { + "type": "string", + "enum": [ + "2023-10-31" + ], + "default": "2023-10-31" + }, + "in": "header", + "name": "elastic-api-version", + "description": "In Elastic Serverless, indicates the version of the API to use.", + "required": true + }, "action_id": { "in": "path", "name": "actionId", @@ -7150,4 +7186,4 @@ } } } -} +} \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml index fada89d5c6ea45..d4f84f868d6919 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -208,6 +208,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/space_id' - in: query name: feature_id @@ -348,6 +349,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true @@ -389,6 +391,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '200': @@ -411,6 +414,7 @@ paths: - connectors parameters: - $ref: '#/components/parameters/kbn_xsrf' + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '204': @@ -425,6 +429,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - in: path name: connectorId @@ -461,6 +466,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/connector_id' requestBody: @@ -577,6 +583,8 @@ paths: operationId: getConnectors tags: - connectors + parameters: + - $ref: '#/components/parameters/elastic_api_version' responses: '200': description: Indicates a successful call. @@ -905,6 +913,16 @@ components: schema: type: string example: df770e30-8b8b-11ed-a780-3b746c987a81 + elastic_api_version: + schema: + type: string + enum: + - '2023-10-31' + default: '2023-10-31' + in: header + name: elastic-api-version + description: In Elastic Serverless, indicates the version of the API to use. + required: true action_id: in: path name: actionId @@ -1696,14 +1714,14 @@ components: type: boolean host: description: | - The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string nullable: true port: description: | - The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: integer secure: description: | @@ -3267,7 +3285,7 @@ components: is_preconfigured: type: boolean description: | - Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. + Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. example: false is_system_action: type: boolean @@ -3775,7 +3793,7 @@ components: items: type: string description: | - A list of "carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format + A list of "carbon copy" email addresses. Addresses can be specified in `user@host-name` format or in name `` format message: type: string description: The email message text. Markdown format is supported. diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json index 550eba1f9ae606..1f4f13de7c325e 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json @@ -42,6 +42,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" } @@ -109,6 +112,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/connector_id" } @@ -147,6 +153,9 @@ { "$ref": "#/components/parameters/kbn_xsrf" }, + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/connector_id" } @@ -170,6 +179,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -227,6 +239,9 @@ "connectors" ], "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -279,6 +294,11 @@ "tags": [ "connectors" ], + "parameters": [ + { + "$ref": "#/components/parameters/elastic_api_version" + } + ], "responses": { "200": { "description": "Indicates a successful call.", @@ -405,6 +425,19 @@ } }, "parameters": { + "elastic_api_version": { + "schema": { + "type": "string", + "enum": [ + "2023-10-31" + ], + "default": "2023-10-31" + }, + "in": "header", + "name": "elastic-api-version", + "description": "In Elastic Serverless, indicates the version of the API to use.", + "required": true + }, "kbn_xsrf": { "schema": { "type": "string" @@ -4537,4 +4570,4 @@ } } } -} +} \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml index 0fe3a61372ce62..0432a15fb75614 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml @@ -26,6 +26,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true @@ -67,6 +68,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '200': @@ -89,6 +91,7 @@ paths: - connectors parameters: - $ref: '#/components/parameters/kbn_xsrf' + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '204': @@ -103,6 +106,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - in: path name: connectorId @@ -139,6 +143,7 @@ paths: tags: - connectors parameters: + - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/connector_id' requestBody: @@ -169,6 +174,8 @@ paths: operationId: getConnectors tags: - connectors + parameters: + - $ref: '#/components/parameters/elastic_api_version' responses: '200': description: Indicates a successful call. @@ -255,6 +262,16 @@ components: description: | Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'. parameters: + elastic_api_version: + schema: + type: string + enum: + - '2023-10-31' + default: '2023-10-31' + in: header + name: elastic-api-version + description: In Elastic Serverless, indicates the version of the API to use. + required: true kbn_xsrf: schema: type: string @@ -1053,14 +1070,14 @@ components: type: boolean host: description: | - The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string nullable: true port: description: | - The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: integer secure: description: | @@ -2624,7 +2641,7 @@ components: is_preconfigured: type: boolean description: | - Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. + Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. example: false is_system_action: type: boolean diff --git a/x-pack/plugins/actions/docs/openapi/components/headers/elastic_api_version.yaml b/x-pack/plugins/actions/docs/openapi/components/headers/elastic_api_version.yaml new file mode 100644 index 00000000000000..fd63ff9fbd740e --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/components/headers/elastic_api_version.yaml @@ -0,0 +1,9 @@ +schema: + type: string + enum: + - 2023-10-31 + default: 2023-10-31 +in: header +name: elastic-api-version +description: In Elastic Serverless, indicates the version of the API to use. +required: true From 817d312836de444d638ef9ea6f411b6e57e925e2 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 24 Jul 2024 14:17:34 -0700 Subject: [PATCH 06/10] Comment out elastic-api-version header --- oas_docs/output/kibana.serverless.yaml | 17 --------- oas_docs/output/kibana.yaml | 18 ---------- .../plugins/actions/docs/openapi/bundled.json | 36 ------------------- .../plugins/actions/docs/openapi/bundled.yaml | 18 ---------- .../docs/openapi/bundled_serverless.json | 33 ----------------- .../docs/openapi/bundled_serverless.yaml | 17 --------- .../openapi/paths/api@actions@connector.yaml | 2 +- .../api@actions@connector@{connectorid}.yaml | 8 ++--- .../openapi/paths/api@actions@connectors.yaml | 4 +-- ...{spaceid}@api@actions@connector_types.yaml | 2 +- 10 files changed, 8 insertions(+), 147 deletions(-) diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 3b1e48a85b4c06..87a49cbc27d5fc 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -278,7 +278,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' requestBody: required: true @@ -330,7 +329,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '200': @@ -355,7 +353,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '204': @@ -372,7 +369,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - in: path name: connectorId @@ -414,7 +410,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_connector_id' requestBody: @@ -448,8 +443,6 @@ paths: operationId: getConnectors tags: - connectors - parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' responses: '200': description: Indicates a successful call. @@ -2674,16 +2667,6 @@ components: scheme: basic type: http parameters: - Connectors_elastic_api_version: - schema: - type: string - enum: - - '2023-10-31' - default: '2023-10-31' - in: header - name: elastic-api-version - description: In Elastic Serverless, indicates the version of the API to use. - required: true Connectors_kbn_xsrf: schema: type: string diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 49135b8cedddb7..3d86f75dfec96b 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -492,7 +492,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_space_id' - in: query name: feature_id @@ -664,7 +663,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' requestBody: required: true @@ -717,7 +715,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '200': @@ -743,7 +740,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_connector_id' responses: '204': @@ -761,7 +757,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - in: path name: connectorId @@ -804,7 +799,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_connector_id' requestBody: @@ -947,8 +941,6 @@ paths: operationId: getConnectors tags: - connectors - parameters: - - $ref: '#/components/parameters/Connectors_elastic_api_version' responses: '200': description: Indicates a successful call. @@ -4178,16 +4170,6 @@ components: schema: type: string example: df770e30-8b8b-11ed-a780-3b746c987a81 - Connectors_elastic_api_version: - schema: - type: string - enum: - - '2023-10-31' - default: '2023-10-31' - in: header - name: elastic-api-version - description: In Elastic Serverless, indicates the version of the API to use. - required: true Connectors_action_id: in: path name: actionId diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index f236b6f6140859..a66b4db4408288 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -337,9 +337,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/space_id" }, @@ -555,9 +552,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" } @@ -625,9 +619,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/connector_id" } @@ -666,9 +657,6 @@ { "$ref": "#/components/parameters/kbn_xsrf" }, - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/connector_id" } @@ -692,9 +680,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -752,9 +737,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -942,11 +924,6 @@ "tags": [ "connectors" ], - "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - } - ], "responses": { "200": { "description": "Indicates a successful call.", @@ -1449,19 +1426,6 @@ "example": "df770e30-8b8b-11ed-a780-3b746c987a81" } }, - "elastic_api_version": { - "schema": { - "type": "string", - "enum": [ - "2023-10-31" - ], - "default": "2023-10-31" - }, - "in": "header", - "name": "elastic-api-version", - "description": "In Elastic Serverless, indicates the version of the API to use.", - "required": true - }, "action_id": { "in": "path", "name": "actionId", diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml index d4f84f868d6919..96aa4a32118e28 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -208,7 +208,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/space_id' - in: query name: feature_id @@ -349,7 +348,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true @@ -391,7 +389,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '200': @@ -414,7 +411,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '204': @@ -429,7 +425,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - in: path name: connectorId @@ -466,7 +461,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/connector_id' requestBody: @@ -583,8 +577,6 @@ paths: operationId: getConnectors tags: - connectors - parameters: - - $ref: '#/components/parameters/elastic_api_version' responses: '200': description: Indicates a successful call. @@ -913,16 +905,6 @@ components: schema: type: string example: df770e30-8b8b-11ed-a780-3b746c987a81 - elastic_api_version: - schema: - type: string - enum: - - '2023-10-31' - default: '2023-10-31' - in: header - name: elastic-api-version - description: In Elastic Serverless, indicates the version of the API to use. - required: true action_id: in: path name: actionId diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json index 1f4f13de7c325e..73f0af448f5dea 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json @@ -42,9 +42,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" } @@ -112,9 +109,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/connector_id" } @@ -153,9 +147,6 @@ { "$ref": "#/components/parameters/kbn_xsrf" }, - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/connector_id" } @@ -179,9 +170,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -239,9 +227,6 @@ "connectors" ], "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - }, { "$ref": "#/components/parameters/kbn_xsrf" }, @@ -294,11 +279,6 @@ "tags": [ "connectors" ], - "parameters": [ - { - "$ref": "#/components/parameters/elastic_api_version" - } - ], "responses": { "200": { "description": "Indicates a successful call.", @@ -425,19 +405,6 @@ } }, "parameters": { - "elastic_api_version": { - "schema": { - "type": "string", - "enum": [ - "2023-10-31" - ], - "default": "2023-10-31" - }, - "in": "header", - "name": "elastic-api-version", - "description": "In Elastic Serverless, indicates the version of the API to use.", - "required": true - }, "kbn_xsrf": { "schema": { "type": "string" diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml index 0432a15fb75614..a59511d9137a6b 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml @@ -26,7 +26,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' requestBody: required: true @@ -68,7 +67,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '200': @@ -91,7 +89,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/connector_id' responses: '204': @@ -106,7 +103,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - in: path name: connectorId @@ -143,7 +139,6 @@ paths: tags: - connectors parameters: - - $ref: '#/components/parameters/elastic_api_version' - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/connector_id' requestBody: @@ -174,8 +169,6 @@ paths: operationId: getConnectors tags: - connectors - parameters: - - $ref: '#/components/parameters/elastic_api_version' responses: '200': description: Indicates a successful call. @@ -262,16 +255,6 @@ components: description: | Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'. parameters: - elastic_api_version: - schema: - type: string - enum: - - '2023-10-31' - default: '2023-10-31' - in: header - name: elastic-api-version - description: In Elastic Serverless, indicates the version of the API to use. - required: true kbn_xsrf: schema: type: string diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml index 6a60da258c4bfe..bdd55d4fa9c05b 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml @@ -4,7 +4,7 @@ post: tags: - connectors parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' requestBody: required: true diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml index 733a1f26767e86..4c4495ddc8f3c6 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector@{connectorid}.yaml @@ -4,7 +4,7 @@ get: tags: - connectors parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/connector_id.yaml' responses: '200': @@ -28,7 +28,7 @@ delete: - connectors parameters: - $ref: '../components/headers/kbn_xsrf.yaml' - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/connector_id.yaml' responses: '204': @@ -44,7 +44,7 @@ post: tags: - connectors parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' - in: path name: connectorId @@ -83,7 +83,7 @@ put: tags: - connectors parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/headers/kbn_xsrf.yaml' - $ref: '../components/parameters/connector_id.yaml' requestBody: diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml index 787a8cac00b89e..198ef57f3e1ff8 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connectors.yaml @@ -3,8 +3,8 @@ get: operationId: getConnectors tags: - connectors - parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # parameters: + # - $ref: '../components/headers/elastic_api_version.yaml' responses: '200': description: Indicates a successful call. diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml index b44756f12c42f6..b615b29979d1c7 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml @@ -6,7 +6,7 @@ get: tags: - connectors parameters: - - $ref: '../components/headers/elastic_api_version.yaml' + # - $ref: '../components/headers/elastic_api_version.yaml' - $ref: '../components/parameters/space_id.yaml' - in: query name: feature_id From 1d383d6f6ecfdbfc994ef73b3a3c2263291c72fb Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 24 Jul 2024 14:24:48 -0700 Subject: [PATCH 07/10] Remove non-default space paths --- .../actions/docs/openapi/entrypoint.yaml | 63 ++++++++++-------- .../docs/openapi/entrypoint_serverless.yaml | 24 +++---- .../docs/openapi/paths/api@actions.yaml | 56 ++++++++++++++++ .../paths/api@actions@action@{actionid}.yaml | 66 +++++++++++++++++++ ...pi@actions@action@{actionid}@_execute.yaml | 48 ++++++++++++++ .../paths/api@actions@list_action_types.yaml | 40 +++++++++++ 6 files changed, 258 insertions(+), 39 deletions(-) create mode 100644 x-pack/plugins/actions/docs/openapi/paths/api@actions.yaml create mode 100644 x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}.yaml create mode 100644 x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml create mode 100644 x-pack/plugins/actions/docs/openapi/paths/api@actions@list_action_types.yaml diff --git a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml index ba61b00c3c7379..e75de58ae337b5 100644 --- a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml +++ b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml @@ -14,16 +14,6 @@ tags: servers: - url: / paths: - '/s/{spaceId}/api/actions/connector': - $ref: 'paths/s@{spaceid}@api@actions@connector.yaml' - '/s/{spaceId}/api/actions/connector/{connectorId}': - $ref: 'paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml' - '/s/{spaceId}/api/actions/connectors': - $ref: paths/s@{spaceid}@api@actions@connectors.yaml - '/s/{spaceId}/api/actions/connector_types': - $ref: paths/s@{spaceid}@api@actions@connector_types.yaml - '/s/{spaceId}/api/actions/connector/{connectorId}/_execute': - $ref: paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml # Default space '/api/actions/connector': $ref: 'paths/api@actions@connector.yaml' @@ -36,24 +26,43 @@ paths: '/api/actions/connector_types': $ref: paths/api@actions@connector_types.yaml # Deprecated endpoints: - '/s/{spaceId}/api/actions/action/{actionId}': + '/api/actions/action/{actionId}': $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml' - '/s/{spaceId}/api/actions': + '/api/actions': $ref: 'paths/s@{spaceid}@api@actions.yaml' - '/s/{spaceId}/api/actions/list_action_types': + '/api/actions/list_action_types': $ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml' - '/s/{spaceId}/api/actions/action/{actionId}/_execute': + '/api/actions/action/{actionId}/_execute': $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml' -components: - securitySchemes: - basicAuth: - type: http - scheme: basic - apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' -security: - - basicAuth: [] - - apiKeyAuth: [] +# Non-default space + # '/s/{spaceId}/api/actions/connector': + # $ref: 'paths/s@{spaceid}@api@actions@connector.yaml' + # '/s/{spaceId}/api/actions/connector/{connectorId}': + # $ref: 'paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml' + # '/s/{spaceId}/api/actions/connectors': + # $ref: paths/s@{spaceid}@api@actions@connectors.yaml + # '/s/{spaceId}/api/actions/connector_types': + # $ref: paths/s@{spaceid}@api@actions@connector_types.yaml + # '/s/{spaceId}/api/actions/connector/{connectorId}/_execute': + # $ref: paths/s@{spaceid}@api@actions@connector@{connectorid}@_execute.yaml + # '/s/{spaceId}/api/actions/action/{actionId}': + # $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml' + # '/s/{spaceId}/api/actions': + # $ref: 'paths/s@{spaceid}@api@actions.yaml' + # '/s/{spaceId}/api/actions/list_action_types': + # $ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml' + # '/s/{spaceId}/api/actions/action/{actionId}/_execute': + # $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml' +# components: +# securitySchemes: +# basicAuth: +# type: http +# scheme: basic +# apiKeyAuth: +# type: apiKey +# in: header +# name: Authorization +# description: 'e.g. Authorization: ApiKey base64AccessApiKey' +# security: +# - basicAuth: [] +# - apiKeyAuth: [] diff --git a/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml b/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml index 60cca6f18bc440..89ffffe8a672e2 100644 --- a/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml +++ b/x-pack/plugins/actions/docs/openapi/entrypoint_serverless.yaml @@ -25,15 +25,15 @@ paths: $ref: paths/api@actions@connectors.yaml '/api/actions/connector_types': $ref: paths/api@actions@connector_types.yaml -components: - securitySchemes: - apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. - You must create an API key and use the encoded value in the request header. - For example: 'Authorization: ApiKey base64AccessApiKey'. -security: - - apiKeyAuth: [] +# components: +# securitySchemes: +# apiKeyAuth: +# type: apiKey +# in: header +# name: Authorization +# description: > +# Serverless APIs support only key-based authentication. +# You must create an API key and use the encoded value in the request header. +# For example: 'Authorization: ApiKey base64AccessApiKey'. +# security: +# - apiKeyAuth: [] diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions.yaml new file mode 100644 index 00000000000000..bd9204fd9a1750 --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions.yaml @@ -0,0 +1,56 @@ +get: + summary: Get all connectors + operationId: legacyGetConnectors + deprecated: true + description: Deprecated in 7.13.0. Use the get all connectors API instead. + tags: + - connectors + responses: + '200': + description: Indicates a successful call. + content: + application/json: + schema: + type: array + items: + $ref: '../components/schemas/action_response_properties.yaml' + '401': + $ref: '../components/responses/401.yaml' + +post: + summary: Create a connector + operationId: legacyCreateConnector + deprecated: true + description: Deprecated in 7.13.0. Use the create connector API instead. + tags: + - connectors + parameters: + - $ref: '../components/headers/kbn_xsrf.yaml' + requestBody: + required: true + content: + application/json: + schema: + title: Legacy create connector request properties + type: object + properties: + actionTypeId: + type: string + description: The connector type identifier. + config: + type: object + description: The configuration for the connector. Configuration properties vary depending on the connector type. + name: + type: string + description: The display name for the connector. + secrets: + type: object + description: > + The secrets configuration for the connector. + Secrets configuration properties vary depending on the connector type. + NOTE: Remember these values. You must provide them each time you update the connector. + responses: + '200': + $ref: '../components/responses/200_actions.yaml' + '401': + $ref: '../components/responses/401.yaml' \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}.yaml new file mode 100644 index 00000000000000..60c6364edd02ef --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}.yaml @@ -0,0 +1,66 @@ +delete: + summary: Delete a connector + operationId: legacyDeleteConnector + deprecated: true + description: > + Deprecated in 7.13.0. Use the delete connector API instead. + WARNING: When you delete a connector, it cannot be recovered. + tags: + - connectors + parameters: + - $ref: '../components/headers/kbn_xsrf.yaml' + - $ref: '../components/parameters/action_id.yaml' + responses: + '204': + description: Indicates a successful call. + '401': + $ref: '../components/responses/401.yaml' + +get: + summary: Get connector information + operationId: legacyGetConnector + description: Deprecated in 7.13.0. Use the get connector API instead. + deprecated: true + tags: + - connectors + parameters: + - $ref: '../components/parameters/action_id.yaml' + responses: + '200': + $ref: '../components/responses/200_actions.yaml' + '401': + $ref: '../components/responses/401.yaml' + +put: + summary: Update a connector + operationId: legacyUpdateConnector + deprecated: true + description: Deprecated in 7.13.0. Use the update connector API instead. + tags: + - connectors + parameters: + - $ref: '../components/headers/kbn_xsrf.yaml' + - $ref: '../components/parameters/action_id.yaml' + requestBody: + required: true + content: + application/json: + schema: + title: Legacy update connector request body properties + description: The properties vary depending on the connector type. + type: object + properties: + config: + type: object + description: The new connector configuration. Configuration properties vary depending on the connector type. + name: + type: string + description: The new name for the connector. + secrets: + type: object + description: The updated secrets configuration for the connector. Secrets properties vary depending on the connector type. + responses: + '200': + $ref: '../components/responses/200_actions.yaml' + '404': + $ref: '../components/responses/404.yaml' diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml new file mode 100644 index 00000000000000..04a94f60911cf5 --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml @@ -0,0 +1,48 @@ +post: + summary: Run a connector + operationId: legacyRunConnector + deprecated: true + description: Deprecated in 7.13.0. Use the run connector API instead. + tags: + - connectors + parameters: + - $ref: '../components/headers/kbn_xsrf.yaml' + - $ref: '../components/parameters/action_id.yaml' + requestBody: + required: true + content: + application/json: + schema: + title: Legacy run connector request body properties + description: The properties vary depending on the connector type. + type: object + required: + - params + properties: + params: + type: object + description: The parameters of the connector. Parameter properties vary depending on the connector type. + responses: + '200': + description: Indicates a successful call. + content: + application/json: + schema: + type: object + properties: + actionId: + type: string + data: + oneOf: + - type: object + description: Information returned from the action. + additionalProperties: true + - type: array + description: An array of information returned from the action. + items: + type: object + status: + type: string + description: The status of the action. + '401': + $ref: '../components/responses/401.yaml' \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@list_action_types.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@list_action_types.yaml new file mode 100644 index 00000000000000..95a124be3987f8 --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@list_action_types.yaml @@ -0,0 +1,40 @@ +get: + summary: Get connector types + operationId: legacyGetConnectorTypes + deprecated: true + description: Deprecated in 7.13.0. Use the get all connector types API instead. + tags: + - connectors + responses: + '200': + description: Indicates a successful call. + content: + application/json: + schema: + title: Legacy get connector types response body properties + description: The properties vary for each connector type. + type: array + items: + type: object + properties: + enabled: + type: boolean + description: Indicates whether the connector type is enabled in Kibana. + enabledInConfig: + type: boolean + description: Indicates whether the connector type is enabled in the Kibana `.yml` file. + enabledInLicense: + type: boolean + description: Indicates whether the connector is enabled in the license. + example: true + id: + type: string + description: The unique identifier for the connector type. + minimumLicenseRequired: + type: string + description: The license that is required to use the connector type. + name: + type: string + description: The name of the connector type. + '401': + $ref: '../components/responses/401.yaml' \ No newline at end of file From e8d64e6f2ba9afd64266476f379b31a5081301ae Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 24 Jul 2024 14:51:38 -0700 Subject: [PATCH 08/10] Deprecate legacy delete connector; regenerate output --- oas_docs/output/kibana.serverless.yaml | 103 +- oas_docs/output/kibana.yaml | 905 +++----------- .../plugins/actions/docs/openapi/bundled.json | 1103 ++++------------- .../plugins/actions/docs/openapi/bundled.yaml | 694 +++-------- .../docs/openapi/bundled_serverless.json | 16 +- .../docs/openapi/bundled_serverless.yaml | 12 +- .../actions/docs/openapi/entrypoint.yaml | 8 +- .../openapi/paths/api@actions@connector.yaml | 3 +- .../actions/server/routes/legacy/delete.ts | 1 + 9 files changed, 658 insertions(+), 2187 deletions(-) diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 87a49cbc27d5fc..e93ca0a49c0c8a 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -273,8 +273,9 @@ paths: type: string /api/actions/connector: post: - summary: Create a connector + summary: Create a connector with a random ID operationId: createConnector + description: The connector identifier is randomly generated. tags: - connectors parameters: @@ -320,8 +321,6 @@ paths: #/components/examples/Connectors_create_xmatters_connector_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_apiKeyAuth: [] /api/actions/connector/{connectorId}: get: summary: Get a connector information @@ -344,8 +343,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_apiKeyAuth: [] delete: summary: Delete a connector operationId: deleteConnector @@ -361,8 +358,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_apiKeyAuth: [] post: summary: Create a connector operationId: createConnectorId @@ -402,8 +397,6 @@ paths: #/components/examples/Connectors_create_index_connector_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_apiKeyAuth: [] put: summary: Update a connector operationId: updateConnector @@ -435,8 +428,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_apiKeyAuth: [] /api/actions/connectors: get: summary: Get all connectors @@ -458,8 +449,6 @@ paths: $ref: '#/components/examples/Connectors_get_connectors_response' '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_apiKeyAuth: [] /api/actions/connector_types: get: summary: Get all connector types @@ -532,8 +521,6 @@ paths: #/components/examples/Connectors_get_connector_types_generativeai_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_apiKeyAuth: [] /s/{spaceId}/api/data_views: get: summary: Get all data views @@ -2619,53 +2606,6 @@ paths: security: - Kibana_HTTP_APIs_basicAuth: [] components: - securitySchemes: - Connectors_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. - Data_views_basicAuth: - type: http - scheme: basic - Data_views_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. - Machine_learning_APIs_apiKeyAuth: - type: apiKey - in: header - name: ApiKey - Serverless_saved_objects_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. - SLOs_basicAuth: - type: http - scheme: basic - SLOs_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' - Kibana_HTTP_APIs_apiKeyAuth: - in: header - name: Authorization - type: apiKey - Kibana_HTTP_APIs_basicAuth: - scheme: basic - type: http parameters: Connectors_kbn_xsrf: schema: @@ -9617,6 +9557,45 @@ components: example: 404 enum: - 404 + securitySchemes: + Data_views_basicAuth: + type: http + scheme: basic + Data_views_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: > + Serverless APIs support only key-based authentication. You must create + an API key and use the encoded value in the request header. For example: + 'Authorization: ApiKey base64AccessApiKey'. + Machine_learning_APIs_apiKeyAuth: + type: apiKey + in: header + name: ApiKey + Serverless_saved_objects_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: > + Serverless APIs support only key-based authentication. You must create + an API key and use the encoded value in the request header. For example: + 'Authorization: ApiKey base64AccessApiKey'. + SLOs_basicAuth: + type: http + scheme: basic + SLOs_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: 'e.g. Authorization: ApiKey base64AccessApiKey' + Kibana_HTTP_APIs_apiKeyAuth: + in: header + name: Authorization + type: apiKey + Kibana_HTTP_APIs_basicAuth: + scheme: basic + type: http x-tagGroups: - name: APM UI tags: diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 3d86f75dfec96b..0df082b4f5632d 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -262,404 +262,11 @@ paths: type: string '@timestamp': type: string - /s/{spaceId}/api/actions/connector: - post: - summary: Create a connector - operationId: createConnectorWithSpaceId - description: > - You must have `all` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_create_connector_request' - examples: - createEmailConnectorRequest: - $ref: >- - #/components/examples/Connectors_create_email_connector_request - createIndexConnectorRequest: - $ref: >- - #/components/examples/Connectors_create_index_connector_request - createWebhookConnectorRequest: - $ref: >- - #/components/examples/Connectors_create_webhook_connector_request - createXmattersConnectorRequest: - $ref: >- - #/components/examples/Connectors_create_xmatters_connector_request - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_connector_response_properties' - examples: - createEmailConnectorResponse: - $ref: >- - #/components/examples/Connectors_create_email_connector_response - createIndexConnectorResponse: - $ref: >- - #/components/examples/Connectors_create_index_connector_response - createWebhookConnectorResponse: - $ref: >- - #/components/examples/Connectors_create_webhook_connector_response - createXmattersConnectorResponse: - $ref: >- - #/components/examples/Connectors_create_xmatters_connector_response - '401': - $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/connector/{connectorId}: - get: - summary: Get connector information - operationId: getConnectorWithSpaceId - description: > - You must have `read` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_connector_id' - - $ref: '#/components/parameters/Connectors_space_id' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_connector_response_properties' - examples: - getConnectorResponse: - $ref: '#/components/examples/Connectors_get_connector_response' - '401': - $ref: '#/components/responses/Connectors_401' - '404': - $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - delete: - summary: Delete a connector - operationId: deleteConnectorWithSpaceId - description: > - You must have `all` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - WARNING: When you delete a connector, it cannot be recovered. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_connector_id' - - $ref: '#/components/parameters/Connectors_space_id' - responses: - '204': - description: Indicates a successful call. - '401': - $ref: '#/components/responses/Connectors_401' - '404': - $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - post: - summary: Create a connector - operationId: createConnectorIdWithSpaceId - description: > - You must have `all` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_space_id' - - in: path - name: connectorId - description: >- - A UUID v1 or v4 identifier for the connector. If you omit this - parameter, an identifier is randomly generated. - required: true - schema: - type: string - example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_create_connector_request' - examples: - createIndexConnectorRequest: - $ref: >- - #/components/examples/Connectors_create_index_connector_request - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_connector_response_properties' - examples: - createIndexConnectorResponse: - $ref: >- - #/components/examples/Connectors_create_index_connector_response - '401': - $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - put: - summary: Update a connector - operationId: updateConnectorWithSpaceId - description: > - You must have `all` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_connector_id' - - $ref: '#/components/parameters/Connectors_space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_update_connector_request' - examples: - updateIndexConnectorRequest: - $ref: >- - #/components/examples/Connectors_update_index_connector_request - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_connector_response_properties' - '400': - $ref: '#/components/responses/Connectors_401' - '401': - $ref: '#/components/responses/Connectors_401' - '404': - $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/connectors: - get: - summary: Get all connectors - operationId: getConnectorsWithSpaceId - description: > - You must have `read` privileges for the **Actions and Connectors** - feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_space_id' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - type: array - items: - $ref: >- - #/components/schemas/Connectors_connector_response_properties - examples: - getConnectorsResponse: - $ref: '#/components/examples/Connectors_get_connectors_response' - '401': - $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/connector_types: - get: - summary: Get all connector types - operationId: getConnectorTypesWithSpaceId - description: | - You do not need any Kibana feature privileges to run this API. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_space_id' - - in: query - name: feature_id - description: >- - A filter to limit the retrieved connector types to those that - support a specific feature (such as alerting or cases). - schema: - $ref: '#/components/schemas/Connectors_features' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - title: Get connector types response body properties - description: The properties vary for each connector type. - type: array - items: - type: object - properties: - enabled: - type: boolean - description: >- - Indicates whether the connector type is enabled in - Kibana. - example: true - enabled_in_config: - type: boolean - description: >- - Indicates whether the connector type is enabled in the - Kibana `.yml` file. - example: true - enabled_in_license: - type: boolean - description: >- - Indicates whether the connector is enabled in the - license. - example: true - id: - $ref: '#/components/schemas/Connectors_connector_types' - minimum_license_required: - type: string - description: The license that is required to use the connector type. - example: basic - name: - type: string - description: The name of the connector type. - example: Index - supported_feature_ids: - type: array - description: >- - The Kibana features that are supported by the connector - type. - items: - $ref: '#/components/schemas/Connectors_features' - example: - - alerting - - uptime - - siem - examples: - getConnectorTypesResponse: - $ref: >- - #/components/examples/Connectors_get_connector_types_response - '401': - $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/connector/{connectorId}/_execute: - post: - summary: Run a connector - operationId: runConnectorWithSpaceId - description: > - You can use this API to test an action that involves interaction with - Kibana services or integrations with third-party systems. You must have - `read` privileges for the **Actions and Connectors** feature in the - **Management** section of the Kibana feature privileges. If you use an - index connector, you must also have `all`, `create`, `index`, or `write` - indices privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_connector_id' - - $ref: '#/components/parameters/Connectors_space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/Connectors_run_connector_request' - examples: - runIndexConnectorRequest: - $ref: '#/components/examples/Connectors_run_index_connector_request' - runJiraConnectorRequest: - $ref: '#/components/examples/Connectors_run_jira_connector_request' - runServerLogConnectorRequest: - $ref: >- - #/components/examples/Connectors_run_server_log_connector_request - runServiceNowITOMConnectorRequest: - $ref: >- - #/components/examples/Connectors_run_servicenow_itom_connector_request - runSlackConnectorRequest: - $ref: >- - #/components/examples/Connectors_run_slack_api_connector_request - runSwimlaneConnectorRequest: - $ref: >- - #/components/examples/Connectors_run_swimlane_connector_request - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - type: object - required: - - connector_id - - status - properties: - connector_id: - type: string - description: The identifier for the connector. - data: - oneOf: - - type: object - description: Information returned from the action. - additionalProperties: true - - type: array - description: An array of information returned from the action. - items: - type: object - message: - type: string - service_message: - type: string - status: - type: string - description: The status of the action. - enum: - - error - - ok - examples: - runIndexConnectorResponse: - $ref: >- - #/components/examples/Connectors_run_index_connector_response - runJiraConnectorResponse: - $ref: '#/components/examples/Connectors_run_jira_connector_response' - runServerLogConnectorResponse: - $ref: >- - #/components/examples/Connectors_run_server_log_connector_response - runServiceNowITOMConnectorResponse: - $ref: >- - #/components/examples/Connectors_run_servicenow_itom_connector_response - runSlackConnectorResponse: - $ref: >- - #/components/examples/Connectors_run_slack_api_connector_response - runSwimlaneConnectorResponse: - $ref: >- - #/components/examples/Connectors_run_swimlane_connector_response - '401': - $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/actions/connector: post: - summary: Create a connector + summary: Create a connector with a random ID operationId: createConnector + description: The connector identifier is randomly generated. tags: - connectors parameters: @@ -705,9 +312,6 @@ paths: #/components/examples/Connectors_create_xmatters_connector_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/actions/connector/{connectorId}: get: summary: Get a connector information @@ -730,9 +334,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] delete: summary: Delete a connector operationId: deleteConnector @@ -748,9 +349,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] post: summary: Create a connector operationId: createConnectorId @@ -790,9 +388,6 @@ paths: #/components/examples/Connectors_create_index_connector_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] put: summary: Update a connector operationId: updateConnector @@ -824,9 +419,6 @@ paths: $ref: '#/components/responses/Connectors_401' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/actions/connector/{connectorId}/_execute: post: summary: Run a connector @@ -932,9 +524,6 @@ paths: #/components/examples/Connectors_run_swimlane_connector_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/actions/connectors: get: summary: Get all connectors @@ -956,9 +545,6 @@ paths: $ref: '#/components/examples/Connectors_get_connectors_response' '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/actions/connector_types: get: summary: Get all connector types @@ -1031,10 +617,7 @@ paths: #/components/examples/Connectors_get_connector_types_generativeai_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/action/{actionId}: + /api/actions/action/{actionId}: delete: summary: Delete a connector operationId: legacyDeleteConnector @@ -1047,15 +630,11 @@ paths: parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_action_id' - - $ref: '#/components/parameters/Connectors_space_id' responses: '204': description: Indicates a successful call. '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] get: summary: Get connector information operationId: legacyGetConnector @@ -1065,15 +644,11 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_action_id' - - $ref: '#/components/parameters/Connectors_space_id' responses: '200': $ref: '#/components/responses/Connectors_200_actions' '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] put: summary: Update a connector operationId: legacyUpdateConnector @@ -1084,7 +659,6 @@ paths: parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_action_id' - - $ref: '#/components/parameters/Connectors_space_id' requestBody: required: true content: @@ -1112,10 +686,7 @@ paths: $ref: '#/components/responses/Connectors_200_actions' '404': $ref: '#/components/responses/Connectors_404' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions: + /api/actions: get: summary: Get all connectors operationId: legacyGetConnectors @@ -1123,8 +694,6 @@ paths: description: Deprecated in 7.13.0. Use the get all connectors API instead. tags: - connectors - parameters: - - $ref: '#/components/parameters/Connectors_space_id' responses: '200': description: Indicates a successful call. @@ -1136,9 +705,6 @@ paths: $ref: '#/components/schemas/Connectors_action_response_properties' '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] post: summary: Create a connector operationId: legacyCreateConnector @@ -1148,7 +714,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - - $ref: '#/components/parameters/Connectors_space_id' requestBody: required: true content: @@ -1180,10 +745,7 @@ paths: $ref: '#/components/responses/Connectors_200_actions' '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/list_action_types: + /api/actions/list_action_types: get: summary: Get connector types operationId: legacyGetConnectorTypes @@ -1191,8 +753,6 @@ paths: description: Deprecated in 7.13.0. Use the get all connector types API instead. tags: - connectors - parameters: - - $ref: '#/components/parameters/Connectors_space_id' responses: '200': description: Indicates a successful call. @@ -1232,10 +792,7 @@ paths: description: The name of the connector type. '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] - /s/{spaceId}/api/actions/action/{actionId}/_execute: + /api/actions/action/{actionId}/_execute: post: summary: Run a connector operationId: legacyRunConnector @@ -1246,7 +803,6 @@ paths: parameters: - $ref: '#/components/parameters/Connectors_kbn_xsrf' - $ref: '#/components/parameters/Connectors_action_id' - - $ref: '#/components/parameters/Connectors_space_id' requestBody: required: true content: @@ -1287,9 +843,6 @@ paths: description: The status of the action. '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /s/{spaceId}/api/data_views: get: summary: Get all data views @@ -4094,56 +3647,6 @@ paths: security: - Kibana_HTTP_APIs_basicAuth: [] components: - securitySchemes: - Connectors_basicAuth: - type: http - scheme: basic - Connectors_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' - Data_views_basicAuth: - type: http - scheme: basic - Data_views_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. - Machine_learning_APIs_basicAuth: - type: http - scheme: basic - Machine_learning_APIs_apiKeyAuth: - type: apiKey - in: header - name: ApiKey - Saved_objects_basicAuth: - type: http - scheme: basic - Saved_objects_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' - SLOs_basicAuth: - type: http - scheme: basic - SLOs_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' - Kibana_HTTP_APIs_apiKeyAuth: - in: header - name: Authorization - type: apiKey - Kibana_HTTP_APIs_basicAuth: - scheme: basic - type: http parameters: Connectors_kbn_xsrf: schema: @@ -4152,16 +3655,6 @@ components: name: kbn-xsrf description: Cross-site request forgery protection required: true - Connectors_space_id: - in: path - name: spaceId - description: >- - An identifier for the space. If `/s/` and the identifier are omitted - from the path, the default space is used. - required: true - schema: - type: string - example: default Connectors_connector_id: in: path name: connectorId @@ -7285,50 +6778,6 @@ components: - $ref: '#/components/schemas/Connectors_update_connector_request_torq' - $ref: '#/components/schemas/Connectors_update_connector_request_webhook' - $ref: '#/components/schemas/Connectors_update_connector_request_xmatters' - Connectors_features: - type: string - description: | - The feature that uses the connector. - enum: - - alerting - - cases - - generativeAIForSecurity - - generativeAIForObservability - - generativeAIForSearchPlayground - - siem - - uptime - Connectors_connector_types: - title: Connector types - type: string - description: >- - The type of connector. For example, `.email`, `.index`, `.jira`, - `.opsgenie`, or `.server-log`. - enum: - - .bedrock - - .gemini - - .cases-webhook - - .d3security - - .email - - .gen-ai - - .index - - .jira - - .opsgenie - - .pagerduty - - .resilient - - .sentinelone - - .servicenow - - .servicenow-itom - - .servicenow-sir - - .server-log - - .slack - - .slack_api - - .swimlane - - .teams - - .tines - - .torq - - .webhook - - .xmatters - example: .server-log Connectors_run_connector_params_acknowledge_resolve_pagerduty: title: PagerDuty connector parameters description: Test an action that acknowledges or resolves a PagerDuty alert. @@ -8264,6 +7713,50 @@ components: #/components/schemas/Connectors_run_connector_subaction_issuetypes pushToService: >- #/components/schemas/Connectors_run_connector_subaction_pushtoservice + Connectors_features: + type: string + description: | + The feature that uses the connector. + enum: + - alerting + - cases + - generativeAIForSecurity + - generativeAIForObservability + - generativeAIForSearchPlayground + - siem + - uptime + Connectors_connector_types: + title: Connector types + type: string + description: >- + The type of connector. For example, `.email`, `.index`, `.jira`, + `.opsgenie`, or `.server-log`. + enum: + - .bedrock + - .gemini + - .cases-webhook + - .d3security + - .email + - .gen-ai + - .index + - .jira + - .opsgenie + - .pagerduty + - .resilient + - .sentinelone + - .servicenow + - .servicenow-itom + - .servicenow-sir + - .server-log + - .slack + - .slack_api + - .swimlane + - .teams + - .tines + - .torq + - .webhook + - .xmatters + example: .server-log Connectors_action_response_properties: title: Action response properties description: The properties vary depending on the action type. @@ -10324,62 +9817,39 @@ components: summary: Update an index connector. value: name: updated-connector - config: - index: updated-index - Connectors_get_connectors_response: - summary: A list of connectors - value: - - id: preconfigured-email-connector - name: my-preconfigured-email-notification - connector_type_id: .email - is_preconfigured: true - is_deprecated: false - referenced_by_count: 0 - is_system_action: false - - id: e07d0c80-8b8b-11ed-a780-3b746c987a81 - name: my-index-connector - config: - index: test-index - refresh: false - executionTimeField: null - connector_type_id: .index - is_preconfigured: false - is_deprecated: false - referenced_by_count: 2 - is_missing_secrets: false - is_system_action: false - Connectors_get_connector_types_response: - summary: A list of connector types + config: + index: updated-index + Connectors_run_cases_webhook_connector_request: + summary: Run a Webhook - Case Management connector to create a case. value: - - id: .swimlane - name: Swimlane - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: gold - supported_feature_ids: - - alerting - - cases - - siem - - id: .index - name: Index - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: basic - supported_feature_ids: - - alerting - - uptime - - siem - - id: .server-log - name: Server log - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: basic - supported_feature_ids: - - alerting - - uptime + params: + subAction: pushToService + subActionParams: + comments: + - commentId: 1 + comment: A comment about the incident. + incident: + title: Case title + description: Description of the incident. + tags: + - tag1 + - tag2 + severity: low + status: open + id: caseID + Connectors_run_email_connector_request: + summary: Send an email message from an email connector. + value: + params: + bcc: + - user1@example.com + cc: + - user2@example.com + - user3@example.com + message: Test email message. + subject: Test message subject + to: + - user4@example.com Connectors_run_index_connector_request: summary: Run an index connector. value: @@ -10393,6 +9863,17 @@ components: value: params: subAction: issueTypes + Connectors_run_pagerduty_connector_request: + summary: Run a PagerDuty connector to trigger an alert. + value: + params: + eventAction: trigger + summary: A brief event summary + links: + - href: http://example.com/pagerduty + text: An example link + customDetails: + my_data_1: test data Connectors_run_server_log_connector_request: summary: Run a server log connector. value: @@ -10432,6 +9913,45 @@ components: caseId: '1000' caseName: Case name description: Description of the incident. + Connectors_run_cases_webhook_connector_response: + summary: >- + Response from a pushToService action for a Webhook - Case Management + connector. + value: + connector_id: 1824b5b8-c005-4dcc-adac-57f92db46459 + data: + id: 100665 + title: TEST-29034 + url: https://example.com/browse/TEST-29034 + pushedDate: '2023-12-05T19:43:36.360Z' + comments: + - commentId: 1 + pushedDate: '2023-12-05T19:43:36.360Z' + status: ok + Connectors_run_email_connector_response: + summary: Response for sending a message from an email connector. + value: + connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907 + data: + accepted: + - user1@example.com + - user2@example.com + - user3@example.com + - user4@example.com + envelope: + from: tester@example.com + to: + - user1@example.com + - user2@example.com + - user3@example.com + - user4@example.com + envelopeTime: 8 + messageTime: 3 + messageSize: 729 + response: 250 Message queued as QzEXKcGJ + messageId: <08a92d29-642a-0706-750c-de5996bd5cf3@example.com> + rejected: [] + status: ok Connectors_run_index_connector_response: summary: Response from running an index connector. value: @@ -10471,6 +9991,15 @@ components: - id: 10000 name: Epic status: ok + Connectors_run_pagerduty_connector_response: + summary: Response from running a PagerDuty connector. + value: + connector_id: 45de9f70-954f-4608-b12a-db7cf808e49d + data: + dedup_key: 5115e138b26b484a81eaea779faa6016 + message: Event processed + status: success + status: ok Connectors_run_server_log_connector_response: summary: Response from running a server log connector. value: @@ -10568,96 +10097,28 @@ components: - commentId: 1 pushedDate: '2022-09-08T16:52:27.865Z' status: ok - Connectors_run_cases_webhook_connector_request: - summary: Run a Webhook - Case Management connector to create a case. - value: - params: - subAction: pushToService - subActionParams: - comments: - - commentId: 1 - comment: A comment about the incident. - incident: - title: Case title - description: Description of the incident. - tags: - - tag1 - - tag2 - severity: low - status: open - id: caseID - Connectors_run_email_connector_request: - summary: Send an email message from an email connector. - value: - params: - bcc: - - user1@example.com - cc: - - user2@example.com - - user3@example.com - message: Test email message. - subject: Test message subject - to: - - user4@example.com - Connectors_run_pagerduty_connector_request: - summary: Run a PagerDuty connector to trigger an alert. - value: - params: - eventAction: trigger - summary: A brief event summary - links: - - href: http://example.com/pagerduty - text: An example link - customDetails: - my_data_1: test data - Connectors_run_cases_webhook_connector_response: - summary: >- - Response from a pushToService action for a Webhook - Case Management - connector. - value: - connector_id: 1824b5b8-c005-4dcc-adac-57f92db46459 - data: - id: 100665 - title: TEST-29034 - url: https://example.com/browse/TEST-29034 - pushedDate: '2023-12-05T19:43:36.360Z' - comments: - - commentId: 1 - pushedDate: '2023-12-05T19:43:36.360Z' - status: ok - Connectors_run_email_connector_response: - summary: Response for sending a message from an email connector. - value: - connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907 - data: - accepted: - - user1@example.com - - user2@example.com - - user3@example.com - - user4@example.com - envelope: - from: tester@example.com - to: - - user1@example.com - - user2@example.com - - user3@example.com - - user4@example.com - envelopeTime: 8 - messageTime: 3 - messageSize: 729 - response: 250 Message queued as QzEXKcGJ - messageId: <08a92d29-642a-0706-750c-de5996bd5cf3@example.com> - rejected: [] - status: ok - Connectors_run_pagerduty_connector_response: - summary: Response from running a PagerDuty connector. + Connectors_get_connectors_response: + summary: A list of connectors value: - connector_id: 45de9f70-954f-4608-b12a-db7cf808e49d - data: - dedup_key: 5115e138b26b484a81eaea779faa6016 - message: Event processed - status: success - status: ok + - id: preconfigured-email-connector + name: my-preconfigured-email-notification + connector_type_id: .email + is_preconfigured: true + is_deprecated: false + referenced_by_count: 0 + is_system_action: false + - id: e07d0c80-8b8b-11ed-a780-3b746c987a81 + name: my-index-connector + config: + index: test-index + refresh: false + executionTimeField: null + connector_type_id: .index + is_preconfigured: false + is_deprecated: false + referenced_by_count: 2 + is_missing_secrets: false + is_system_action: false Connectors_get_connector_types_generativeai_response: summary: A list of connector types for the `generativeAI` feature. value: @@ -12369,6 +11830,48 @@ components: application/json: schema: $ref: '#/components/schemas/Connectors_action_response_properties' + securitySchemes: + Data_views_basicAuth: + type: http + scheme: basic + Data_views_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: > + Serverless APIs support only key-based authentication. You must create + an API key and use the encoded value in the request header. For example: + 'Authorization: ApiKey base64AccessApiKey'. + Machine_learning_APIs_basicAuth: + type: http + scheme: basic + Machine_learning_APIs_apiKeyAuth: + type: apiKey + in: header + name: ApiKey + Saved_objects_basicAuth: + type: http + scheme: basic + Saved_objects_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: 'e.g. Authorization: ApiKey base64AccessApiKey' + SLOs_basicAuth: + type: http + scheme: basic + SLOs_apiKeyAuth: + type: apiKey + in: header + name: Authorization + description: 'e.g. Authorization: ApiKey base64AccessApiKey' + Kibana_HTTP_APIs_apiKeyAuth: + in: header + name: Authorization + type: apiKey + Kibana_HTTP_APIs_basicAuth: + scheme: basic + type: http x-tagGroups: - name: APM UI tags: diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index a66b4db4408288..dd6230617d499f 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -17,14 +17,6 @@ "url": "/" } ], - "security": [ - { - "basicAuth": [] - }, - { - "apiKeyAuth": [] - } - ], "tags": [ { "name": "connectors", @@ -32,20 +24,17 @@ } ], "paths": { - "/s/{spaceId}/api/actions/connector": { + "/api/actions/connector": { "post": { - "summary": "Create a connector", - "operationId": "createConnectorWithSpaceId", - "description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n", + "summary": "Create a connector with a random ID", + "operationId": "createConnector", + "description": "The connector identifier is randomly generated.", "tags": [ "connectors" ], "parameters": [ { "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -103,20 +92,16 @@ } } }, - "/s/{spaceId}/api/actions/connector/{connectorId}": { + "/api/actions/connector/{connectorId}": { "get": { - "summary": "Get connector information", - "operationId": "getConnectorWithSpaceId", - "description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n", + "summary": "Get a connector information", + "operationId": "getConnector", "tags": [ "connectors" ], "parameters": [ { "$ref": "#/components/parameters/connector_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "responses": { @@ -145,8 +130,7 @@ }, "delete": { "summary": "Delete a connector", - "operationId": "deleteConnectorWithSpaceId", - "description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered.\n", + "operationId": "deleteConnector", "tags": [ "connectors" ], @@ -156,9 +140,6 @@ }, { "$ref": "#/components/parameters/connector_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "responses": { @@ -175,8 +156,7 @@ }, "post": { "summary": "Create a connector", - "operationId": "createConnectorIdWithSpaceId", - "description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n", + "operationId": "createConnectorId", "tags": [ "connectors" ], @@ -184,13 +164,10 @@ { "$ref": "#/components/parameters/kbn_xsrf" }, - { - "$ref": "#/components/parameters/space_id" - }, { "in": "path", "name": "connectorId", - "description": "A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.", + "description": "A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.\n", "required": true, "schema": { "type": "string", @@ -236,8 +213,7 @@ }, "put": { "summary": "Update a connector", - "operationId": "updateConnectorWithSpaceId", - "description": "You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n", + "operationId": "updateConnector", "tags": [ "connectors" ], @@ -247,9 +223,6 @@ }, { "$ref": "#/components/parameters/connector_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -290,138 +263,10 @@ } } }, - "/s/{spaceId}/api/actions/connectors": { - "get": { - "summary": "Get all connectors", - "operationId": "getConnectorsWithSpaceId", - "description": "You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges.\n", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/space_id" - } - ], - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/connector_response_properties" - } - }, - "examples": { - "getConnectorsResponse": { - "$ref": "#/components/examples/get_connectors_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/s/{spaceId}/api/actions/connector_types": { - "get": { - "summary": "Get all connector types", - "operationId": "getConnectorTypesWithSpaceId", - "description": "You do not need any Kibana feature privileges to run this API.\n", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/space_id" - }, - { - "in": "query", - "name": "feature_id", - "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).", - "schema": { - "$ref": "#/components/schemas/features" - } - } - ], - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "title": "Get connector types response body properties", - "description": "The properties vary for each connector type.", - "type": "array", - "items": { - "type": "object", - "properties": { - "enabled": { - "type": "boolean", - "description": "Indicates whether the connector type is enabled in Kibana.", - "example": true - }, - "enabled_in_config": { - "type": "boolean", - "description": "Indicates whether the connector type is enabled in the Kibana `.yml` file.", - "example": true - }, - "enabled_in_license": { - "type": "boolean", - "description": "Indicates whether the connector is enabled in the license.", - "example": true - }, - "id": { - "$ref": "#/components/schemas/connector_types" - }, - "minimum_license_required": { - "type": "string", - "description": "The license that is required to use the connector type.", - "example": "basic" - }, - "name": { - "type": "string", - "description": "The name of the connector type.", - "example": "Index" - }, - "supported_feature_ids": { - "type": "array", - "description": "The Kibana features that are supported by the connector type.", - "items": { - "$ref": "#/components/schemas/features" - }, - "example": [ - "alerting", - "uptime", - "siem" - ] - } - } - } - }, - "examples": { - "getConnectorTypesResponse": { - "$ref": "#/components/examples/get_connector_types_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/s/{spaceId}/api/actions/connector/{connectorId}/_execute": { + "/api/actions/connector/{connectorId}/_execute": { "post": { "summary": "Run a connector", - "operationId": "runConnectorWithSpaceId", + "operationId": "runConnector", "description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.\n", "tags": [ "connectors" @@ -432,9 +277,6 @@ }, { "$ref": "#/components/parameters/connector_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -445,12 +287,21 @@ "$ref": "#/components/schemas/run_connector_request" }, "examples": { + "runCasesWebhookConnectorRequest": { + "$ref": "#/components/examples/run_cases_webhook_connector_request" + }, + "runEmailConnectorRequest": { + "$ref": "#/components/examples/run_email_connector_request" + }, "runIndexConnectorRequest": { "$ref": "#/components/examples/run_index_connector_request" }, "runJiraConnectorRequest": { "$ref": "#/components/examples/run_jira_connector_request" }, + "runPagerDutyConnectorRequest": { + "$ref": "#/components/examples/run_pagerduty_connector_request" + }, "runServerLogConnectorRequest": { "$ref": "#/components/examples/run_server_log_connector_request" }, @@ -499,12 +350,6 @@ } ] }, - "message": { - "type": "string" - }, - "service_message": { - "type": "string" - }, "status": { "type": "string", "description": "The status of the action.", @@ -516,12 +361,21 @@ } }, "examples": { + "runCasesWebhookConnectorResponse": { + "$ref": "#/components/examples/run_cases_webhook_connector_response" + }, + "runEmailConnectorResponse": { + "$ref": "#/components/examples/run_email_connector_response" + }, "runIndexConnectorResponse": { "$ref": "#/components/examples/run_index_connector_response" }, "runJiraConnectorResponse": { "$ref": "#/components/examples/run_jira_connector_response" }, + "runPagerDutyConnectorResponse": { + "$ref": "#/components/examples/run_pagerduty_connector_response" + }, "runServerLogConnectorResponse": { "$ref": "#/components/examples/run_server_log_connector_response" }, @@ -544,62 +398,27 @@ } } }, - "/api/actions/connector": { - "post": { - "summary": "Create a connector", - "operationId": "createConnector", + "/api/actions/connectors": { + "get": { + "summary": "Get all connectors", + "operationId": "getConnectors", "tags": [ "connectors" ], - "parameters": [ - { - "$ref": "#/components/parameters/kbn_xsrf" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_connector_request" - }, - "examples": { - "createEmailConnectorRequest": { - "$ref": "#/components/examples/create_email_connector_request" - }, - "createIndexConnectorRequest": { - "$ref": "#/components/examples/create_index_connector_request" - }, - "createWebhookConnectorRequest": { - "$ref": "#/components/examples/create_webhook_connector_request" - }, - "createXmattersConnectorRequest": { - "$ref": "#/components/examples/create_xmatters_connector_request" - } - } - } - } - }, "responses": { "200": { "description": "Indicates a successful call.", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/connector_response_properties" + "type": "array", + "items": { + "$ref": "#/components/schemas/connector_response_properties" + } }, "examples": { - "createEmailConnectorResponse": { - "$ref": "#/components/examples/create_email_connector_response" - }, - "createIndexConnectorResponse": { - "$ref": "#/components/examples/create_index_connector_response" - }, - "createWebhookConnectorResponse": { - "$ref": "#/components/examples/create_webhook_connector_response" - }, - "createXmattersConnectorResponse": { - "$ref": "#/components/examples/create_xmatters_connector_response" + "getConnectorsResponse": { + "$ref": "#/components/examples/get_connectors_response" } } } @@ -611,359 +430,21 @@ } } }, - "/api/actions/connector/{connectorId}": { + "/api/actions/connector_types": { "get": { - "summary": "Get a connector information", - "operationId": "getConnector", + "summary": "Get all connector types", + "operationId": "getConnectorTypes", "tags": [ "connectors" ], "parameters": [ { - "$ref": "#/components/parameters/connector_id" - } - ], - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/connector_response_properties" - }, - "examples": { - "getConnectorResponse": { - "$ref": "#/components/examples/get_connector_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - } - } - }, - "delete": { - "summary": "Delete a connector", - "operationId": "deleteConnector", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "$ref": "#/components/parameters/connector_id" - } - ], - "responses": { - "204": { - "description": "Indicates a successful call." - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - } - } - }, - "post": { - "summary": "Create a connector", - "operationId": "createConnectorId", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "in": "path", - "name": "connectorId", - "description": "A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated.\n", - "required": true, - "schema": { - "type": "string", - "example": "ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74" - } - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/create_connector_request" - }, - "examples": { - "createIndexConnectorRequest": { - "$ref": "#/components/examples/create_index_connector_request" - } - } - } - } - }, - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/connector_response_properties" - }, - "examples": { - "createIndexConnectorResponse": { - "$ref": "#/components/examples/create_index_connector_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - }, - "put": { - "summary": "Update a connector", - "operationId": "updateConnector", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "$ref": "#/components/parameters/connector_id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/update_connector_request" - }, - "examples": { - "updateIndexConnectorRequest": { - "$ref": "#/components/examples/update_index_connector_request" - } - } - } - } - }, - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/connector_response_properties" - } - } - } - }, - "400": { - "$ref": "#/components/responses/401" - }, - "401": { - "$ref": "#/components/responses/401" - }, - "404": { - "$ref": "#/components/responses/404" - } - } - } - }, - "/api/actions/connector/{connectorId}/_execute": { - "post": { - "summary": "Run a connector", - "operationId": "runConnector", - "description": "You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges.\n", - "tags": [ - "connectors" - ], - "parameters": [ - { - "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "$ref": "#/components/parameters/connector_id" - } - ], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/run_connector_request" - }, - "examples": { - "runCasesWebhookConnectorRequest": { - "$ref": "#/components/examples/run_cases_webhook_connector_request" - }, - "runEmailConnectorRequest": { - "$ref": "#/components/examples/run_email_connector_request" - }, - "runIndexConnectorRequest": { - "$ref": "#/components/examples/run_index_connector_request" - }, - "runJiraConnectorRequest": { - "$ref": "#/components/examples/run_jira_connector_request" - }, - "runPagerDutyConnectorRequest": { - "$ref": "#/components/examples/run_pagerduty_connector_request" - }, - "runServerLogConnectorRequest": { - "$ref": "#/components/examples/run_server_log_connector_request" - }, - "runServiceNowITOMConnectorRequest": { - "$ref": "#/components/examples/run_servicenow_itom_connector_request" - }, - "runSlackConnectorRequest": { - "$ref": "#/components/examples/run_slack_api_connector_request" - }, - "runSwimlaneConnectorRequest": { - "$ref": "#/components/examples/run_swimlane_connector_request" - } - } - } - } - }, - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "connector_id", - "status" - ], - "properties": { - "connector_id": { - "type": "string", - "description": "The identifier for the connector." - }, - "data": { - "oneOf": [ - { - "type": "object", - "description": "Information returned from the action.", - "additionalProperties": true - }, - { - "type": "array", - "description": "An array of information returned from the action.", - "items": { - "type": "object" - } - } - ] - }, - "status": { - "type": "string", - "description": "The status of the action.", - "enum": [ - "error", - "ok" - ] - } - } - }, - "examples": { - "runCasesWebhookConnectorResponse": { - "$ref": "#/components/examples/run_cases_webhook_connector_response" - }, - "runEmailConnectorResponse": { - "$ref": "#/components/examples/run_email_connector_response" - }, - "runIndexConnectorResponse": { - "$ref": "#/components/examples/run_index_connector_response" - }, - "runJiraConnectorResponse": { - "$ref": "#/components/examples/run_jira_connector_response" - }, - "runPagerDutyConnectorResponse": { - "$ref": "#/components/examples/run_pagerduty_connector_response" - }, - "runServerLogConnectorResponse": { - "$ref": "#/components/examples/run_server_log_connector_response" - }, - "runServiceNowITOMConnectorResponse": { - "$ref": "#/components/examples/run_servicenow_itom_connector_response" - }, - "runSlackConnectorResponse": { - "$ref": "#/components/examples/run_slack_api_connector_response" - }, - "runSwimlaneConnectorResponse": { - "$ref": "#/components/examples/run_swimlane_connector_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/api/actions/connectors": { - "get": { - "summary": "Get all connectors", - "operationId": "getConnectors", - "tags": [ - "connectors" - ], - "responses": { - "200": { - "description": "Indicates a successful call.", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "$ref": "#/components/schemas/connector_response_properties" - } - }, - "examples": { - "getConnectorsResponse": { - "$ref": "#/components/examples/get_connectors_response" - } - } - } - } - }, - "401": { - "$ref": "#/components/responses/401" - } - } - } - }, - "/api/actions/connector_types": { - "get": { - "summary": "Get all connector types", - "operationId": "getConnectorTypes", - "tags": [ - "connectors" - ], - "parameters": [ - { - "in": "query", - "name": "feature_id", - "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).", - "schema": { - "$ref": "#/components/schemas/features" - } + "in": "query", + "name": "feature_id", + "description": "A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).", + "schema": { + "$ref": "#/components/schemas/features" + } } ], "responses": { @@ -1039,7 +520,7 @@ } } }, - "/s/{spaceId}/api/actions/action/{actionId}": { + "/api/actions/action/{actionId}": { "delete": { "summary": "Delete a connector", "operationId": "legacyDeleteConnector", @@ -1054,9 +535,6 @@ }, { "$ref": "#/components/parameters/action_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "responses": { @@ -1079,9 +557,6 @@ "parameters": [ { "$ref": "#/components/parameters/action_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "responses": { @@ -1107,9 +582,6 @@ }, { "$ref": "#/components/parameters/action_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -1148,7 +620,7 @@ } } }, - "/s/{spaceId}/api/actions": { + "/api/actions": { "get": { "summary": "Get all connectors", "operationId": "legacyGetConnectors", @@ -1157,11 +629,6 @@ "tags": [ "connectors" ], - "parameters": [ - { - "$ref": "#/components/parameters/space_id" - } - ], "responses": { "200": { "description": "Indicates a successful call.", @@ -1192,9 +659,6 @@ "parameters": [ { "$ref": "#/components/parameters/kbn_xsrf" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -1236,7 +700,7 @@ } } }, - "/s/{spaceId}/api/actions/list_action_types": { + "/api/actions/list_action_types": { "get": { "summary": "Get connector types", "operationId": "legacyGetConnectorTypes", @@ -1245,11 +709,6 @@ "tags": [ "connectors" ], - "parameters": [ - { - "$ref": "#/components/parameters/space_id" - } - ], "responses": { "200": { "description": "Indicates a successful call.", @@ -1299,7 +758,7 @@ } } }, - "/s/{spaceId}/api/actions/action/{actionId}/_execute": { + "/api/actions/action/{actionId}/_execute": { "post": { "summary": "Run a connector", "operationId": "legacyRunConnector", @@ -1314,9 +773,6 @@ }, { "$ref": "#/components/parameters/action_id" - }, - { - "$ref": "#/components/parameters/space_id" } ], "requestBody": { @@ -1384,18 +840,6 @@ } }, "components": { - "securitySchemes": { - "basicAuth": { - "type": "http", - "scheme": "basic" - }, - "apiKeyAuth": { - "type": "apiKey", - "in": "header", - "name": "Authorization", - "description": "e.g. Authorization: ApiKey base64AccessApiKey" - } - }, "parameters": { "kbn_xsrf": { "schema": { @@ -1406,16 +850,6 @@ "description": "Cross-site request forgery protection", "required": true }, - "space_id": { - "in": "path", - "name": "spaceId", - "description": "An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.", - "required": true, - "schema": { - "type": "string", - "example": "default" - } - }, "connector_id": { "in": "path", "name": "connectorId", @@ -5204,51 +4638,6 @@ } ] }, - "features": { - "type": "string", - "description": "The feature that uses the connector.\n", - "enum": [ - "alerting", - "cases", - "generativeAIForSecurity", - "generativeAIForObservability", - "generativeAIForSearchPlayground", - "siem", - "uptime" - ] - }, - "connector_types": { - "title": "Connector types", - "type": "string", - "description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.", - "enum": [ - ".bedrock", - ".gemini", - ".cases-webhook", - ".d3security", - ".email", - ".gen-ai", - ".index", - ".jira", - ".opsgenie", - ".pagerduty", - ".resilient", - ".sentinelone", - ".servicenow", - ".servicenow-itom", - ".servicenow-sir", - ".server-log", - ".slack", - ".slack_api", - ".swimlane", - ".teams", - ".tines", - ".torq", - ".webhook", - ".xmatters" - ], - "example": ".server-log" - }, "run_connector_params_acknowledge_resolve_pagerduty": { "title": "PagerDuty connector parameters", "description": "Test an action that acknowledges or resolves a PagerDuty alert.", @@ -6361,6 +5750,51 @@ } } }, + "features": { + "type": "string", + "description": "The feature that uses the connector.\n", + "enum": [ + "alerting", + "cases", + "generativeAIForSecurity", + "generativeAIForObservability", + "generativeAIForSearchPlayground", + "siem", + "uptime" + ] + }, + "connector_types": { + "title": "Connector types", + "type": "string", + "description": "The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.", + "enum": [ + ".bedrock", + ".gemini", + ".cases-webhook", + ".d3security", + ".email", + ".gen-ai", + ".index", + ".jira", + ".opsgenie", + ".pagerduty", + ".resilient", + ".sentinelone", + ".servicenow", + ".servicenow-itom", + ".servicenow-sir", + ".server-log", + ".slack", + ".slack_api", + ".swimlane", + ".teams", + ".tines", + ".torq", + ".webhook", + ".xmatters" + ], + "example": ".server-log" + }, "action_response_properties": { "title": "Action response properties", "description": "The properties vary depending on the action type.", @@ -6553,77 +5987,51 @@ } } }, - "get_connectors_response": { - "summary": "A list of connectors", - "value": [ - { - "id": "preconfigured-email-connector", - "name": "my-preconfigured-email-notification", - "connector_type_id": ".email", - "is_preconfigured": true, - "is_deprecated": false, - "referenced_by_count": 0, - "is_system_action": false - }, - { - "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81", - "name": "my-index-connector", - "config": { - "index": "test-index", - "refresh": false, - "executionTimeField": null - }, - "connector_type_id": ".index", - "is_preconfigured": false, - "is_deprecated": false, - "referenced_by_count": 2, - "is_missing_secrets": false, - "is_system_action": false - } - ] - }, - "get_connector_types_response": { - "summary": "A list of connector types", - "value": [ - { - "id": ".swimlane", - "name": "Swimlane", - "enabled": true, - "enabled_in_config": true, - "enabled_in_license": true, - "minimum_license_required": "gold", - "supported_feature_ids": [ - "alerting", - "cases", - "siem" - ] - }, - { - "id": ".index", - "name": "Index", - "enabled": true, - "enabled_in_config": true, - "enabled_in_license": true, - "minimum_license_required": "basic", - "supported_feature_ids": [ - "alerting", - "uptime", - "siem" - ] - }, - { - "id": ".server-log", - "name": "Server log", - "enabled": true, - "enabled_in_config": true, - "enabled_in_license": true, - "minimum_license_required": "basic", - "supported_feature_ids": [ - "alerting", - "uptime" + "run_cases_webhook_connector_request": { + "summary": "Run a Webhook - Case Management connector to create a case.", + "value": { + "params": { + "subAction": "pushToService", + "subActionParams": { + "comments": [ + { + "commentId": 1, + "comment": "A comment about the incident." + } + ], + "incident": { + "title": "Case title", + "description": "Description of the incident.", + "tags": [ + "tag1", + "tag2" + ], + "severity": "low", + "status": "open", + "id": "caseID" + } + } + } + } + }, + "run_email_connector_request": { + "summary": "Send an email message from an email connector.", + "value": { + "params": { + "bcc": [ + "user1@example.com" + ], + "cc": [ + "user2@example.com", + "user3@example.com" + ], + "message": "Test email message.", + "subject": "Test message subject", + "to": [ + "user4@example.com" ] } - ] + } }, "run_index_connector_request": { "summary": "Run an index connector.", @@ -6647,6 +6055,24 @@ } } }, + "run_pagerduty_connector_request": { + "summary": "Run a PagerDuty connector to trigger an alert.", + "value": { + "params": { + "eventAction": "trigger", + "summary": "A brief event summary", + "links": [ + { + "href": "http://example.com/pagerduty", + "text": "An example link" + } + ], + "customDetails": { + "my_data_1": "test data" + } + } + } + }, "run_server_log_connector_request": { "summary": "Run a server log connector.", "value": { @@ -6705,6 +6131,55 @@ } } }, + "run_cases_webhook_connector_response": { + "summary": "Response from a pushToService action for a Webhook - Case Management connector.", + "value": { + "connector_id": "1824b5b8-c005-4dcc-adac-57f92db46459", + "data": { + "id": 100665, + "title": "TEST-29034", + "url": "https://example.com/browse/TEST-29034", + "pushedDate": "2023-12-05T19:43:36.360Z", + "comments": [ + { + "commentId": 1, + "pushedDate": "2023-12-05T19:43:36.360Z" + } + ] + }, + "status": "ok" + } + }, + "run_email_connector_response": { + "summary": "Response for sending a message from an email connector.", + "value": { + "connector_id": "7fc7b9a0-ecc9-11ec-8736-e7d63118c907", + "data": { + "accepted": [ + "user1@example.com", + "user2@example.com", + "user3@example.com", + "user4@example.com" + ], + "envelope": { + "from": "tester@example.com", + "to": [ + "user1@example.com", + "user2@example.com", + "user3@example.com", + "user4@example.com" + ] + }, + "envelopeTime": 8, + "messageTime": 3, + "messageSize": 729, + "response": "250 Message queued as QzEXKcGJ", + "messageId": "<08a92d29-642a-0706-750c-de5996bd5cf3@example.com>", + "rejected": [] + }, + "status": "ok" + } + }, "run_index_connector_response": { "summary": "Response from running an index connector.", "value": { @@ -6767,6 +6242,18 @@ "status": "ok" } }, + "run_pagerduty_connector_response": { + "summary": "Response from running a PagerDuty connector.", + "value": { + "connector_id": "45de9f70-954f-4608-b12a-db7cf808e49d", + "data": { + "dedup_key": "5115e138b26b484a81eaea779faa6016", + "message": "Event processed", + "status": "success" + }, + "status": "ok" + } + }, "run_server_log_connector_response": { "summary": "Response from running a server log connector.", "value": { @@ -6905,130 +6392,34 @@ "status": "ok" } }, - "run_cases_webhook_connector_request": { - "summary": "Run a Webhook - Case Management connector to create a case.", - "value": { - "params": { - "subAction": "pushToService", - "subActionParams": { - "comments": [ - { - "commentId": 1, - "comment": "A comment about the incident." - } - ], - "incident": { - "title": "Case title", - "description": "Description of the incident.", - "tags": [ - "tag1", - "tag2" - ], - "severity": "low", - "status": "open", - "id": "caseID" - } - } - } - } - }, - "run_email_connector_request": { - "summary": "Send an email message from an email connector.", - "value": { - "params": { - "bcc": [ - "user1@example.com" - ], - "cc": [ - "user2@example.com", - "user3@example.com" - ], - "message": "Test email message.", - "subject": "Test message subject", - "to": [ - "user4@example.com" - ] - } - } - }, - "run_pagerduty_connector_request": { - "summary": "Run a PagerDuty connector to trigger an alert.", - "value": { - "params": { - "eventAction": "trigger", - "summary": "A brief event summary", - "links": [ - { - "href": "http://example.com/pagerduty", - "text": "An example link" - } - ], - "customDetails": { - "my_data_1": "test data" - } - } - } - }, - "run_cases_webhook_connector_response": { - "summary": "Response from a pushToService action for a Webhook - Case Management connector.", - "value": { - "connector_id": "1824b5b8-c005-4dcc-adac-57f92db46459", - "data": { - "id": 100665, - "title": "TEST-29034", - "url": "https://example.com/browse/TEST-29034", - "pushedDate": "2023-12-05T19:43:36.360Z", - "comments": [ - { - "commentId": 1, - "pushedDate": "2023-12-05T19:43:36.360Z" - } - ] + "get_connectors_response": { + "summary": "A list of connectors", + "value": [ + { + "id": "preconfigured-email-connector", + "name": "my-preconfigured-email-notification", + "connector_type_id": ".email", + "is_preconfigured": true, + "is_deprecated": false, + "referenced_by_count": 0, + "is_system_action": false }, - "status": "ok" - } - }, - "run_email_connector_response": { - "summary": "Response for sending a message from an email connector.", - "value": { - "connector_id": "7fc7b9a0-ecc9-11ec-8736-e7d63118c907", - "data": { - "accepted": [ - "user1@example.com", - "user2@example.com", - "user3@example.com", - "user4@example.com" - ], - "envelope": { - "from": "tester@example.com", - "to": [ - "user1@example.com", - "user2@example.com", - "user3@example.com", - "user4@example.com" - ] + { + "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81", + "name": "my-index-connector", + "config": { + "index": "test-index", + "refresh": false, + "executionTimeField": null }, - "envelopeTime": 8, - "messageTime": 3, - "messageSize": 729, - "response": "250 Message queued as QzEXKcGJ", - "messageId": "<08a92d29-642a-0706-750c-de5996bd5cf3@example.com>", - "rejected": [] - }, - "status": "ok" - } - }, - "run_pagerduty_connector_response": { - "summary": "Response from running a PagerDuty connector.", - "value": { - "connector_id": "45de9f70-954f-4608-b12a-db7cf808e49d", - "data": { - "dedup_key": "5115e138b26b484a81eaea779faa6016", - "message": "Event processed", - "status": "success" - }, - "status": "ok" - } + "connector_type_id": ".index", + "is_preconfigured": false, + "is_deprecated": false, + "referenced_by_count": 2, + "is_missing_secrets": false, + "is_system_action": false + } + ] }, "get_connector_types_generativeai_response": { "summary": "A list of connector types for the `generativeAI` feature.", diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml index 96aa4a32118e28..00ffa226aef47e 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -10,341 +10,15 @@ info: url: https://www.elastic.co/licensing/elastic-license servers: - url: / -security: - - basicAuth: [] - - apiKeyAuth: [] tags: - name: connectors description: Connector APIs enable you to create and manage connectors. paths: - /s/{spaceId}/api/actions/connector: - post: - summary: Create a connector - operationId: createConnectorWithSpaceId - description: | - You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/create_connector_request' - examples: - createEmailConnectorRequest: - $ref: '#/components/examples/create_email_connector_request' - createIndexConnectorRequest: - $ref: '#/components/examples/create_index_connector_request' - createWebhookConnectorRequest: - $ref: '#/components/examples/create_webhook_connector_request' - createXmattersConnectorRequest: - $ref: '#/components/examples/create_xmatters_connector_request' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/connector_response_properties' - examples: - createEmailConnectorResponse: - $ref: '#/components/examples/create_email_connector_response' - createIndexConnectorResponse: - $ref: '#/components/examples/create_index_connector_response' - createWebhookConnectorResponse: - $ref: '#/components/examples/create_webhook_connector_response' - createXmattersConnectorResponse: - $ref: '#/components/examples/create_xmatters_connector_response' - '401': - $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/connector/{connectorId}: - get: - summary: Get connector information - operationId: getConnectorWithSpaceId - description: | - You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/connector_id' - - $ref: '#/components/parameters/space_id' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/connector_response_properties' - examples: - getConnectorResponse: - $ref: '#/components/examples/get_connector_response' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - delete: - summary: Delete a connector - operationId: deleteConnectorWithSpaceId - description: | - You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. WARNING: When you delete a connector, it cannot be recovered. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/connector_id' - - $ref: '#/components/parameters/space_id' - responses: - '204': - description: Indicates a successful call. - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - post: - summary: Create a connector - operationId: createConnectorIdWithSpaceId - description: | - You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/space_id' - - in: path - name: connectorId - description: A UUID v1 or v4 identifier for the connector. If you omit this parameter, an identifier is randomly generated. - required: true - schema: - type: string - example: ac4e6b90-6be7-11eb-ba0d-9b1c1f912d74 - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/create_connector_request' - examples: - createIndexConnectorRequest: - $ref: '#/components/examples/create_index_connector_request' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/connector_response_properties' - examples: - createIndexConnectorResponse: - $ref: '#/components/examples/create_index_connector_response' - '401': - $ref: '#/components/responses/401' - put: - summary: Update a connector - operationId: updateConnectorWithSpaceId - description: | - You must have `all` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/connector_id' - - $ref: '#/components/parameters/space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/update_connector_request' - examples: - updateIndexConnectorRequest: - $ref: '#/components/examples/update_index_connector_request' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - $ref: '#/components/schemas/connector_response_properties' - '400': - $ref: '#/components/responses/401' - '401': - $ref: '#/components/responses/401' - '404': - $ref: '#/components/responses/404' - /s/{spaceId}/api/actions/connectors: - get: - summary: Get all connectors - operationId: getConnectorsWithSpaceId - description: | - You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/space_id' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/connector_response_properties' - examples: - getConnectorsResponse: - $ref: '#/components/examples/get_connectors_response' - '401': - $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/connector_types: - get: - summary: Get all connector types - operationId: getConnectorTypesWithSpaceId - description: | - You do not need any Kibana feature privileges to run this API. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/space_id' - - in: query - name: feature_id - description: A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases). - schema: - $ref: '#/components/schemas/features' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - title: Get connector types response body properties - description: The properties vary for each connector type. - type: array - items: - type: object - properties: - enabled: - type: boolean - description: Indicates whether the connector type is enabled in Kibana. - example: true - enabled_in_config: - type: boolean - description: Indicates whether the connector type is enabled in the Kibana `.yml` file. - example: true - enabled_in_license: - type: boolean - description: Indicates whether the connector is enabled in the license. - example: true - id: - $ref: '#/components/schemas/connector_types' - minimum_license_required: - type: string - description: The license that is required to use the connector type. - example: basic - name: - type: string - description: The name of the connector type. - example: Index - supported_feature_ids: - type: array - description: The Kibana features that are supported by the connector type. - items: - $ref: '#/components/schemas/features' - example: - - alerting - - uptime - - siem - examples: - getConnectorTypesResponse: - $ref: '#/components/examples/get_connector_types_response' - '401': - $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/connector/{connectorId}/_execute: - post: - summary: Run a connector - operationId: runConnectorWithSpaceId - description: | - You can use this API to test an action that involves interaction with Kibana services or integrations with third-party systems. You must have `read` privileges for the **Actions and Connectors** feature in the **Management** section of the Kibana feature privileges. If you use an index connector, you must also have `all`, `create`, `index`, or `write` indices privileges. - tags: - - connectors - parameters: - - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/connector_id' - - $ref: '#/components/parameters/space_id' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/run_connector_request' - examples: - runIndexConnectorRequest: - $ref: '#/components/examples/run_index_connector_request' - runJiraConnectorRequest: - $ref: '#/components/examples/run_jira_connector_request' - runServerLogConnectorRequest: - $ref: '#/components/examples/run_server_log_connector_request' - runServiceNowITOMConnectorRequest: - $ref: '#/components/examples/run_servicenow_itom_connector_request' - runSlackConnectorRequest: - $ref: '#/components/examples/run_slack_api_connector_request' - runSwimlaneConnectorRequest: - $ref: '#/components/examples/run_swimlane_connector_request' - responses: - '200': - description: Indicates a successful call. - content: - application/json: - schema: - type: object - required: - - connector_id - - status - properties: - connector_id: - type: string - description: The identifier for the connector. - data: - oneOf: - - type: object - description: Information returned from the action. - additionalProperties: true - - type: array - description: An array of information returned from the action. - items: - type: object - message: - type: string - service_message: - type: string - status: - type: string - description: The status of the action. - enum: - - error - - ok - examples: - runIndexConnectorResponse: - $ref: '#/components/examples/run_index_connector_response' - runJiraConnectorResponse: - $ref: '#/components/examples/run_jira_connector_response' - runServerLogConnectorResponse: - $ref: '#/components/examples/run_server_log_connector_response' - runServiceNowITOMConnectorResponse: - $ref: '#/components/examples/run_servicenow_itom_connector_response' - runSlackConnectorResponse: - $ref: '#/components/examples/run_slack_api_connector_response' - runSwimlaneConnectorResponse: - $ref: '#/components/examples/run_swimlane_connector_response' - '401': - $ref: '#/components/responses/401' /api/actions/connector: post: - summary: Create a connector + summary: Create a connector with a random ID operationId: createConnector + description: The connector identifier is randomly generated. tags: - connectors parameters: @@ -654,7 +328,7 @@ paths: $ref: '#/components/examples/get_connector_types_generativeai_response' '401': $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/action/{actionId}: + /api/actions/action/{actionId}: delete: summary: Delete a connector operationId: legacyDeleteConnector @@ -666,7 +340,6 @@ paths: parameters: - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/action_id' - - $ref: '#/components/parameters/space_id' responses: '204': description: Indicates a successful call. @@ -681,7 +354,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/action_id' - - $ref: '#/components/parameters/space_id' responses: '200': $ref: '#/components/responses/200_actions' @@ -697,7 +369,6 @@ paths: parameters: - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/action_id' - - $ref: '#/components/parameters/space_id' requestBody: required: true content: @@ -721,7 +392,7 @@ paths: $ref: '#/components/responses/200_actions' '404': $ref: '#/components/responses/404' - /s/{spaceId}/api/actions: + /api/actions: get: summary: Get all connectors operationId: legacyGetConnectors @@ -729,8 +400,6 @@ paths: description: Deprecated in 7.13.0. Use the get all connectors API instead. tags: - connectors - parameters: - - $ref: '#/components/parameters/space_id' responses: '200': description: Indicates a successful call. @@ -751,7 +420,6 @@ paths: - connectors parameters: - $ref: '#/components/parameters/kbn_xsrf' - - $ref: '#/components/parameters/space_id' requestBody: required: true content: @@ -778,7 +446,7 @@ paths: $ref: '#/components/responses/200_actions' '401': $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/list_action_types: + /api/actions/list_action_types: get: summary: Get connector types operationId: legacyGetConnectorTypes @@ -786,8 +454,6 @@ paths: description: Deprecated in 7.13.0. Use the get all connector types API instead. tags: - connectors - parameters: - - $ref: '#/components/parameters/space_id' responses: '200': description: Indicates a successful call. @@ -821,7 +487,7 @@ paths: description: The name of the connector type. '401': $ref: '#/components/responses/401' - /s/{spaceId}/api/actions/action/{actionId}/_execute: + /api/actions/action/{actionId}/_execute: post: summary: Run a connector operationId: legacyRunConnector @@ -832,7 +498,6 @@ paths: parameters: - $ref: '#/components/parameters/kbn_xsrf' - $ref: '#/components/parameters/action_id' - - $ref: '#/components/parameters/space_id' requestBody: required: true content: @@ -872,15 +537,6 @@ paths: '401': $ref: '#/components/responses/401' components: - securitySchemes: - basicAuth: - type: http - scheme: basic - apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: 'e.g. Authorization: ApiKey base64AccessApiKey' parameters: kbn_xsrf: schema: @@ -889,14 +545,6 @@ components: name: kbn-xsrf description: Cross-site request forgery protection required: true - space_id: - in: path - name: spaceId - description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used. - required: true - schema: - type: string - example: default connector_id: in: path name: connectorId @@ -3672,48 +3320,6 @@ components: - $ref: '#/components/schemas/update_connector_request_torq' - $ref: '#/components/schemas/update_connector_request_webhook' - $ref: '#/components/schemas/update_connector_request_xmatters' - features: - type: string - description: | - The feature that uses the connector. - enum: - - alerting - - cases - - generativeAIForSecurity - - generativeAIForObservability - - generativeAIForSearchPlayground - - siem - - uptime - connector_types: - title: Connector types - type: string - description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`. - enum: - - .bedrock - - .gemini - - .cases-webhook - - .d3security - - .email - - .gen-ai - - .index - - .jira - - .opsgenie - - .pagerduty - - .resilient - - .sentinelone - - .servicenow - - .servicenow-itom - - .servicenow-sir - - .server-log - - .slack - - .slack_api - - .swimlane - - .teams - - .tines - - .torq - - .webhook - - .xmatters - example: .server-log run_connector_params_acknowledge_resolve_pagerduty: title: PagerDuty connector parameters description: Test an action that acknowledges or resolves a PagerDuty alert. @@ -4502,6 +4108,48 @@ components: issues: '#/components/schemas/run_connector_subaction_issues' issueTypes: '#/components/schemas/run_connector_subaction_issuetypes' pushToService: '#/components/schemas/run_connector_subaction_pushtoservice' + features: + type: string + description: | + The feature that uses the connector. + enum: + - alerting + - cases + - generativeAIForSecurity + - generativeAIForObservability + - generativeAIForSearchPlayground + - siem + - uptime + connector_types: + title: Connector types + type: string + description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`. + enum: + - .bedrock + - .gemini + - .cases-webhook + - .d3security + - .email + - .gen-ai + - .index + - .jira + - .opsgenie + - .pagerduty + - .resilient + - .sentinelone + - .servicenow + - .servicenow-itom + - .servicenow-sir + - .server-log + - .slack + - .slack_api + - .swimlane + - .teams + - .tines + - .torq + - .webhook + - .xmatters + example: .server-log action_response_properties: title: Action response properties description: The properties vary depending on the action type. @@ -4652,60 +4300,37 @@ components: name: updated-connector config: index: updated-index - get_connectors_response: - summary: A list of connectors + run_cases_webhook_connector_request: + summary: Run a Webhook - Case Management connector to create a case. value: - - id: preconfigured-email-connector - name: my-preconfigured-email-notification - connector_type_id: .email - is_preconfigured: true - is_deprecated: false - referenced_by_count: 0 - is_system_action: false - - id: e07d0c80-8b8b-11ed-a780-3b746c987a81 - name: my-index-connector - config: - index: test-index - refresh: false - executionTimeField: null - connector_type_id: .index - is_preconfigured: false - is_deprecated: false - referenced_by_count: 2 - is_missing_secrets: false - is_system_action: false - get_connector_types_response: - summary: A list of connector types + params: + subAction: pushToService + subActionParams: + comments: + - commentId: 1 + comment: A comment about the incident. + incident: + title: Case title + description: Description of the incident. + tags: + - tag1 + - tag2 + severity: low + status: open + id: caseID + run_email_connector_request: + summary: Send an email message from an email connector. value: - - id: .swimlane - name: Swimlane - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: gold - supported_feature_ids: - - alerting - - cases - - siem - - id: .index - name: Index - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: basic - supported_feature_ids: - - alerting - - uptime - - siem - - id: .server-log - name: Server log - enabled: true - enabled_in_config: true - enabled_in_license: true - minimum_license_required: basic - supported_feature_ids: - - alerting - - uptime + params: + bcc: + - user1@example.com + cc: + - user2@example.com + - user3@example.com + message: Test email message. + subject: Test message subject + to: + - user4@example.com run_index_connector_request: summary: Run an index connector. value: @@ -4719,6 +4344,17 @@ components: value: params: subAction: issueTypes + run_pagerduty_connector_request: + summary: Run a PagerDuty connector to trigger an alert. + value: + params: + eventAction: trigger + summary: A brief event summary + links: + - href: http://example.com/pagerduty + text: An example link + customDetails: + my_data_1: test data run_server_log_connector_request: summary: Run a server log connector. value: @@ -4756,6 +4392,43 @@ components: caseId: '1000' caseName: Case name description: Description of the incident. + run_cases_webhook_connector_response: + summary: Response from a pushToService action for a Webhook - Case Management connector. + value: + connector_id: 1824b5b8-c005-4dcc-adac-57f92db46459 + data: + id: 100665 + title: TEST-29034 + url: https://example.com/browse/TEST-29034 + pushedDate: '2023-12-05T19:43:36.360Z' + comments: + - commentId: 1 + pushedDate: '2023-12-05T19:43:36.360Z' + status: ok + run_email_connector_response: + summary: Response for sending a message from an email connector. + value: + connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907 + data: + accepted: + - user1@example.com + - user2@example.com + - user3@example.com + - user4@example.com + envelope: + from: tester@example.com + to: + - user1@example.com + - user2@example.com + - user3@example.com + - user4@example.com + envelopeTime: 8 + messageTime: 3 + messageSize: 729 + response: 250 Message queued as QzEXKcGJ + messageId: <08a92d29-642a-0706-750c-de5996bd5cf3@example.com> + rejected: [] + status: ok run_index_connector_response: summary: Response from running an index connector. value: @@ -4795,6 +4468,15 @@ components: - id: 10000 name: Epic status: ok + run_pagerduty_connector_response: + summary: Response from running a PagerDuty connector. + value: + connector_id: 45de9f70-954f-4608-b12a-db7cf808e49d + data: + dedup_key: 5115e138b26b484a81eaea779faa6016 + message: Event processed + status: success + status: ok run_server_log_connector_response: summary: Response from running a server log connector. value: @@ -4889,94 +4571,28 @@ components: - commentId: 1 pushedDate: '2022-09-08T16:52:27.865Z' status: ok - run_cases_webhook_connector_request: - summary: Run a Webhook - Case Management connector to create a case. - value: - params: - subAction: pushToService - subActionParams: - comments: - - commentId: 1 - comment: A comment about the incident. - incident: - title: Case title - description: Description of the incident. - tags: - - tag1 - - tag2 - severity: low - status: open - id: caseID - run_email_connector_request: - summary: Send an email message from an email connector. - value: - params: - bcc: - - user1@example.com - cc: - - user2@example.com - - user3@example.com - message: Test email message. - subject: Test message subject - to: - - user4@example.com - run_pagerduty_connector_request: - summary: Run a PagerDuty connector to trigger an alert. - value: - params: - eventAction: trigger - summary: A brief event summary - links: - - href: http://example.com/pagerduty - text: An example link - customDetails: - my_data_1: test data - run_cases_webhook_connector_response: - summary: Response from a pushToService action for a Webhook - Case Management connector. - value: - connector_id: 1824b5b8-c005-4dcc-adac-57f92db46459 - data: - id: 100665 - title: TEST-29034 - url: https://example.com/browse/TEST-29034 - pushedDate: '2023-12-05T19:43:36.360Z' - comments: - - commentId: 1 - pushedDate: '2023-12-05T19:43:36.360Z' - status: ok - run_email_connector_response: - summary: Response for sending a message from an email connector. - value: - connector_id: 7fc7b9a0-ecc9-11ec-8736-e7d63118c907 - data: - accepted: - - user1@example.com - - user2@example.com - - user3@example.com - - user4@example.com - envelope: - from: tester@example.com - to: - - user1@example.com - - user2@example.com - - user3@example.com - - user4@example.com - envelopeTime: 8 - messageTime: 3 - messageSize: 729 - response: 250 Message queued as QzEXKcGJ - messageId: <08a92d29-642a-0706-750c-de5996bd5cf3@example.com> - rejected: [] - status: ok - run_pagerduty_connector_response: - summary: Response from running a PagerDuty connector. + get_connectors_response: + summary: A list of connectors value: - connector_id: 45de9f70-954f-4608-b12a-db7cf808e49d - data: - dedup_key: 5115e138b26b484a81eaea779faa6016 - message: Event processed - status: success - status: ok + - id: preconfigured-email-connector + name: my-preconfigured-email-notification + connector_type_id: .email + is_preconfigured: true + is_deprecated: false + referenced_by_count: 0 + is_system_action: false + - id: e07d0c80-8b8b-11ed-a780-3b746c987a81 + name: my-index-connector + config: + index: test-index + refresh: false + executionTimeField: null + connector_type_id: .index + is_preconfigured: false + is_deprecated: false + referenced_by_count: 2 + is_missing_secrets: false + is_system_action: false get_connector_types_generativeai_response: summary: A list of connector types for the `generativeAI` feature. value: diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json index 73f0af448f5dea..90b863cea2f697 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json @@ -22,11 +22,6 @@ } } ], - "security": [ - { - "apiKeyAuth": [] - } - ], "tags": [ { "name": "connectors", @@ -36,8 +31,9 @@ "paths": { "/api/actions/connector": { "post": { - "summary": "Create a connector", + "summary": "Create a connector with a random ID", "operationId": "createConnector", + "description": "The connector identifier is randomly generated.", "tags": [ "connectors" ], @@ -396,14 +392,6 @@ } }, "components": { - "securitySchemes": { - "apiKeyAuth": { - "type": "apiKey", - "in": "header", - "name": "Authorization", - "description": "Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'.\n" - } - }, "parameters": { "kbn_xsrf": { "schema": { diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml index a59511d9137a6b..2dfeed642b4720 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml @@ -13,16 +13,15 @@ servers: variables: kibanaUrl: default: localhost:5601 -security: - - apiKeyAuth: [] tags: - name: connectors description: Connector APIs enable you to create and manage connectors. paths: /api/actions/connector: post: - summary: Create a connector + summary: Create a connector with a random ID operationId: createConnector + description: The connector identifier is randomly generated. tags: - connectors parameters: @@ -247,13 +246,6 @@ paths: '401': $ref: '#/components/responses/401' components: - securitySchemes: - apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: | - Serverless APIs support only key-based authentication. You must create an API key and use the encoded value in the request header. For example: 'Authorization: ApiKey base64AccessApiKey'. parameters: kbn_xsrf: schema: diff --git a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml index e75de58ae337b5..1da8bb7f50e83c 100644 --- a/x-pack/plugins/actions/docs/openapi/entrypoint.yaml +++ b/x-pack/plugins/actions/docs/openapi/entrypoint.yaml @@ -27,13 +27,13 @@ paths: $ref: paths/api@actions@connector_types.yaml # Deprecated endpoints: '/api/actions/action/{actionId}': - $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}.yaml' + $ref: 'paths/api@actions@action@{actionid}.yaml' '/api/actions': - $ref: 'paths/s@{spaceid}@api@actions.yaml' + $ref: 'paths/api@actions.yaml' '/api/actions/list_action_types': - $ref: 'paths/s@{spaceid}@api@actions@list_action_types.yaml' + $ref: 'paths/api@actions@list_action_types.yaml' '/api/actions/action/{actionId}/_execute': - $ref: 'paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml' + $ref: 'paths/api@actions@action@{actionid}@_execute.yaml' # Non-default space # '/s/{spaceId}/api/actions/connector': # $ref: 'paths/s@{spaceid}@api@actions@connector.yaml' diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml index bdd55d4fa9c05b..28756c37cafc38 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@connector.yaml @@ -1,6 +1,7 @@ post: - summary: Create a connector + summary: Create a connector with a random ID operationId: createConnector + description: The connector identifier is randomly generated. tags: - connectors parameters: diff --git a/x-pack/plugins/actions/server/routes/legacy/delete.ts b/x-pack/plugins/actions/server/routes/legacy/delete.ts index f5d1ed71001f2e..e2df62e5ec4bd7 100644 --- a/x-pack/plugins/actions/server/routes/legacy/delete.ts +++ b/x-pack/plugins/actions/server/routes/legacy/delete.ts @@ -32,6 +32,7 @@ export const deleteActionRoute = ( summary: `Delete a connector`, description: 'WARNING: When you delete a connector, it cannot be recovered.', tags: ['oas-tag:connectors'], + deprecated: true, }, validate: { params: paramSchema, From 9607a30d9a816fa3306562eccc936152c90b28bc Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 24 Jul 2024 14:59:09 -0700 Subject: [PATCH 09/10] Fix trailing whitespaces --- oas_docs/output/kibana.serverless.yaml | 6 +++--- oas_docs/output/kibana.yaml | 6 +++--- x-pack/plugins/actions/docs/openapi/bundled.json | 6 +++--- x-pack/plugins/actions/docs/openapi/bundled.yaml | 6 +++--- x-pack/plugins/actions/docs/openapi/bundled_serverless.json | 6 +++--- x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml | 6 +++--- .../openapi/components/schemas/config_properties_email.yaml | 4 ++-- .../components/schemas/connector_response_properties.yaml | 2 +- .../connector_response_properties_cases_webhook.yaml | 2 +- .../schemas/connector_response_properties_opsgenie.yaml | 2 +- .../schemas/connector_response_properties_resilient.yaml | 2 +- .../docs/openapi/components/schemas/is_preconfigured.yaml | 2 +- .../components/schemas/secrets_properties_servicenow.yaml | 2 +- .../paths/api@actions@action@{actionid}@_execute.yaml | 2 +- .../s@{spaceid}@api@actions@action@{actionid}@_execute.yaml | 2 +- 15 files changed, 28 insertions(+), 28 deletions(-) diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index e93ca0a49c0c8a..7994e55505c035 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -3627,7 +3627,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -3637,7 +3637,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -5305,7 +5305,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 0df082b4f5632d..42a39280c0569f 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -4658,7 +4658,7 @@ components: The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string @@ -4668,7 +4668,7 @@ components: The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is - ignored. If `service` is `other`, this property must be defined. + ignored. If `service` is `other`, this property must be defined. type: integer secure: description: > @@ -6336,7 +6336,7 @@ components: type: boolean description: > Indicates whether it is a preconfigured connector. If true, the `config` - and `is_missing_secrets` properties are omitted from the response. + and `is_missing_secrets` properties are omitted from the response. example: false Connectors_is_system_action: type: boolean diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index dd6230617d499f..20a3c4391c458f 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -1868,7 +1868,7 @@ "type": "boolean" }, "host": { - "description": "The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n", + "description": "The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.\n", "type": "string" }, "oauthTokenUrl": { @@ -1876,7 +1876,7 @@ "nullable": true }, "port": { - "description": "The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n", + "description": "The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.\n", "type": "integer" }, "secure": { @@ -4004,7 +4004,7 @@ }, "is_preconfigured": { "type": "boolean", - "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. \n", + "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.\n", "example": false }, "is_system_action": { diff --git a/x-pack/plugins/actions/docs/openapi/bundled.yaml b/x-pack/plugins/actions/docs/openapi/bundled.yaml index 00ffa226aef47e..b8ee30f08be4ba 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -1344,14 +1344,14 @@ components: type: boolean host: description: | - The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string nullable: true port: description: | - The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: integer secure: description: | @@ -2915,7 +2915,7 @@ components: is_preconfigured: type: boolean description: | - Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. + Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. example: false is_system_action: type: boolean diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json index 90b863cea2f697..ac42e68e89a09f 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.json +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.json @@ -1410,7 +1410,7 @@ "type": "boolean" }, "host": { - "description": "The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n", + "description": "The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.\n", "type": "string" }, "oauthTokenUrl": { @@ -1418,7 +1418,7 @@ "nullable": true }, "port": { - "description": "The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. \n", + "description": "The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined.\n", "type": "integer" }, "secure": { @@ -3546,7 +3546,7 @@ }, "is_preconfigured": { "type": "boolean", - "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. \n", + "description": "Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response.\n", "example": false }, "is_system_action": { diff --git a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml index 2dfeed642b4720..3d5bcd7f9c7030 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled_serverless.yaml @@ -1045,14 +1045,14 @@ components: type: boolean host: description: | - The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: string oauthTokenUrl: type: string nullable: true port: description: | - The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. + The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. If `service` is `other`, this property must be defined. type: integer secure: description: | @@ -2616,7 +2616,7 @@ components: is_preconfigured: type: boolean description: | - Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. + Indicates whether it is a preconfigured connector. If true, the `config` and `is_missing_secrets` properties are omitted from the response. example: false is_system_action: type: boolean diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_email.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_email.yaml index 6d3618e2bba27b..a7f8f3aa423fe3 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_email.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_email.yaml @@ -23,7 +23,7 @@ properties: description: > The host name of the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. - If `service` is `other`, this property must be defined. + If `service` is `other`, this property must be defined. type: string oauthTokenUrl: # description: TBD @@ -33,7 +33,7 @@ properties: description: > The port to connect to on the service provider. If the `service` is `elastic_cloud` (for Elastic Cloud notifications) or one of Nodemailer's well-known email service providers, this property is ignored. - If `service` is `other`, this property must be defined. + If `service` is `other`, this property must be defined. type: integer secure: description: > diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml index 2622f6a80dc993..87ac4da254fedb 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml @@ -1,5 +1,5 @@ title: Connector response properties -description: The properties vary depending on the connector type. +description: The properties vary depending on the connector type. oneOf: - $ref: 'connector_response_properties_bedrock.yaml' - $ref: 'connector_response_properties_gemini.yaml' diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml index 29b746e4d1f67b..d53f2334ef4af8 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml @@ -10,7 +10,7 @@ properties: config: $ref: 'config_properties_cases_webhook.yaml' connector_type_id: - description: The type of connector. + description: The type of connector. type: string enum: - .cases-webhook diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml index 9ac5d91b25c804..0e1c1dc722213b 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml @@ -11,7 +11,7 @@ properties: $ref: 'config_properties_opsgenie.yaml' connector_type_id: type: string - description: The type of connector. + description: The type of connector. enum: - .opsgenie id: diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml index 489e5ab27abfcd..d73ca0ca4b2dc6 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml @@ -11,7 +11,7 @@ properties: $ref: 'config_properties_resilient.yaml' connector_type_id: type: string - description: The type of connector. + description: The type of connector. enum: - .resilient id: diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml index e38741c83718eb..c6e7539b3cc146 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/is_preconfigured.yaml @@ -1,5 +1,5 @@ type: boolean description: > Indicates whether it is a preconfigured connector. - If true, the `config` and `is_missing_secrets` properties are omitted from the response. + If true, the `config` and `is_missing_secrets` properties are omitted from the response. example: false \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_servicenow.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_servicenow.yaml index ed70fa840ecc0c..8fa485bc4f90d7 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_servicenow.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_servicenow.yaml @@ -16,4 +16,4 @@ properties: description: The password for the RSA private key. This property is required when `isOAuth` is `true` and you set a password on your private key. username: type: string - description: The username for HTTP basic authentication. This property is required when `isOAuth` is `false`. \ No newline at end of file + description: The username for HTTP basic authentication. This property is required when `isOAuth` is `false`. \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml index 04a94f60911cf5..7298e02666e012 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/api@actions@action@{actionid}@_execute.yaml @@ -21,7 +21,7 @@ post: properties: params: type: object - description: The parameters of the connector. Parameter properties vary depending on the connector type. + description: The parameters of the connector. Parameter properties vary depending on the connector type. responses: '200': description: Indicates a successful call. diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml index 1d1db3f341e522..256f15f915de35 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@action@{actionid}@_execute.yaml @@ -22,7 +22,7 @@ post: properties: params: type: object - description: The parameters of the connector. Parameter properties vary depending on the connector type. + description: The parameters of the connector. Parameter properties vary depending on the connector type. responses: '200': description: Indicates a successful call. From 9d313381f8422d174500b0d19aee9de4502a6d05 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 25 Jul 2024 13:27:41 -0700 Subject: [PATCH 10/10] Regenerate bundles --- oas_docs/output/kibana.serverless.yaml | 13 ------------- oas_docs/output/kibana.yaml | 14 -------------- 2 files changed, 27 deletions(-) diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index 0be3001f575be3..2a1df7a13f67a2 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -521,8 +521,6 @@ paths: #/components/examples/Connectors_get_connector_types_generativeai_response '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_apiKeyAuth: [] /api/data_views: get: summary: Get all data views @@ -9065,17 +9063,6 @@ components: enum: - 404 securitySchemes: - Data_views_basicAuth: - type: http - scheme: basic - Data_views_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. Machine_learning_APIs_apiKeyAuth: type: apiKey in: header diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index 46f1d2fcaf86ba..c663e48f324cfd 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -847,9 +847,6 @@ paths: description: The status of the action. '401': $ref: '#/components/responses/Connectors_401' - security: - - Connectors_basicAuth: [] - - Connectors_apiKeyAuth: [] /api/data_views: get: summary: Get all data views @@ -11343,17 +11340,6 @@ components: schema: $ref: '#/components/schemas/Connectors_action_response_properties' securitySchemes: - Data_views_basicAuth: - type: http - scheme: basic - Data_views_apiKeyAuth: - type: apiKey - in: header - name: Authorization - description: > - Serverless APIs support only key-based authentication. You must create - an API key and use the encoded value in the request header. For example: - 'Authorization: ApiKey base64AccessApiKey'. Machine_learning_APIs_basicAuth: type: http scheme: basic