diff --git a/oas_docs/bundle.json b/oas_docs/bundle.json index f810ef1c95d8a8..a523935afdbaed 100644 --- a/oas_docs/bundle.json +++ b/oas_docs/bundle.json @@ -433,6 +433,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -518,6 +568,56 @@ ], "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -592,6 +692,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -659,6 +809,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -742,6 +942,56 @@ ], "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -776,6 +1026,7 @@ } }, { + "description": "An identifier for the connector.", "in": "path", "name": "id", "required": false, @@ -820,6 +1071,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -894,6 +1195,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -961,6 +1312,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, diff --git a/oas_docs/bundle.serverless.json b/oas_docs/bundle.serverless.json index f810ef1c95d8a8..a523935afdbaed 100644 --- a/oas_docs/bundle.serverless.json +++ b/oas_docs/bundle.serverless.json @@ -433,6 +433,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -518,6 +568,56 @@ ], "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -592,6 +692,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -659,6 +809,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -742,6 +942,56 @@ ], "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -776,6 +1026,7 @@ } }, { + "description": "An identifier for the connector.", "in": "path", "name": "id", "required": false, @@ -820,6 +1071,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -894,6 +1195,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, @@ -961,6 +1312,56 @@ }, "responses": { "200": { + "content": { + "application/json; Elastic-Api-Version=2023-10-31": { + "schema": { + "additionalProperties": false, + "properties": { + "config": { + "additionalProperties": {}, + "type": "object" + }, + "connector_type_id": { + "description": "The connector type identifier.", + "type": "string" + }, + "id": { + "description": "The identifier for the connector.", + "type": "string" + }, + "is_deprecated": { + "description": "Indicates whether the connector is deprecated.", + "type": "boolean" + }, + "is_missing_secrets": { + "description": "Indicates whether the connector is missing secrets.", + "type": "boolean" + }, + "is_preconfigured": { + "description": "Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ", + "type": "boolean" + }, + "is_system_action": { + "description": "Indicates whether the connector is used for system actions.", + "type": "boolean" + }, + "name": { + "description": " The name of the rule.", + "type": "string" + } + }, + "required": [ + "id", + "name", + "connector_type_id", + "is_preconfigured", + "is_deprecated", + "is_system_action" + ], + "type": "object" + } + } + }, "description": "Indicates a successful call." } }, diff --git a/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts b/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts index df17536ad44ee9..5c9b95ca8fc7b9 100644 --- a/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts +++ b/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts @@ -8,34 +8,93 @@ import { schema } from '@kbn/config-schema'; export const connectorResponseSchema = schema.object({ - id: schema.string(), - name: schema.string(), + id: schema.string({ + meta: { + description: 'The identifier for the connector.', + }, + }), + name: schema.string({ + meta: { + description: ' The name of the rule.', + }, + }), config: schema.maybe(schema.recordOf(schema.string(), schema.any())), - connector_type_id: schema.string(), - is_missing_secrets: schema.maybe(schema.boolean()), - is_preconfigured: schema.boolean(), - is_deprecated: schema.boolean(), - is_system_action: schema.boolean(), + connector_type_id: schema.string({ + meta: { description: 'The connector type identifier.' }, + }), + is_missing_secrets: schema.maybe( + schema.boolean({ meta: { description: 'Indicates whether the connector is missing secrets.' } }) + ), + is_preconfigured: schema.boolean({ + meta: { + description: + 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ', + }, + }), + is_deprecated: schema.boolean({ + meta: { description: 'Indicates whether the connector is deprecated.' }, + }), + is_system_action: schema.boolean({ + meta: { description: 'Indicates whether the connector is used for system actions.' }, + }), }); export const allConnectorsResponseSchema = connectorResponseSchema.extends({ - referenced_by_count: schema.number(), + referenced_by_count: schema.number({ + meta: { + description: + 'The number of saved objects that reference the connector. If is_preconfigured is true, this value is not calculated.', + }, + }), }); export const connectorTypesResponseSchema = schema.object({ - id: schema.string(), - name: schema.string(), - enabled: schema.boolean(), - enabled_in_config: schema.boolean(), - enabled_in_license: schema.boolean(), - minimum_license_required: schema.oneOf([ - schema.literal('basic'), - schema.literal('standard'), - schema.literal('gold'), - schema.literal('platinum'), - schema.literal('enterprise'), - schema.literal('trial'), - ]), - supported_feature_ids: schema.arrayOf(schema.string()), - is_system_action_type: schema.boolean(), + id: schema.string({ + meta: { + description: 'The identifier for the connector.', + }, + }), + name: schema.string({ + meta: { + description: ' The name of the rule.', + }, + }), + enabled: schema.boolean({ + meta: { + description: 'Indicates whether the connector is enabled.', + }, + }), + enabled_in_config: schema.boolean({ + meta: { + description: 'Indicates whether the connector is enabled in the Kibana configuration.', + }, + }), + enabled_in_license: schema.boolean({ + meta: { + description: 'Indicates whether the connector is enabled through the license.', + }, + }), + minimum_license_required: schema.oneOf( + [ + schema.literal('basic'), + schema.literal('standard'), + schema.literal('gold'), + schema.literal('platinum'), + schema.literal('enterprise'), + schema.literal('trial'), + ], + { + meta: { + description: 'The minimum license required to enable the connector.', + }, + } + ), + supported_feature_ids: schema.arrayOf(schema.string(), { + meta: { + description: 'The minimum license required to enable the connector.', + }, + }), + is_system_action_type: schema.boolean({ + meta: { description: 'Indicates whether the action is a system action.' }, + }), }); 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 4519673a400fe7..686b54655c8927 100644 --- a/x-pack/plugins/actions/server/routes/connector/get/get.ts +++ b/x-pack/plugins/actions/server/routes/connector/get/get.ts @@ -10,6 +10,7 @@ import { getConnectorParamsSchemaV1, GetConnectorParamsV1, } from '../../../../common/routes/connector/apis/get'; +import { connectorResponseSchemaV1 } from '../../../../common/routes/connector/response'; import { transformGetConnectorResponseV1 } from './transforms'; import { ILicenseState } from '../../../lib'; import { BASE_ACTION_API_PATH } from '../../../../common'; @@ -34,6 +35,7 @@ export const getConnectorRoute = ( }, response: { 200: { + body: () => connectorResponseSchemaV1, description: 'Indicates a successful call.', }, }, diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts index f7e8b61707d70c..7c651fd67290cf 100644 --- a/x-pack/plugins/actions/server/routes/create.ts +++ b/x-pack/plugins/actions/server/routes/create.ts @@ -12,6 +12,7 @@ import { ILicenseState, validateEmptyStrings } from '../lib'; import { BASE_ACTION_API_PATH, RewriteRequestCase, RewriteResponseCase } from '../../common'; import { verifyAccessAndContext } from './verify_access_and_context'; import { CreateOptions } from '../actions_client'; +import { connectorResponseSchemaV1 } from '../../common/routes/connector/response'; export const bodySchema = schema.object({ name: schema.string({ @@ -68,7 +69,9 @@ export const createActionRoute = ( request: { params: schema.maybe( schema.object({ - id: schema.maybe(schema.string()), + id: schema.maybe( + schema.string({ meta: { description: 'An identifier for the connector.' } }) + ), }) ), body: bodySchema, @@ -76,6 +79,7 @@ export const createActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/execute.ts b/x-pack/plugins/actions/server/routes/execute.ts index 6f2ad11e20588f..74813a73474ac3 100644 --- a/x-pack/plugins/actions/server/routes/execute.ts +++ b/x-pack/plugins/actions/server/routes/execute.ts @@ -13,6 +13,7 @@ import { ActionTypeExecutorResult, ActionsRequestHandlerContext } from '../types import { BASE_ACTION_API_PATH, RewriteResponseCase } from '../../common'; import { asHttpRequestExecutionSource } from '../lib/action_execution_source'; import { verifyAccessAndContext } from './verify_access_and_context'; +import { connectorResponseSchemaV1 } from '../../common/routes/connector/response'; const paramSchema = schema.object({ id: schema.string({ @@ -56,6 +57,7 @@ export const executeActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/create.ts b/x-pack/plugins/actions/server/routes/legacy/create.ts index d668b1fbc19d20..6da0d25c2e59c5 100644 --- a/x-pack/plugins/actions/server/routes/legacy/create.ts +++ b/x-pack/plugins/actions/server/routes/legacy/create.ts @@ -13,6 +13,7 @@ import { ILicenseState } from '../../lib'; import { BASE_ACTION_API_PATH } from '../../../common'; import { verifyAccessAndContext } from '../verify_access_and_context'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; +import { connectorResponseSchemaV1 } from '../../../common/routes/connector/response'; export const bodySchema = schema.object({ name: schema.string({ @@ -46,6 +47,7 @@ export const createActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/execute.ts b/x-pack/plugins/actions/server/routes/legacy/execute.ts index 88e75aadb627cd..8083f884c11869 100644 --- a/x-pack/plugins/actions/server/routes/legacy/execute.ts +++ b/x-pack/plugins/actions/server/routes/legacy/execute.ts @@ -14,6 +14,7 @@ import { ActionTypeExecutorResult, ActionsRequestHandlerContext } from '../../ty import { BASE_ACTION_API_PATH } from '../../../common'; import { asHttpRequestExecutionSource } from '../../lib/action_execution_source'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; +import { connectorResponseSchemaV1 } from '../../../common/routes/connector/response'; const paramSchema = schema.object({ id: schema.string({ @@ -47,6 +48,7 @@ export const executeActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/get.ts b/x-pack/plugins/actions/server/routes/legacy/get.ts index 524b3522ed541f..2adf6413b9248b 100644 --- a/x-pack/plugins/actions/server/routes/legacy/get.ts +++ b/x-pack/plugins/actions/server/routes/legacy/get.ts @@ -12,6 +12,7 @@ import { ILicenseState, verifyApiAccess } from '../../lib'; import { BASE_ACTION_API_PATH } from '../../../common'; import { ActionsRequestHandlerContext } from '../../types'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; +import { connectorResponseSchemaV1 } from '../../../common/routes/connector/response'; const paramSchema = schema.object({ id: schema.string({ @@ -40,6 +41,7 @@ export const getActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/legacy/update.ts b/x-pack/plugins/actions/server/routes/legacy/update.ts index 5f234c8bf55a93..81106c2cdc73b8 100644 --- a/x-pack/plugins/actions/server/routes/legacy/update.ts +++ b/x-pack/plugins/actions/server/routes/legacy/update.ts @@ -12,6 +12,7 @@ import { ILicenseState, verifyApiAccess, isErrorThatHandlesItsOwnResponse } from import { BASE_ACTION_API_PATH } from '../../../common'; import { ActionsRequestHandlerContext } from '../../types'; import { trackLegacyRouteUsage } from '../../lib/track_legacy_route_usage'; +import { connectorResponseSchemaV1 } from '../../../common/routes/connector/response'; const paramSchema = schema.object({ id: schema.string({ @@ -47,6 +48,7 @@ export const updateActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, }, diff --git a/x-pack/plugins/actions/server/routes/update.ts b/x-pack/plugins/actions/server/routes/update.ts index efb4d036b1e480..8e1ffcb2b32307 100644 --- a/x-pack/plugins/actions/server/routes/update.ts +++ b/x-pack/plugins/actions/server/routes/update.ts @@ -11,6 +11,7 @@ import { ILicenseState, validateEmptyStrings } from '../lib'; import { BASE_ACTION_API_PATH, RewriteResponseCase } from '../../common'; import { ActionResult, ActionsRequestHandlerContext } from '../types'; import { verifyAccessAndContext } from './verify_access_and_context'; +import { connectorResponseSchemaV1 } from '../../common/routes/connector/response'; const paramSchema = schema.object({ id: schema.string({ @@ -67,6 +68,7 @@ export const updateActionRoute = ( response: { 200: { description: 'Indicates a successful call.', + body: () => connectorResponseSchemaV1, }, }, },