github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 17:28:26 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Create open API specification for create/update connector (#148691)

Browse source
This commit is contained in:
Lisa Cawley 2023-01-17 09:31:48 -08:00 • committed by GitHub
parent 1ca5cf9294
commit 4f6d0dff28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
92 changed files with 7554 additions and 199 deletions
Download patch file Download diff file Expand all files Collapse all files

1114
docs/api-generated/connectors/connector-apis-passthru.asciidoc
View file

File diff suppressed because it is too large Load diff

24
docs/api/actions-and-connectors/create.asciidoc
View file

@ -6,6 +6,12 @@
Creates a connector.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
====
[[create-connector-api-request]]
=== {api-request-title}
@ -121,9 +127,9 @@ the selected user field is `Email`, the user identifier should be the user's
email address. This property is required when `isOAuth` is `true`.
`usesTableApi`::
(Optional, string) Determines whether the connector uses the Table API or the
(Optional, boolean) Determines whether the connector uses the Table API or the
Import Set API. This property is supported only for {sn-itsm} and {sn-sir}
connectors.
connectors. The default value is `true`.
+
NOTE: If this property is set to false, the Elastic application should be
installed in {sn}.
@ -152,7 +158,7 @@ installed in {sn}.
(Optional, object) Mapping for the alert ID.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -167,7 +173,7 @@ installed in {sn}.
(Optional, object) Mapping for the case ID.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -182,7 +188,7 @@ installed in {sn}.
(Optional, object) Mapping for the case name.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -197,7 +203,7 @@ installed in {sn}.
(Optional, object) Mapping for the case comments.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -212,7 +218,7 @@ installed in {sn}.
(Optional, object) Mapping for the case description.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -227,7 +233,7 @@ installed in {sn}.
(Optional, object) Mapping for the name of the alert's rule.
`fieldType`::::
(Required, Object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.
@ -242,7 +248,7 @@ installed in {sn}.
(Optional, object) Mapping for the severity.
`fieldType`::::
(Required, object) The type of the field in {swimlane}.
(Required, string) The type of the field in {swimlane}.
`id`::::
(Required, string) The id of the field in {swimlane}.

6
docs/api/actions-and-connectors/update.asciidoc
View file

@ -6,6 +6,12 @@
Updates the attributes for a connector.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/x-pack/plugins/actions/docs/openapi[open API specification]. For a preview, check out <<connector-apis>>.
====
[[update-connector-api-request]]
=== {api-request-title}

2710
x-pack/plugins/actions/docs/openapi/bundled.json
View file

File diff suppressed because it is too large Load diff

1955
x-pack/plugins/actions/docs/openapi/bundled.yaml
View file

File diff suppressed because it is too large Load diff

6
x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_request.yaml Normal file
View file

@ -0,0 +1,6 @@
summary: Create an index connector.
value:
name: my-connector
connector_type_id: .index
config:
index: test-index

12
x-pack/plugins/actions/docs/openapi/components/examples/create_index_connector_response.yaml Normal file
View file

@ -0,0 +1,12 @@
summary: A new index connector.
value:
id: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad
connector_type_id: .index
name: my-connector
config:
index: test-index
refresh: false
executionTimeField: null
is_preconfigured: false
is_deprecated: false
is_missing_secrets: false

5
x-pack/plugins/actions/docs/openapi/components/examples/update_index_connector_request.yaml Normal file
View file

@ -0,0 +1,5 @@
summary: Update an index connector.
value:
name: updated-connector
config:
index: updated-index

135
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_cases_webhook.yaml Normal file
View file

@ -0,0 +1,135 @@
title: Connector request properties for Webhook - Case Management connector
required:
- createIncidentJson
- createIncidentResponseKey
- createIncidentUrl
- getIncidentResponseExternalTitleKey
- getIncidentUrl
- updateIncidentJson
- updateIncidentUrl
- viewIncidentUrl
description: Defines properties for connectors when type is `.cases-webhook`.
type: object
properties:
createCommentJson:
type: string
description: >
A JSON payload sent to the create comment URL to create a case comment.
You can use variables to add Kibana Cases data to the payload.
The required variable is `case.comment`. Due to Mustache template
variables (the text enclosed in triple braces, for example,
`{{{case.title}}}`), the JSON is not validated when you create the
connector. The JSON is validated once the Mustache variables have been
placed when the REST method runs. Manually ensure that the JSON is valid,
disregarding the Mustache variables, so the later validation will pass.
example: {"body": {{{case.comment}}}}
createCommentMethod:
type: string
description: >
The REST API HTTP request method to create a case comment in the
third-party system. Valid values are `patch`, `post`, and `put`.
default: put
enum:
- patch
- post
- put
createCommentUrl:
type: string
description: >
The REST API URL to create a case comment by ID in the third-party system.
You can use a variable to add the external system ID to the URL. If you
are using the `xpack.actions.allowedHosts setting`, add the hostname to
the allowed hosts.
example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}/comment
createIncidentJson:
type: string
description: >
A JSON payload sent to the create case URL to create a case. You can use
variables to add case data to the payload. Required variables are
`case.title` and `case.description`. Due to Mustache template variables
(which is the text enclosed in triple braces, for example,
`{{{case.title}}}`), the JSON is not validated when you create the
connector. The JSON is validated after the Mustache variables have been
placed when REST method runs. Manually ensure that the JSON is valid to
avoid future validation errors; disregard Mustache variables during your review.
example: {"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}
createIncidentMethod:
type: string
description: >
The REST API HTTP request method to create a case in the third-party
system. Valid values are `patch`, `post`, and `put`.
enum:
- patch
- post
- put
default: post
createIncidentResponseKey:
type: string
description: The JSON key in the create case response that contains the external case ID.
createIncidentUrl:
type: string
description: >
The REST API URL to create a case in the third-party system. If you are
using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
getIncidentResponseExternalTitleKey:
type: string
description: The JSON key in get case response that contains the external case title.
getIncidentUrl:
type: string
description: >
The REST API URL to get the case by ID from the third-party system. If you
are using the `xpack.actions.allowedHosts` setting, add the hostname to
the allowed hosts. You can use a variable to add the external system ID to
the URL. Due to Mustache template variables (the text enclosed in triple
braces, for example, `{{{case.title}}}`), the JSON is not validated when
you create the connector. The JSON is validated after the Mustache
variables have been placed when REST method runs. Manually ensure that the
JSON is valid, disregarding the Mustache variables, so the later
validation will pass.
example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.id}}}
hasAuth:
type: boolean
description: If true, a username and password for login type authentication must be provided.
default: true
headers:
type: string
description: >
A set of key-value pairs sent as headers with the request URLs for the
create case, update case, get case, and create comment methods.
updateIncidentJson:
type: string
description: >
The JSON payload sent to the update case URL to update the case. You can
use variables to add Kibana Cases data to the payload. Required variables
are `case.title` and `case.description`. Due to Mustache template
variables (which is the text enclosed in triple braces, for example,
`{{{case.title}}}`), the JSON is not validated when you create the
connector. The JSON is validated after the Mustache variables have been
placed when REST method runs. Manually ensure that the JSON is valid to
avoid future validation errors; disregard Mustache variables during your review.
example: {"fields": {"summary": {{{case.title}}},"description": {{{case.description}}},"labels": {{{case.tags}}}}}
updateIncidentMethod:
type: string
description: >
The REST API HTTP request method to update the case in the third-party
system. Valid values are `patch`, `post`, and `put`.
default: put
enum:
- patch
- post
- put
updateIncidentUrl:
type: string
description: >
The REST API URL to update the case by ID in the third-party system. You
can use a variable to add the external system ID to the URL. If you are
using the `xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
example: https://testing-jira.atlassian.net/rest/api/2/issue/{{{external.system.ID}}}
viewIncidentUrl:
type: string
description: >
The URL to view the case in the external system. You can use variables to
add the external system ID or external system title to the URL.
example: https://testing-jira.atlassian.net/browse/{{{external.system.title}}}

5
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_email.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector request properties for an email connector
description: Defines properties for connectors when type is `.email`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

21
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_index.yaml Normal file
View file

@ -0,0 +1,21 @@
title: Connector request properties for an index connector
required:
- index
description: Defines properties for connectors when type is `.index`.
type: object
properties:
executionTimeField:
description: Specifies a field that will contain the time the alert condition was detected.
default: null
type: string
nullable: true
index:
description: The Elasticsearch index to be written to.
type: string
refresh:
description: >
The refresh policy for the write request, which affects when changes are
made visible to search. Refer to the refresh setting for Elasticsearch
document APIs.
default: false
type: boolean

13
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_jira.yaml Normal file
View file

@ -0,0 +1,13 @@
title: Connector request properties for a Jira connector
required:
- apiUrl
- projectKey
description: Defines properties for connectors when type is `.jira`.
type: object
properties:
apiUrl:
description: The Jira instance URL.
type: string
projectKey:
description: The Jira project key.
type: string

12
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_opsgenie.yaml Normal file
View file

@ -0,0 +1,12 @@
title: Connector request properties for an Opsgenie connector
required:
- apiUrl
description: Defines properties for connectors when type is `.opsgenie`.
type: object
properties:
apiUrl:
description: >
The Opsgenie URL. For example, `https://api.opsgenie.com` or
`https://api.eu.opsgenie.com`. If you are using the
`xpack.actions.allowedHosts` setting, add the hostname to the allowed hosts.
type: string

5
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_pagerduty.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector request properties for a PagerDuty connector
description: Defines properties for connectors when type is `.pagerduty`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

13
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_resilient.yaml Normal file
View file

@ -0,0 +1,13 @@
title: Connector request properties for a IBM Resilient connector
required:
- apiUrl
- orgId
description: Defines properties for connectors when type is `.resilient`.
type: object
properties:
apiUrl:
description: The IBM Resilient instance URL.
type: string
orgId:
description: The IBM Resilient organization ID.
type: string

41
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_servicenow.yaml Normal file
View file

@ -0,0 +1,41 @@
title: Connector request properties for a ServiceNow ITSM connector
required:
- apiUrl
description: Defines properties for connectors when type is `.servicenow`.
type: object
properties:
apiUrl:
type: string
description: The ServiceNow instance URL.
clientId:
description: >
The client ID assigned to your OAuth application.
This property is required when `isOAuth` is `true`.
type: string
isOAuth:
description: >
The type of authentication to use. The default value is false, which means
basic authentication is used instead of open authorization (OAuth).
default: false
type: string
jwtKeyId:
description: >
The key identifier assigned to the JWT verifier map of your OAuth application.
This property is required when `isOAuth` is `true`.
type: string
userIdentifierValue:
description: >
The identifier to use for OAuth authentication. This identifier should be
the user field you selected when you created an OAuth JWT API endpoint for
external clients in your ServiceNow instance. For example, if the selected
user field is `Email`, the user identifier should be the user's email
address. This property is required when `isOAuth` is `true`.
type: string
usesTableApi:
description: >
Determines whether the connector uses the Table API or the Import Set API.
This property is supported only for ServiceNow ITSM and ServiceNow SecOps
connectors. NOTE: If this property is set to `false`, the Elastic
application should be installed in ServiceNow.
default: true
type: boolean

33
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_servicenow_itom.yaml Normal file
View file

@ -0,0 +1,33 @@
title: Connector request properties for a ServiceNow ITSM connector
required:
- apiUrl
description: Defines properties for connectors when type is `.servicenow`.
type: object
properties:
apiUrl:
type: string
description: The ServiceNow instance URL.
clientId:
description: >
The client ID assigned to your OAuth application.
This property is required when `isOAuth` is `true`.
type: string
isOAuth:
description: >
The type of authentication to use. The default value is false, which means
basic authentication is used instead of open authorization (OAuth).
default: false
type: string
jwtKeyId:
description: >
The key identifier assigned to the JWT verifier map of your OAuth application.
This property is required when `isOAuth` is `true`.
type: string
userIdentifierValue:
description: >
The identifier to use for OAuth authentication. This identifier should be
the user field you selected when you created an OAuth JWT API endpoint for
external clients in your ServiceNow instance. For example, if the selected
user field is `Email`, the user identifier should be the user's email
address. This property is required when `isOAuth` is `true`.
type: string

103
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_swimlane.yaml Normal file
View file

@ -0,0 +1,103 @@
title: Connector request properties for a Swimlane connector
required:
- apiUrl
- appId
- connectorType
description: Defines properties for connectors when type is `.swimlane`.
type: object
properties:
apiUrl:
description: The Swimlane instance URL.
type: string
appId:
description: The Swimlane application ID.
type: string
connectorType:
description: The type of connector. Valid values are `all`, `alerts`, and `cases`.
type: string
enum:
- all
- alerts
- cases
mappings:
title: Connector mappings properties for a Swimlane connector
description: The field mapping.
type: object
properties:
alertIdConfig:
title: Alert identifier mapping
description: Mapping for the alert ID.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
caseIdConfig:
title: Case identifier mapping
description: Mapping for the case ID.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
caseNameConfig:
title: Case name mapping
description: Mapping for the case name.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
commentsConfig:
title: Case comment mapping
description: Mapping for the case comments.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
descriptionConfig:
title: Case description mapping
description: Mapping for the case description.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
ruleNameConfig:
title: Rule name mapping
description: Mapping for the name of the alert's rule.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'
severityConfig:
title: Severity mapping
description: Mapping for the severity.
type: object
required:
- fieldType
- id
- key
- name
properties:
$ref: 'mapping_properties_swimlane.yaml'

5
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_tines.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector request properties for a Tines connector
description: Defines properties for connectors when type is `.tines`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

5
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_webhook.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector request properties for a Webhook connector
description: Defines properties for connectors when type is `.webhook`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

5
x-pack/plugins/actions/docs/openapi/components/schemas/config_properties_xmatters.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector request properties for a xMatters connector
description: Defines properties for connectors when type is `.xmatters`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

22
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties.yaml Normal file
View file

@ -0,0 +1,22 @@
title: Connector response properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: 'connector_response_properties_cases_webhook.yaml'
- $ref: 'connector_response_properties_email.yaml'
- $ref: 'connector_response_properties_index.yaml'
- $ref: 'connector_response_properties_jira.yaml'
- $ref: 'connector_response_properties_opsgenie.yaml'
- $ref: 'connector_response_properties_pagerduty.yaml'
- $ref: 'connector_response_properties_resilient.yaml'
- $ref: 'connector_response_properties_serverlog.yaml'
- $ref: 'connector_response_properties_servicenow.yaml'
- $ref: 'connector_response_properties_servicenow_itom.yaml'
- $ref: 'connector_response_properties_servicenow_sir.yaml'
- $ref: 'connector_response_properties_slack.yaml'
- $ref: 'connector_response_properties_swimlane.yaml'
- $ref: 'connector_response_properties_teams.yaml'
- $ref: 'connector_response_properties_tines.yaml'
- $ref: 'connector_response_properties_webhook.yaml'
- $ref: 'connector_response_properties_xmatters.yaml'
discriminator:
propertyName: connector_type_id

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_cases_webhook.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector request properties for a Webhook - Case Management connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_cases_webhook.yaml'
connector_type_id:
description: The type of connector.
type: string
enum:
- .cases-webhook
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_email.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for an email connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_email.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .email
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_index.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for an index connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_index.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .index
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_jira.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a Jira connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_jira.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .jira
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_opsgenie.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for an Opsgenie connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_opsgenie.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .opsgenie
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_pagerduty.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a PagerDuty connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_pagerduty.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .pagerduty
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_resilient.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a IBM Resilient connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_resilient.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .resilient
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

30
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_serverlog.yaml Normal file
View file

@ -0,0 +1,30 @@
title: Connector response properties for a server log connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
type: object
nullable: true
connector_type_id:
type: string
description: The type of connector.
enum:
- .server-log
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a ServiceNow ITSM connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_servicenow.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_itom.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a ServiceNow ITOM connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_servicenow_itom.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow-itom
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_servicenow_sir.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a ServiceNow SecOps connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_servicenow.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow-sir
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

26
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_slack.yaml Normal file
View file

@ -0,0 +1,26 @@
title: Connector response properties for a Slack connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
connector_type_id:
type: string
description: The type of connector.
enum:
- .slack
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_swimlane.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a Swimlane connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_swimlane.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .swimlane
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

26
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_teams.yaml Normal file
View file

@ -0,0 +1,26 @@
title: Connector response properties for a Microsoft Teams connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
connector_type_id:
type: string
description: The type of connector.
enum:
- .teams
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_tines.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a Tines connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_tines.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .tines
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_webhook.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for a Webhook connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_webhook.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .webhook
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

29
x-pack/plugins/actions/docs/openapi/components/schemas/connector_response_properties_xmatters.yaml Normal file
View file

@ -0,0 +1,29 @@
title: Connector response properties for an xMatters connector
type: object
required:
- config
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_xmatters.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .xmatters
id:
type: string
description: The identifier for the connector.
is_deprecated:
$ref: 'is_deprecated.yaml'
is_missing_secrets:
$ref: 'is_missing_secrets.yaml'
is_preconfigured:
$ref: 'is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.

1
x-pack/plugins/actions/docs/openapi/components/schemas/connector_types.yaml
View file

@ -1,3 +1,4 @@
title: Connector types
type: string
description: The type of connector. For example, `.email`, `.index`, `.jira`, `.opsgenie`, or `.server-log`.
enum:

24
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_cases_webhook.yaml Normal file
View file

@ -0,0 +1,24 @@
title: Create Webhook - Case Managment connector request
description: >
The Webhook - Case Management connector uses axios to send POST, PUT, and GET
requests to a case management RESTful API web service.
type: object
required:
- config
- connector_type_id
- name
properties:
config:
$ref: 'config_properties_cases_webhook.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .cases-webhook
example: .cases-webhook
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_cases_webhook.yaml'

27
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_email.yaml Normal file
View file

@ -0,0 +1,27 @@
title: Create email connector request
description: >
The email connector uses the SMTP protocol to send mail messages, using an
integration of Nodemailer. An exception is Microsoft Exchange, which uses
HTTP protocol for sending emails, Send mail. Email message text is sent as
both plain text and html text.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_email.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .email
example: .email
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_email.yaml'

20
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_index.yaml Normal file
View file

@ -0,0 +1,20 @@
title: Create index connector request
description: The index connector indexes a document into Elasticsearch.
type: object
required:
- config
- connector_type_id
- name
properties:
config:
$ref: 'config_properties_index.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .index
example: .index
name:
type: string
description: The display name for the connector.
example: my-connector

23
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_jira.yaml Normal file
View file

@ -0,0 +1,23 @@
title: Create Jira connector request
description: The Jira connector uses the REST API v2 to create Jira issues.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_jira.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .jira
example: .jira
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_jira.yaml'

23
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_opsgenie.yaml Normal file
View file

@ -0,0 +1,23 @@
title: Create Opsgenie connector request
description: The Opsgenie connector uses the Opsgenie alert API.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_opsgenie.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .opsgenie
example: .opsgenie
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_opsgenie.yaml'

25
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_pagerduty.yaml Normal file
View file

@ -0,0 +1,25 @@
title: Create PagerDuty connector request
description: >
The PagerDuty connector uses the v2 Events API to trigger, acknowledge, and
resolve PagerDuty alerts.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_pagerduty.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .pagerduty
example: .pagerduty
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_pagerduty.yaml'

23
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_resilient.yaml Normal file
View file

@ -0,0 +1,23 @@
title: Create IBM Resilient connector request
description: The IBM Resilient connector uses the RESILIENT REST v2 to create IBM Resilient incidents.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_resilient.yaml'
connector_type_id:
description: The type of connector.
type: string
example: .resilient
enum:
- .resilient
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_resilient.yaml'

17
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_serverlog.yaml Normal file
View file

@ -0,0 +1,17 @@
title: Create server log connector request
description: This connector writes an entry to the Kibana server log.
type: object
required:
- connector_type_id
- name
properties:
connector_type_id:
type: string
description: The type of connector.
enum:
- .server-log
example: .server-log
name:
type: string
description: The display name for the connector.
example: my-connector

25
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_servicenow.yaml Normal file
View file

@ -0,0 +1,25 @@
title: Create ServiceNow ITSM connector request
description: >
The ServiceNow ITSM connector uses the import set API to create ServiceNow incidents.
You can use the connector for rule actions and cases.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_servicenow.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow
example: .servicenow
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_servicenow.yaml'

25
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_servicenow_itom.yaml Normal file
View file

@ -0,0 +1,25 @@
title: Create ServiceNow ITOM connector request
description: >
The ServiceNow ITOM connector uses the event API to create ServiceNow events.
You can use the connector for rule actions.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_servicenow_itom.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow-itom
example: .servicenow-itom
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_servicenow.yaml'

25
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_servicenow_sir.yaml Normal file
View file

@ -0,0 +1,25 @@
title: Create ServiceNow SecOps connector request
description: >
The ServiceNow SecOps connector uses the import set API to create ServiceNow security incidents.
You can use the connector for rule actions and cases.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_servicenow.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .servicenow-sir
example: .servicenow-sir
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_servicenow.yaml'

20
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_slack.yaml Normal file
View file

@ -0,0 +1,20 @@
title: Create Slack connector request
description: The Slack connector uses Slack Incoming Webhooks.
type: object
required:
- connector_type_id
- name
- secrets
properties:
connector_type_id:
type: string
description: The type of connector.
enum:
- .slack
example: .slack
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_slack.yaml'

23
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_swimlane.yaml Normal file
View file

@ -0,0 +1,23 @@
title: Create Swimlane connector request
description: The Swimlane connector uses the Swimlane REST API to create Swimlane records.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_swimlane.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .swimlane
example: .swimlane
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_swimlane.yaml'

20
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_teams.yaml Normal file
View file

@ -0,0 +1,20 @@
title: Create Microsoft Teams connector request
description: The Microsoft Teams connector uses Incoming Webhooks.
type: object
required:
- connector_type_id
- name
- secrets
properties:
connector_type_id:
type: string
description: The type of connector.
enum:
- .teams
example: .teams
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_teams.yaml'

24
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_tines.yaml Normal file
View file

@ -0,0 +1,24 @@
title: Create Tines connector request
description: >
The Tines connector uses Tines Webhook actions to send events via POST request.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_tines.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .tines
example: .tines
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_tines.yaml'

24
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_webhook.yaml Normal file
View file

@ -0,0 +1,24 @@
title: Create Webhook connector request
description: >
The Webhook connector uses axios to send a POST or PUT request to a web service.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_webhook.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .webhook
example: .webhook
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_webhook.yaml'

25
x-pack/plugins/actions/docs/openapi/components/schemas/create_connector_request_xmatters.yaml Normal file
View file

@ -0,0 +1,25 @@
title: Create xMatters connector request
description: >
The xMatters connector uses the xMatters Workflow for Elastic to send
actionable alerts to on-call xMatters resources.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_xmatters.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .xmatters
example: .xmatters
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_xmatters.yaml'

13
x-pack/plugins/actions/docs/openapi/components/schemas/mapping_properties_swimlane.yaml Normal file
View file

@ -0,0 +1,13 @@
fieldType:
type: string
description: The type of field in Swimlane.
id:
type: string
description: The identifier for the field in Swimlane.
key:
type: string
description: The key for the field in Swimlane.
name:
type: string
description: The name of the field in Swimlane.

9
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_cases_webhook.yaml Normal file
View file

@ -0,0 +1,9 @@
title: Connector secrets properties for Webhook - Case Management connector
type: object
properties:
password:
type: string
description: The password for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.
user:
type: string
description: The username for HTTP basic authentication. If `hasAuth` is set to `true`, this property is required.

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_email.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for an email connector
description: Defines secrets for connectors when type is `.email`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

13
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_jira.yaml Normal file
View file

@ -0,0 +1,13 @@
title: Connector secrets properties for a Jira connector
required:
- apiToken
- email
description: Defines secrets for connectors when type is `.jira`.
type: object
properties:
apiToken:
description: The Jira API authentication token for HTTP basic authentication.
type: string
email:
description: The account email for HTTP Basic authentication.
type: string

9
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_opsgenie.yaml Normal file
View file

@ -0,0 +1,9 @@
title: Connector secrets properties for an Opsgenie connector
required:
- apiKey
description: Defines secrets for connectors when type is `.opsgenie`.
type: object
properties:
apiKey:
description: The Opsgenie API authentication key for HTTP Basic authentication.
type: string

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_pagerduty.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for a PagerDuty connector
description: Defines secrets for connectors when type is `.pagerduty`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

13
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_resilient.yaml Normal file
View file

@ -0,0 +1,13 @@
title: Connector secrets properties for IBM Resilient connector
required:
- apiKeyId
- apiKeySecret
description: Defines secrets for connectors when type is `.resilient`.
type: object
properties:
apiKeyId:
type: string
description: The authentication key ID for HTTP Basic authentication.
apiKeySecret:
type: string
description: The authentication key secret for HTTP Basic authentication.

19
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_servicenow.yaml Normal file
View file

@ -0,0 +1,19 @@
title: Connector secrets properties for ServiceNow ITOM, ServiceNow ITSM, and ServiceNow SecOps connectors
description: Defines secrets for connectors when type is `.servicenow`, `.servicenow-sir`, or `.servicenow-itom`.
type: object
properties:
clientSecret:
type: string
description: The client secret assigned to your OAuth application. This property is required when `isOAuth` is `true`.
password:
type: string
description: The password for HTTP basic authentication. This property is required when `isOAuth` is `false`.
privateKey:
type: string
description: The RSA private key that you created for use in ServiceNow. This property is required when `isOAuth` is `true`.
privateKeyPassword:
type: string
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`.

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_slack.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for a Slack connector
description: Defines secrets for connectors when type is `.slack`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

7
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_swimlane.yaml Normal file
View file

@ -0,0 +1,7 @@
title: Connector secrets properties for a Swimlane connector
description: Defines secrets for connectors when type is `.swimlane`.
type: object
properties:
apiToken:
description: Swimlane API authentication token.
type: string

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_teams.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for a Microsoft Teams connector
description: Defines secrets for connectors when type is `.teams`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_tines.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for a Tines connector
description: Defines secrets for connectors when type is `.tines`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_webhook.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for a Webhook connector
description: Defines secrets for connectors when type is `.webhook`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

5
x-pack/plugins/actions/docs/openapi/components/schemas/secrets_properties_xmatters.yaml Normal file
View file

@ -0,0 +1,5 @@
title: Connector secrets properties for an xMatters connector
description: Defines secrets for connectors when type is `.xmatters`.
type: object
additionalProperties: true
# TO-DO: Add the properties for this connector.

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_cases_webhook.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update Webhook - Case Managment connector request
type: object
required:
- config
- name
properties:
config:
$ref: 'config_properties_cases_webhook.yaml'
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_cases_webhook.yaml'

13
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_email.yaml Normal file
View file

@ -0,0 +1,13 @@
title: Update email connector request
type: object
required:
- config
- name
properties:
config:
$ref: 'config_properties_email.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_email.yaml'

11
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_index.yaml Normal file
View file

@ -0,0 +1,11 @@
title: Update index connector request
type: object
required:
- config
- name
properties:
config:
$ref: 'config_properties_index.yaml'
name:
type: string
description: The display name for the connector.

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_jira.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update Jira connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_jira.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_jira.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_opsgenie.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update Opsgenie connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_opsgenie.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_opsgenie.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_pagerduty.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update PagerDuty connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_pagerduty.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_pagerduty.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_resilient.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update IBM Resilient connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_resilient.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_resilient.yaml'

8
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_serverlog.yaml Normal file
View file

@ -0,0 +1,8 @@
title: Update server log connector request
type: object
required:
- name
properties:
name:
type: string
description: The display name for the connector.

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_servicenow.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update ServiceNow ITSM connector or ServiceNow SecOps request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_servicenow.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_servicenow.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_servicenow_itom.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Create ServiceNow ITOM connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_servicenow_itom.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_servicenow.yaml'

11
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_slack.yaml Normal file
View file

@ -0,0 +1,11 @@
title: Update Slack connector request
type: object
required:
- name
- secrets
properties:
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_slack.yaml'

15
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_swimlane.yaml Normal file
View file

@ -0,0 +1,15 @@
title: Update Swimlane connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_swimlane.yaml'
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_swimlane.yaml'

11
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_teams.yaml Normal file
View file

@ -0,0 +1,11 @@
title: Update Microsoft Teams connector request
type: object
required:
- name
- secrets
properties:
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_teams.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_tines.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update Tines connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_tines.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_tines.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_webhook.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update Webhook connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_webhook.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_webhook.yaml'

14
x-pack/plugins/actions/docs/openapi/components/schemas/update_connector_request_xmatters.yaml Normal file
View file

@ -0,0 +1,14 @@
title: Update xMatters connector request
type: object
required:
- config
- name
- secrets
properties:
config:
$ref: 'config_properties_xmatters.yaml'
name:
type: string
description: The display name for the connector.
secrets:
$ref: 'secrets_properties_xmatters.yaml'

4
x-pack/plugins/actions/docs/openapi/entrypoint.yaml
View file

@ -15,8 +15,8 @@ servers:
- url: 'http://localhost:5601'
description: local
paths:
# '/s/{spaceId}/api/actions/connector':
# $ref: 'paths/s@{spaceid}@api@actions@connector.yaml'
'/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':

69
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector.yaml Normal file
View file

@ -0,0 +1,69 @@
post:
summary: Creates a connector.
operationId: createConnector
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/headers/kbn_xsrf.yaml
- $ref: '../components/parameters/space_id.yaml'
requestBody:
required: true
content:
application/json:
schema:
title: Create connector request body properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: '../components/schemas/create_connector_request_cases_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_email.yaml'
- $ref: '../components/schemas/create_connector_request_index.yaml'
- $ref: '../components/schemas/create_connector_request_jira.yaml'
- $ref: '../components/schemas/create_connector_request_opsgenie.yaml'
- $ref: '../components/schemas/create_connector_request_pagerduty.yaml'
- $ref: '../components/schemas/create_connector_request_resilient.yaml'
- $ref: '../components/schemas/create_connector_request_serverlog.yaml'
- $ref: '../components/schemas/create_connector_request_servicenow.yaml'
- $ref: '../components/schemas/create_connector_request_servicenow_itom.yaml'
- $ref: '../components/schemas/create_connector_request_servicenow_sir.yaml'
- $ref: '../components/schemas/create_connector_request_slack.yaml'
- $ref: '../components/schemas/create_connector_request_swimlane.yaml'
- $ref: '../components/schemas/create_connector_request_teams.yaml'
- $ref: '../components/schemas/create_connector_request_tines.yaml'
- $ref: '../components/schemas/create_connector_request_webhook.yaml'
- $ref: '../components/schemas/create_connector_request_xmatters.yaml'
discriminator:
propertyName: connector_type_id
examples:
createIndexConnectorRequest:
$ref: '../components/examples/create_index_connector_request.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/connector_response_properties.yaml'
examples:
createIndexConnectorResponse:
$ref: '../components/examples/create_index_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

187
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector@{connectorid}.yaml
View file

@ -14,38 +14,41 @@ get:
content:
application/json:
schema:
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
type: object
description: The configuration for the connector. Configuration properties vary depending on the connector type.
additionalProperties: true
nullable: true
connector_type_id:
$ref: '../components/schemas/connector_types.yaml'
id:
type: string
description: The identifier for the connector.
example: b0766e10-d190-11ec-b04c-776c77d14fca
is_deprecated:
$ref: '../components/schemas/is_deprecated.yaml'
is_missing_secrets:
$ref: '../components/schemas/is_missing_secrets.yaml'
is_preconfigured:
$ref: '../components/schemas/is_preconfigured.yaml'
name:
type: string
description: The display name for the connector.
example: my-connector
$ref: '../components/schemas/connector_response_properties.yaml'
examples:
getConnectorResponse:
$ref: '../components/examples/get_connector_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
'404':
description: Object is not found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
servers:
- url: https://localhost:5601
@ -64,6 +67,132 @@ delete:
responses:
'204':
description: Indicates a successful call.
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
'404':
description: Object is not found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
servers:
- url: https://localhost:5601
put:
summary: Updates the attributes for a connector.
operationId: updateConnector
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/headers/kbn_xsrf.yaml
- $ref: '../components/parameters/connector_id.yaml'
- $ref: '../components/parameters/space_id.yaml'
requestBody:
required: true
content:
application/json:
schema:
title: Update connector request body properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: '../components/schemas/update_connector_request_cases_webhook.yaml'
# - $ref: '../components/schemas/update_connector_request_email.yaml'
- $ref: '../components/schemas/update_connector_request_index.yaml'
- $ref: '../components/schemas/update_connector_request_jira.yaml'
- $ref: '../components/schemas/update_connector_request_opsgenie.yaml'
# - $ref: '../components/schemas/update_connector_request_pagerduty.yaml'
- $ref: '../components/schemas/update_connector_request_resilient.yaml'
- $ref: '../components/schemas/update_connector_request_serverlog.yaml'
- $ref: '../components/schemas/update_connector_request_servicenow.yaml'
- $ref: '../components/schemas/update_connector_request_servicenow_itom.yaml'
# - $ref: '../components/schemas/update_connector_request_slack.yaml'
- $ref: '../components/schemas/update_connector_request_swimlane.yaml'
# - $ref: '../components/schemas/update_connector_request_teams.yaml'
# - $ref: '../components/schemas/update_connector_request_tines.yaml'
# - $ref: '../components/schemas/update_connector_request_webhook.yaml'
# - $ref: '../components/schemas/update_connector_request_xmatters.yaml'
examples:
updateIndexConnectorRequest:
$ref: '../components/examples/update_index_connector_request.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../components/schemas/connector_response_properties.yaml'
'400':
description: Indicates a bad request.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Bad Request
message:
type: string
example: "error validating action type config: [index]: expected value of type [string] but got [undefined]"
statusCode:
type: integer
example: 400
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
'404':
description: Object is not found.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
servers:
- url: https://localhost:5601
servers:

17
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connector_types.yaml
View file

@ -18,6 +18,8 @@ get:
content:
application/json:
schema:
title: Get connector types response body properties
description: The properties vary for each connector type.
type: array
items:
type: object
@ -56,6 +58,21 @@ get:
examples:
getConnectorTypesResponse:
$ref: '../components/examples/get_connector_types_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
servers:
- url: https://localhost:5601
servers:

17
x-pack/plugins/actions/docs/openapi/paths/s@{spaceid}@api@actions@connectors.yaml
View file

@ -15,6 +15,8 @@ get:
schema:
type: array
items:
title: Get connectors response body properties
description: The properties vary for each connector type.
type: object
required:
- connector_type_id
@ -53,6 +55,21 @@ get:
examples:
getConnectorsResponse:
$ref: '../components/examples/get_connectors_response.yaml'
'401':
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
properties:
error:
type: string
example: Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
servers:
- url: https://localhost:5601
servers: