From 719d234034d97a1af37d5deb4614ba432940cfc3 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 15 Aug 2023 12:26:29 -0700 Subject: [PATCH 1/2] [OAS] Add is_system_action to connector responses --- .../plugins/actions/docs/openapi/bundled.json | 104 ++++++++++++++---- .../plugins/actions/docs/openapi/bundled.yaml | 58 +++++++++- .../create_index_connector_response.yaml | 3 +- .../examples/get_connector_response.yaml | 3 +- .../examples/get_connectors_response.yaml | 4 +- ...tor_response_properties_cases_webhook.yaml | 2 + .../connector_response_properties_email.yaml | 2 + .../connector_response_properties_genai.yaml | 2 + .../connector_response_properties_index.yaml | 2 + .../connector_response_properties_jira.yaml | 2 + ...onnector_response_properties_opsgenie.yaml | 2 + ...nnector_response_properties_pagerduty.yaml | 2 + ...nnector_response_properties_resilient.yaml | 2 + ...nnector_response_properties_serverlog.yaml | 2 + ...nector_response_properties_servicenow.yaml | 2 + ...r_response_properties_servicenow_itom.yaml | 2 + ...or_response_properties_servicenow_sir.yaml | 2 + ...nnector_response_properties_slack_api.yaml | 2 + ...tor_response_properties_slack_webhook.yaml | 2 + ...onnector_response_properties_swimlane.yaml | 2 + .../connector_response_properties_teams.yaml | 2 + .../connector_response_properties_tines.yaml | 2 + ...connector_response_properties_webhook.yaml | 2 + ...onnector_response_properties_xmatters.yaml | 2 + .../components/schemas/is_system_action.yaml | 3 + .../s@{spaceid}@api@actions@connectors.yaml | 2 + 26 files changed, 187 insertions(+), 28 deletions(-) create mode 100644 x-pack/plugins/actions/docs/openapi/components/schemas/is_system_action.yaml diff --git a/x-pack/plugins/actions/docs/openapi/bundled.json b/x-pack/plugins/actions/docs/openapi/bundled.json index 84f433970f1ba..27606af5b7d20 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.json +++ b/x-pack/plugins/actions/docs/openapi/bundled.json @@ -12,18 +12,26 @@ "url": "https://www.elastic.co/licensing/elastic-license" } }, - "tags": [ - { - "name": "connectors", - "description": "Connector APIs enable you to create and manage connectors." - } - ], "servers": [ { "url": "http://localhost:5601", "description": "local" } ], + "security": [ + { + "basicAuth": [] + }, + { + "apiKeyAuth": [] + } + ], + "tags": [ + { + "name": "connectors", + "description": "Connector APIs enable you to create and manage connectors." + } + ], "paths": { "/s/{spaceId}/api/actions/connector": { "post": { @@ -581,6 +589,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector.", @@ -2691,6 +2702,11 @@ "description": "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", + "description": "Indicates whether the connector is used for system actions.", + "example": false + }, "connector_response_properties_cases_webhook": { "title": "Connector request properties for a Webhook - Case Management connector", "type": "object", @@ -2726,6 +2742,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2767,6 +2786,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2808,6 +2830,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2849,6 +2874,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2890,6 +2918,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2931,6 +2962,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -2972,6 +3006,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3014,6 +3051,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3055,6 +3095,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3096,6 +3139,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3137,6 +3183,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3174,6 +3223,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3211,6 +3263,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3252,6 +3307,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3289,6 +3347,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3330,6 +3391,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3371,6 +3435,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -3412,6 +3479,9 @@ "is_preconfigured": { "$ref": "#/components/schemas/is_preconfigured" }, + "is_system_action": { + "$ref": "#/components/schemas/is_system_action" + }, "name": { "type": "string", "description": "The display name for the connector." @@ -4471,7 +4541,8 @@ }, "is_preconfigured": false, "is_deprecated": false, - "is_missing_secrets": false + "is_missing_secrets": false, + "is_system_action": false } }, "get_connector_response": { @@ -4483,7 +4554,8 @@ "connector_type_id": ".server-log", "is_preconfigured": false, "is_deprecated": false, - "is_missing_secrets": false + "is_missing_secrets": false, + "is_system_action": false } }, "update_index_connector_request": { @@ -4504,7 +4576,8 @@ "connector_type_id": ".email", "is_preconfigured": true, "is_deprecated": false, - "referenced_by_count": 0 + "referenced_by_count": 0, + "is_system_action": false }, { "id": "e07d0c80-8b8b-11ed-a780-3b746c987a81", @@ -4518,7 +4591,8 @@ "is_preconfigured": false, "is_deprecated": false, "referenced_by_count": 2, - "is_missing_secrets": false + "is_missing_secrets": false, + "is_system_action": false } ] }, @@ -4856,13 +4930,5 @@ } } } - }, - "security": [ - { - "basicAuth": [] - }, - { - "apiKeyAuth": [] - } - ] + } } \ 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 978233686d278..a784d60473b09 100644 --- a/x-pack/plugins/actions/docs/openapi/bundled.yaml +++ b/x-pack/plugins/actions/docs/openapi/bundled.yaml @@ -8,12 +8,15 @@ info: license: name: Elastic License 2.0 url: https://www.elastic.co/licensing/elastic-license -tags: - - name: connectors - description: Connector APIs enable you to create and manage connectors. servers: - url: http://localhost:5601 description: local +security: + - basicAuth: [] + - apiKeyAuth: [] +tags: + - name: connectors + description: Connector APIs enable you to create and manage connectors. paths: /s/{spaceId}/api/actions/connector: post: @@ -322,6 +325,8 @@ paths: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -1826,6 +1831,10 @@ 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. example: false + is_system_action: + type: boolean + description: Indicates whether the connector is used for system actions. + example: false connector_response_properties_cases_webhook: title: Connector request properties for a Webhook - Case Management connector type: object @@ -1853,6 +1862,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -1883,6 +1894,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -1913,6 +1926,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -1943,6 +1958,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -1973,6 +1990,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2003,6 +2022,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2033,6 +2054,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2064,6 +2087,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2094,6 +2119,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2124,6 +2151,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2154,6 +2183,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2181,6 +2212,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2208,6 +2241,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2238,6 +2273,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2265,6 +2302,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2295,6 +2334,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2325,6 +2366,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -2355,6 +2398,8 @@ components: $ref: '#/components/schemas/is_missing_secrets' is_preconfigured: $ref: '#/components/schemas/is_preconfigured' + is_system_action: + $ref: '#/components/schemas/is_system_action' name: type: string description: The display name for the connector. @@ -3102,6 +3147,7 @@ components: is_preconfigured: false is_deprecated: false is_missing_secrets: false + is_system_action: false get_connector_response: summary: A list of connector types value: @@ -3112,6 +3158,7 @@ components: is_preconfigured: false is_deprecated: false is_missing_secrets: false + is_system_action: false update_index_connector_request: summary: Update an index connector. value: @@ -3127,6 +3174,7 @@ components: 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: @@ -3138,6 +3186,7 @@ components: 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: @@ -3358,6 +3407,3 @@ components: application/json: schema: $ref: '#/components/schemas/action_response_properties' -security: - - basicAuth: [] - - apiKeyAuth: [] diff --git a/x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_response.yaml b/x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_response.yaml index 4d13a5d413598..3157b22a1f5a9 100644 --- a/x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_response.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_response.yaml @@ -9,4 +9,5 @@ value: executionTimeField: null is_preconfigured: false is_deprecated: false - is_missing_secrets: false \ No newline at end of file + is_missing_secrets: false + is_system_action: false \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml index 8db5cd741e859..6de6a030140e6 100644 --- a/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/examples/get_connector_response.yaml @@ -6,4 +6,5 @@ value: connector_type_id: .server-log is_preconfigured: false is_deprecated: false - is_missing_secrets: false \ No newline at end of file + is_missing_secrets: false + is_system_action: false \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/components/examples/get_connectors_response.yaml b/x-pack/plugins/actions/docs/openapi/components/examples/get_connectors_response.yaml index fda8c2823fc30..fb25be1d8ffc3 100644 --- a/x-pack/plugins/actions/docs/openapi/components/examples/get_connectors_response.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/examples/get_connectors_response.yaml @@ -6,6 +6,7 @@ value: 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: @@ -16,4 +17,5 @@ value: is_preconfigured: false is_deprecated: false referenced_by_count: 2 - is_missing_secrets: false \ No newline at end of file + is_missing_secrets: false + is_system_action: false \ No newline at end of file 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 88611b62b2c99..70e9a48910c80 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 @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml index 62dac0309889e..b84dff4f53106 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml index c84d307cb8d8a..17e748216639d 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_genai.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml index d78d609a09b9d..5e76416f25210 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml index 5ff5807e200a8..f61381af96396 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. 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 850454db1a3ad..f44f79f8e7013 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 @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml index 137108efd3e14..0002e684c2f5e 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. 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 9250c4157c660..fc2a239d29a4e 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 @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml index 999a8f375d117..bd41b62a114c7 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml @@ -25,6 +25,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml index a5f9d1afa0077..104e7174467a4 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml index 812d367cfb17c..5651629365bbd 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml index ff99f5682f129..4b24b3c0e7a62 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml index eab369907b5a5..76510f2511dd2 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_api.yaml @@ -21,6 +21,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml index 19ddc08fc125a..7b0de9d2c27ca 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack_webhook.yaml @@ -21,6 +21,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml index 421abcf666038..ea645598de5b7 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml index bafc86f2b2977..3d082bfdf7821 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml @@ -21,6 +21,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml index f89f85a30cd4f..1468becee8551 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml index 011c39abd7ae0..8d0dfdac5fbe6 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml index 6476adb1ab937..3f9e35eba8d6a 100644 --- a/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml @@ -24,6 +24,8 @@ properties: $ref: 'is_missing_secrets.yaml' is_preconfigured: $ref: 'is_preconfigured.yaml' + is_system_action: + $ref: 'is_system_action.yaml' name: type: string description: The display name for the connector. diff --git a/x-pack/plugins/actions/docs/openapi/components/schemas/is_system_action.yaml b/x-pack/plugins/actions/docs/openapi/components/schemas/is_system_action.yaml new file mode 100644 index 0000000000000..fd0dd06ef5fff --- /dev/null +++ b/x-pack/plugins/actions/docs/openapi/components/schemas/is_system_action.yaml @@ -0,0 +1,3 @@ +type: boolean +description: Indicates whether the connector is used for system actions. +example: false \ No newline at end of file diff --git a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml index 985865220ec09..caec98d7bf5e3 100644 --- a/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml +++ b/x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml @@ -43,6 +43,8 @@ get: $ref: '../components/schemas/is_missing_secrets.yaml' is_preconfigured: $ref: '../components/schemas/is_preconfigured.yaml' + is_system_action: + $ref: '../components/schemas/is_system_action.yaml' name: type: string description: The display name for the connector. From b3633282e6a6e6dd1a2dbda169164a42339bdc85 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 15 Aug 2023 12:30:04 -0700 Subject: [PATCH 2/2] [DOCS] Generate API previews --- .../connector-apis-passthru.asciidoc | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/api-generated/connectors/connector-apis-passthru.asciidoc b/docs/api-generated/connectors/connector-apis-passthru.asciidoc index bd28e90fdb006..a31c0c5fa963f 100644 --- a/docs/api-generated/connectors/connector-apis-passthru.asciidoc +++ b/docs/api-generated/connectors/connector-apis-passthru.asciidoc @@ -368,6 +368,7 @@ Any modifications made to this file will be overwritten. "is_deprecated" : false, "is_preconfigured" : false, "name" : "my-connector", + "is_system_action" : false, "referenced_by_count" : 2, "id" : "b0766e10-d190-11ec-b04c-776c77d14fca", "config" : { @@ -1204,6 +1205,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
referenced_by_count
Integer Indicates the number of saved objects that reference the connector. If is_preconfigured is true, this value is not calculated.
@@ -1460,6 +1462,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1475,6 +1478,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1490,6 +1494,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1505,6 +1510,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1520,6 +1526,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1535,6 +1542,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1550,6 +1558,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1565,6 +1574,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1580,6 +1590,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1595,6 +1606,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1610,6 +1622,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1625,6 +1638,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1639,6 +1653,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1653,6 +1668,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1668,6 +1684,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1682,6 +1699,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1697,6 +1715,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1712,6 +1731,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.
@@ -1727,6 +1747,7 @@ Any modifications made to this file will be overwritten.
is_deprecated
Boolean Indicates whether the connector type is deprecated.
is_missing_secrets (optional)
Boolean Indicates whether secrets are missing for the connector. Secrets configuration properties vary depending on the connector type.
is_preconfigured
Boolean Indicates whether it is a preconfigured connector. If true, the config and is_missing_secrets properties are omitted from the response.
+
is_system_action (optional)
Boolean Indicates whether the connector is used for system actions.
name
String The display name for the connector.