[OAS][DOCS] Add overlays for connector config and examples (#191791)

This commit is contained in:
Lisa Cawley 2024-09-05 09:19:52 -07:00 committed by GitHub
parent acd1897f4e
commit 86f9af8243
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
205 changed files with 407 additions and 22314 deletions

6
.gitignore vendored
View file

@ -146,9 +146,7 @@ role_users.json
.devcontainer/.env
# Ignore temporary files in oas_docs
oas_docs/output/kibana.serverless.tmp1.yaml
oas_docs/output/kibana.serverless.tmp2.yaml
oas_docs/output/kibana.tmp1.yaml
oas_docs/output/kibana.tmp2.yaml
oas_docs/output/kibana.serverless.tmp*.yaml
oas_docs/output/kibana.tmp*.yaml
oas_docs/output/kibana.new.yaml
oas_docs/output/kibana.serverless.new.yaml

View file

@ -51,13 +51,25 @@ api-docs-lint-serverless: ## Run spectral API docs linter on kibana.serverless.y
api-docs-overlay: ## Run spectral API docs linter on kibana.serverless.yaml
@npx bump overlay "output/kibana.serverless.yaml" "overlays/kibana.overlays.serverless.yaml" > "output/kibana.serverless.tmp1.yaml"
@npx bump overlay "output/kibana.serverless.tmp1.yaml" "overlays/alerting.overlays.yaml" > "output/kibana.serverless.tmp2.yaml"
@npx bump overlay "output/kibana.serverless.tmp2.yaml" "overlays/connectors.overlays.yaml" > "output/kibana.serverless.tmp3.yaml"
@npx bump overlay "output/kibana.yaml" "overlays/kibana.overlays.yaml" > "output/kibana.tmp1.yaml"
@npx bump overlay "output/kibana.tmp1.yaml" "overlays/alerting.overlays.yaml" > "output/kibana.tmp2.yaml"
@npx @redocly/cli bundle output/kibana.serverless.tmp2.yaml --ext yaml -o output/kibana.serverless.new.yaml
@npx @redocly/cli bundle output/kibana.tmp2.yaml --ext yaml -o output/kibana.new.yaml
@npx bump overlay "output/kibana.tmp2.yaml" "overlays/connectors.overlays.yaml" > "output/kibana.tmp3.yaml"
@npx @redocly/cli bundle output/kibana.serverless.tmp3.yaml --ext yaml -o output/kibana.serverless.new.yaml
@npx @redocly/cli bundle output/kibana.tmp3.yaml --ext yaml -o output/kibana.new.yaml
rm output/kibana.tmp*.yaml
rm output/kibana.serverless.tmp*.yaml
.PHONY: api-docs-preview
api-docs-preview: ## Generate a preview for kibana.yaml and kibana.serverless.yaml
@npx bump preview "output/kibana.yaml"
@npx bump preview "output/kibana.serverless.yaml"
.PHONY: api-docs-overlay-preview
api-docs-overlay-preview: ## Generate a preview for kibana.new.yaml and kibana.serverless.new.yaml
@npx bump preview "output/kibana.new.yaml"
@npx bump preview "output/kibana.serverless.new.yaml"
help: ## Display help
@awk 'BEGIN {FS = ":.*##"; printf "Usage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
#------------- <https://suva.sh/posts/well-documented-makefiles> --------------

View file

@ -0,0 +1,379 @@
# overlays.yaml
overlay: 1.0.0
info:
title: Overlays for the connector objects and examples
version: 0.0.1
actions:
# Fix some optional path parameters
- target: "$.paths['/api/actions/connector/{id}']['post'].parameters[?(@.name=='id')]"
description: Remove optional indicator from path parameter
update:
required: true
# Add some connector API examples
- target: "$.paths['/api/actions/connector/{id}']['post']"
description: "Add examples to create connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
createEmailConnectorRequest:
$ref: "../examples/create_email_connector_request.yaml"
createIndexConnectorRequest:
$ref: "../examples/create_index_connector_request.yaml"
createWebhookConnectorRequest:
$ref: "../examples/create_webhook_connector_request.yaml"
createXmattersConnectorRequest:
$ref: "../examples/create_xmatters_connector_request.yaml"
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
createEmailConnectorResponse:
$ref: "../examples/create_email_connector_response.yaml"
createIndexConnectorResponse:
$ref: "../examples/create_index_connector_response.yaml"
createWebhookConnectorResponse:
$ref: "../examples/create_webhook_connector_response.yaml"
createXmattersConnectorResponse:
$ref: "../examples/get_connector_response.yaml"
- target: "$.paths['/api/actions/connector/{id}/_execute']['post']"
description: "Add examples to run connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
runIndexConnectorRequest:
$ref: "../examples/run_index_connector_request.yaml"
runJiraConnectorRequest:
$ref: "../examples/run_jira_connector_request.yaml"
runServerLogConnectorRequest:
$ref: "../examples/run_servicenow_itom_connector_request.yaml"
runSlackConnectorRequest:
$ref: "../examples/run_slack_api_connector_request.yaml"
runSwimlaneConnectorRequest:
$ref: "../examples/run_swimlane_connector_request.yaml"
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
runIndexConnectorResponse:
$ref: "../examples/run_index_connector_response.yaml"
runJiraConnectorResponse:
$ref: "../examples/run_jira_connector_response.yaml"
runServerLogConnectorResponse:
$ref: "../examples/run_server_log_connector_response.yaml"
runServiceNowITOMConnectorResponse:
$ref: "../examples/run_servicenow_itom_connector_response.yaml"
runSlackConnectorResponse:
$ref: "../examples/run_slack_api_connector_response.yaml"
runSwimlaneConnectorResponse:
$ref: "../examples/run_swimlane_connector_response.yaml"
- target: "$.paths['/api/actions/connector/{id}']['get']"
description: "Add examples to get connector API"
update:
responses:
200:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
getConnectorResponse:
$ref: '../examples/get_connector_response.yaml'
- target: "$.paths['/api/actions/connector_types']['get']"
description: "Add examples to get connector types API"
update:
responses:
200:
description: Indicates a successful call.
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
getConnectorTypesServerlessResponse:
$ref: '../examples/get_connector_types_generativeai_response.yaml'
- target: "$.paths['/api/actions/connectors']['get']"
description: "Add examples to get all connectors API"
update:
responses:
200:
description: Indicates a successful call.
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
getConnectorsResponse:
$ref: '../examples/get_connectors_response.yaml'
- target: "$.paths['/api/actions/connector/{id}']['put']"
description: "Add examples to update connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
examples:
updateIndexConnectorRequest:
$ref: '../examples/update_index_connector_request.yaml'
# Remove the automated empty connector config and secrets
- target: "$.paths['/api/actions/connector/{id}']['post'].requestBody.content.*.schema.properties.config"
description: "Remove config in create connector API"
remove: true
- target: "$.paths['/api/actions/connector/{id}']['put'].requestBody.content.*.schema.properties.config"
description: "Remove config in update connector API"
remove: true
- target: "$.paths['/api/actions/connector/{id}']['post'].requestBody.content.*.schema.properties.secrets"
description: "Remove secrets in create connector API"
remove: true
- target: "$.paths['/api/actions/connector/{id}']['put'].requestBody.content.*.schema.properties.secrets"
description: "Remove secrets in update connector API"
remove: true
# Add some connector configuration schemas
- target: "$.paths['/api/actions/connector/{id}']['post']"
description: "Add config and secrets to create connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
properties:
config:
additionalProperties: {}
default: {}
description: The connector configuration details.
oneOf:
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_config.yaml'
# Crowdstrike (.crowdstrike) TBD
# D3 Security (.d3security)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/d3security_config.yaml'
# Email (.email)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/email_config.yaml'
# Google Gemini (.gemini)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/gemini_config.yaml'
# IBM Resilient (.resilient)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/resilient_config.yaml'
# Index (.index)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/index_config.yaml'
# Jira (.jira)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/jira_config.yaml'
# Microsoft Teams (.teams) N/A
# Observability AI Assistant (.observability-ai-assistant) TBD
# Azure OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_azure_config.yaml'
# OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_openai_config.yaml'
# Opsgenie (.opsgenie)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/opsgenie_config.yaml'
# PagerDuty (.pagerduty)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/pagerduty_config.yaml'
# SentinelOne (.sentinelone)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/sentinelone_config.yaml'
# Server log (.server-log) N/A
# ServiceNow ITSM (.servicenow)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_config.yaml'
# ServiceNow SecOps (.servicenow-sir) TBD
# ServiceNow ITOM (.servicenow-itom)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_itom_config.yaml'
# Slack (.slack_api)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/slack_api_config.yaml'
# Swimlane (.swimlane)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/swimlane_config.yaml'
# Tines (.tines)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/tines_config.yaml'
# Torq (.torq)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/torq_config.yaml'
# Webhook (.webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/webhook_config.yaml'
# Webhook - Case Management (.cases-webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/cases_webhook_config.yaml'
# xMatters (.xmatters)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/xmatters_config.yaml'
secrets:
additionalProperties: {}
default: {}
oneOf:
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_secrets.yaml'
# Crowdstrike (.crowdstrike) TBD
# D3 Security (.d3security)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/d3security_secrets.yaml'
# Email (.email)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/email_secrets.yaml'
# Google Gemini (.gemini)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/gemini_secrets.yaml'
# IBM Resilient (.resilient)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/resilient_secrets.yaml'
# Index (.index) N/A
# Jira (.jira)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/jira_secrets.yaml'
# Microsoft Teams (.teams)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/teams_secrets.yaml'
# Observability AI Assistant (.observability-ai-assistant) TBD
# OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_secrets.yaml'
# Opsgenie (.opsgenie)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/opsgenie_secrets.yaml'
# PagerDuty (.pagerduty)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/pagerduty_secrets.yaml'
# SentinelOne (.sentinelone)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/sentinelone_secrets.yaml'
# ServiceNow (.servicenow)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_secrets.yaml'
# ServiceNow Sec Ops (.servicenow-sir) TBD
# ServiceNow (.servicenow-itom) TBD
# Slack (.slack_api)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/slack_api_secrets.yaml'
# Swimlane (.swimlane)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/swimlane_secrets.yaml'
# Tines (.tines)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/tines_secrets.yaml'
# Torq (.torq)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/torq_secrets.yaml'
# Webhook (.webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/webhook_secrets.yaml'
# Webhook - Case Management (.cases-webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/cases_webhook_secrets.yaml'
# xMatters (.xmatters)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/xmatters_secrets.yaml'
- target: "$.paths['/api/actions/connector/{id}']['put']"
description: "Add config and secrets to update connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
properties:
config:
additionalProperties: {}
default: {}
description: The connector configuration details.
oneOf:
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_config.yaml'
# Crowdstrike (.crowdstrike) TBD
# D3 Security (.d3security)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/d3security_config.yaml'
# Email (.email)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/email_config.yaml'
# Google Gemini (.gemini)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/gemini_config.yaml'
# IBM Resilient (.resilient)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/resilient_config.yaml'
# Index (.index)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/index_config.yaml'
# Jira (.jira)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/jira_config.yaml'
# Microsoft Teams (.teams) N/A
# Observability AI Assistant (.observability-ai-assistant) TBD
# Azue OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_azure_config.yaml'
# OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_openai_config.yaml'
# Opsgenie (.opsgenie)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/opsgenie_config.yaml'
# PagerDuty (.pagerduty)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/pagerduty_config.yaml'
# SentinelOne (.sentinelone)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/sentinelone_config.yaml'
# Server log (.server-log) N/A
# ServiceNow ITSM (.servicenow)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_config.yaml'
# ServiceNow SecOps (.servicenow-sir) TBD
# ServiceNow ITOM (.servicenow-itom)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_itom_config.yaml'
# Slack (.slack_api)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/slack_api_config.yaml'
# Swimlane (.swimlane)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/swimlane_config.yaml'
# Tines (.tines)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/tines_config.yaml'
# Torq (.torq)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/torq_config.yaml'
# Webhook (.webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/webhook_config.yaml'
# Webhook - Case Management (.cases-webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/cases_webhook_config.yaml'
# xMatters (.xmatters)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/xmatters_config.yaml'
secrets:
additionalProperties: {}
default: {}
oneOf:
# Bedrock (.bedrock)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/bedrock_secrets.yaml'
# Crowdstrike (.crowdstrike) TBD
# D3 Security (.d3security)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/d3security_secrets.yaml'
# Email (.email)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/email_secrets.yaml'
# Google Gemini (.gemini)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/gemini_secrets.yaml'
# IBM Resilient (.resilient)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/resilient_secrets.yaml'
# Index (.index) N/A
# Jira (.jira)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/jira_secrets.yaml'
# Microsoft Teams (.teams)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/teams_secrets.yaml'
# Observability AI Assistant (.observability-ai-assistant) TBD
# OpenAI (.gen-ai)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/genai_secrets.yaml'
# Opsgenie (.opsgenie)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/opsgenie_secrets.yaml'
# PagerDuty (.pagerduty)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/pagerduty_secrets.yaml'
# SentinelOne (.sentinelone)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/sentinelone_secrets.yaml'
# ServiceNow (.servicenow)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/servicenow_secrets.yaml'
# ServiceNow SecOps (.servicenow-sir) TBD
# ServiceNow ITOM (.servicenow-itom) TBD
# Slack (.slack_api)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/slack_api_secrets.yaml'
# Swimlane (.swimlane)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/swimlane_secrets.yaml'
# Tines (.tines)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/tines_secrets.yaml'
# Torq (.torq)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/torq_secrets.yaml'
# Webhook (.webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/webhook_secrets.yaml'
# Webhook - Case Management (.cases-webhook)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/cases_webhook_secrets.yaml'
# xMatters (.xmatters)
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/xmatters_secrets.yaml'
# Remove the automated empty run connector params
- target: "$.paths['/api/actions/connector/{id}/_execute']['post'].requestBody.content.*.schema.properties.params"
description: "Remove params in run connector API"
remove: true
# Add some run connector params
- target: "$.paths['/api/actions/connector/{id}/_execute']['post']"
description: "Add examples to run connector API"
update:
requestBody:
content:
application/json; Elastic-Api-Version=2023-10-31:
schema:
properties:
params:
additionalProperties: {}
oneOf:
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_acknowledge_resolve_pagerduty.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_documents.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_message_email.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_message_serverlog.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_message_slack.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_trigger_pagerduty.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_addevent.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_closealert.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_closeincident.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_createalert.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_fieldsbyissuetype.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_getchoices.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_getfields.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_getincident.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_issue.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_issues.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_issuetypes.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_postmessage.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_pushtoservice.yaml'
- $ref: '../../x-pack/plugins/actions/docs/openapi/components/schemas/run_validchannelid.yaml'

View file

@ -1,25 +1,5 @@
# OpenAPI (Experimental)
The current self-contained spec file is [as JSON](https://raw.githubusercontent.com/elastic/kibana/master/x-pack/plugins/cases/common/openapi/bundled.json) or [as YAML](https://raw.githubusercontent.com/elastic/kibana/master/x-pack/plugins/cases/common/openapi/bundled.yaml) and can be used for online tools like those found at https://openapi.tools/.
This spec is experimental and may be incomplete or change later.
A guide about the openApi specification can be found at [https://swagger.io/docs/specification/about/](https://swagger.io/docs/specification/about/).
## The `openapi` folder
* `entrypoint.yaml` is the overview file which pulls together all the paths and components.
* [Paths](paths/README.md): this defines each endpoint. A path can have one operation per http method.
* [Components](components/README.md): Reusable components
## Tools
You can generate the `bundled` files by running the following commands:
```
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.yaml --ext yaml
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json
```
Then join these files with the rest of the Kibana APIs per `oas_docs/README.md`
The files in this folder are referenced from the [OpenAPI overlay for connectors](../../../../../oas_docs/overlays/connectors.overlays.yaml).

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -1,31 +0,0 @@
summary: A list of connector types
value:
- id: .swimlane
name: Swimlane
enabled: true
enabled_in_config: true
enabled_in_license: true
minimum_license_required: gold
supported_feature_ids:
- alerting
- cases
- siem
- id: .index
name: Index
enabled: true
enabled_in_config: true
enabled_in_license: true
minimum_license_required: basic
supported_feature_ids:
- alerting
- uptime
- siem
- id: .server-log
name: Server log
enabled: true
enabled_in_config: true
enabled_in_license: true
minimum_license_required: basic
supported_feature_ids:
- alerting
- uptime

View file

@ -1,9 +0,0 @@
schema:
type: string
enum:
- 2023-10-31
default: 2023-10-31
in: header
name: elastic-api-version
description: In Elastic Serverless, indicates the version of the API to use.
required: true

View file

@ -1,6 +0,0 @@
schema:
type: string
in: header
name: kbn-xsrf
description: Cross-site request forgery protection
required: true

View file

@ -1,7 +0,0 @@
in: path
name: actionId
description: An identifier for the action.
required: true
schema:
type: string
example: c55b6eb0-6bad-11eb-9f3b-611eebc6c3ad

View file

@ -1,7 +0,0 @@
in: path
name: connectorId
description: An identifier for the connector.
required: true
schema:
type: string
example: df770e30-8b8b-11ed-a780-3b746c987a81

View file

@ -1,7 +0,0 @@
in: path
name: spaceId
description: An identifier for the space. If `/s/` and the identifier are omitted from the path, the default space is used.
required: true
schema:
type: string
example: default

View file

@ -1,5 +0,0 @@
description: Indicates a successful call.
content:
application/json:
schema:
$ref: '../schemas/action_response_properties.yaml'

View file

@ -1,15 +0,0 @@
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

View file

@ -1,19 +0,0 @@
description: Authorization information is missing or invalid.
content:
application/json:
schema:
type: object
title: Unauthorized response
properties:
error:
type: string
example: Unauthorized
enum:
- Unauthorized
message:
type: string
statusCode:
type: integer
example: 401
enum:
- 401

View file

@ -1,20 +0,0 @@
description: Object is not found.
content:
application/json:
schema:
type: object
title: Not found response
properties:
error:
type: string
example: Not Found
enum:
- Not Found
message:
type: string
example: "Saved object [action/baf33fc0-920c-11ed-b36a-874bd1548a00] not found"
statusCode:
type: integer
example: 404
enum:
- 404

View file

@ -1,10 +0,0 @@
title: Connector request properties for an OpenAI connector
description: Defines properties for connectors when type is `.gen-ai`.
oneOf:
- $ref: 'config_properties_genai_azure.yaml'
- $ref: 'config_properties_genai_openai.yaml'
discriminator:
propertyName: apiProvider
mapping:
Azure OpenAI: 'config_properties_genai_azure.yaml'
OpenAI: 'config_properties_genai_openai.yaml'

View file

@ -1,54 +0,0 @@
title: Connector response properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: 'connector_response_properties_bedrock.yaml'
- $ref: 'connector_response_properties_gemini.yaml'
- $ref: 'connector_response_properties_cases_webhook.yaml'
- $ref: 'connector_response_properties_d3security.yaml'
- $ref: 'connector_response_properties_email.yaml'
- $ref: 'connector_response_properties_genai.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_sentinelone.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_api.yaml'
- $ref: 'connector_response_properties_slack_webhook.yaml'
- $ref: 'connector_response_properties_swimlane.yaml'
- $ref: 'connector_response_properties_teams.yaml'
- $ref: 'connector_response_properties_tines.yaml'
- $ref: 'connector_response_properties_torq.yaml'
- $ref: 'connector_response_properties_webhook.yaml'
- $ref: 'connector_response_properties_xmatters.yaml'
discriminator:
propertyName: connector_type_id
mapping:
.bedrock: 'connector_response_properties_bedrock.yaml'
.gemini: 'connector_response_properties_gemini.yaml'
.cases-webhook: 'connector_response_properties_cases_webhook.yaml'
.d3security: 'connector_response_properties_d3security.yaml'
.email: 'connector_response_properties_email.yaml'
.gen-ai: 'connector_response_properties_genai.yaml'
.index: 'connector_response_properties_index.yaml'
.jira: 'connector_response_properties_jira.yaml'
.opsgenie: 'connector_response_properties_opsgenie.yaml'
.pagerduty: 'connector_response_properties_pagerduty.yaml'
.resilient: 'connector_response_properties_resilient.yaml'
.sentinelone: 'connector_response_properties_sentinelone.yaml'
.server-log: 'connector_response_properties_serverlog.yaml'
.servicenow: 'connector_response_properties_servicenow.yaml'
.servicenow-itom: 'connector_response_properties_servicenow_itom.yaml'
.servicenow-sir: 'connector_response_properties_servicenow_sir.yaml'
.slack_api: 'connector_response_properties_slack_api.yaml'
.slack: 'connector_response_properties_slack_webhook.yaml'
.swimlane: 'connector_response_properties_swimlane.yaml'
.teams: 'connector_response_properties_teams.yaml'
.tines: 'connector_response_properties_tines.yaml'
.torq: 'connector_response_properties_torq.yaml'
.webhook: 'connector_response_properties_webhook.yaml'
.xmatters: 'connector_response_properties_xmatters.yaml'

View file

@ -1,32 +0,0 @@
title: Connector request properties for a Webhook - Case Management connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a D3 Security connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_d3security.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for an email connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Google Gemini connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_gemini.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .gemini
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for an OpenAI connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_genai.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .gen-ai
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for an index connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Jira connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for an Opsgenie connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a PagerDuty connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a IBM Resilient connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a SentinelOne connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_sentinelone.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .sentinelone
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,33 +0,0 @@
title: Connector response properties for a server log connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a ServiceNow ITSM connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a ServiceNow ITOM connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a ServiceNow SecOps connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Slack connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_slack_api.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .slack_api
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,30 +0,0 @@
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Swimlane connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Microsoft Teams connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
type: object
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Tines connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for a Torq connector
type: object
required:
- connector_type_id
- id
- is_deprecated
- is_preconfigured
- name
properties:
config:
$ref: 'config_properties_torq.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .torq
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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,33 +0,0 @@
title: Connector response properties for a Webhook connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,32 +0,0 @@
title: Connector response properties for an xMatters connector
type: object
required:
- 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'
is_system_action:
$ref: 'is_system_action.yaml'
name:
type: string
description: The display name for the connector.
referenced_by_count:
$ref: 'referenced_by_count.yaml'

View file

@ -1,55 +0,0 @@
title: Create connector request body properties
description: The properties vary depending on the connector type.
oneOf:
- $ref: 'create_connector_request_bedrock.yaml'
- $ref: 'create_connector_request_gemini.yaml'
- $ref: 'create_connector_request_cases_webhook.yaml'
- $ref: 'create_connector_request_d3security.yaml'
- $ref: 'create_connector_request_email.yaml'
- $ref: 'create_connector_request_genai.yaml'
- $ref: 'create_connector_request_index.yaml'
- $ref: 'create_connector_request_jira.yaml'
- $ref: 'create_connector_request_opsgenie.yaml'
- $ref: 'create_connector_request_pagerduty.yaml'
- $ref: 'create_connector_request_resilient.yaml'
- $ref: 'create_connector_request_sentinelone.yaml'
- $ref: 'create_connector_request_serverlog.yaml'
- $ref: 'create_connector_request_servicenow.yaml'
- $ref: 'create_connector_request_servicenow_itom.yaml'
- $ref: 'create_connector_request_servicenow_sir.yaml'
- $ref: 'create_connector_request_slack_api.yaml'
- $ref: 'create_connector_request_slack_webhook.yaml'
- $ref: 'create_connector_request_swimlane.yaml'
- $ref: 'create_connector_request_teams.yaml'
- $ref: 'create_connector_request_tines.yaml'
- $ref: 'create_connector_request_torq.yaml'
- $ref: 'create_connector_request_webhook.yaml'
- $ref: 'create_connector_request_xmatters.yaml'
discriminator:
propertyName: connector_type_id
mapping:
.bedrock: 'create_connector_request_bedrock.yaml'
.gemini: 'create_connector_request_gemini.yaml'
.cases-webhook: 'create_connector_request_cases_webhook.yaml'
.d3security: 'create_connector_request_d3security.yaml'
.email: 'create_connector_request_email.yaml'
.gen-ai: 'create_connector_request_genai.yaml'
.index: 'create_connector_request_index.yaml'
.jira: 'create_connector_request_jira.yaml'
.opsgenie: 'create_connector_request_opsgenie.yaml'
.pagerduty: 'create_connector_request_pagerduty.yaml'
.resilient: 'create_connector_request_resilient.yaml'
.sentinelone: 'create_connector_request_sentinelone.yaml'
.server-log: 'create_connector_request_serverlog.yaml'
.servicenow: 'create_connector_request_servicenow.yaml'
.servicenow-itom: 'create_connector_request_servicenow_itom.yaml'
.servicenow-sir: 'create_connector_request_servicenow_sir.yaml'
.slack_api: 'create_connector_request_slack_api.yaml'
.slack: 'create_connector_request_slack_webhook.yaml'
.swimlane: 'create_connector_request_swimlane.yaml'
.teams: 'create_connector_request_teams.yaml'
.tines: 'create_connector_request_tines.yaml'
.torq: 'create_connector_request_torq.yaml'
.webhook: 'create_connector_request_webhook.yaml'
.xmatters: 'create_connector_request_xmatters.yaml'

View file

@ -1,24 +0,0 @@
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'

View file

@ -1,24 +0,0 @@
title: Create D3 Security connector request
description: >
The connector uses axios to send a POST request to a D3 Security endpoint.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_d3security.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .d3security
example: .d3security
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_d3security.yaml'

View file

@ -1,27 +0,0 @@
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'

View file

@ -1,23 +0,0 @@
title: Create Google Gemini connector request
description: The Google Gemini connector uses axios to send a POST request to Google Gemini.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_gemini.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .gemini
example: .gemini
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_gemini.yaml'

View file

@ -1,25 +0,0 @@
title: Create OpenAI connector request
description: >
The OpenAI connector uses axios to send a POST request to either
OpenAI or Azure OpenAPI.
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_genai.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .gen-ai
example: .gen-ai
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_genai.yaml'

View file

@ -1,20 +0,0 @@
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

View file

@ -1,23 +0,0 @@
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'

View file

@ -1,23 +0,0 @@
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'

View file

@ -1,25 +0,0 @@
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'

View file

@ -1,23 +0,0 @@
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'

View file

@ -1,27 +0,0 @@
title: Create SentinelOne connector request
description: >
The SentinelOne connector communicates with SentinelOne Management Console via REST API.
This functionality is in technical preview and may be changed or removed in a future release.
Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
x-technical-preview: true
type: object
required:
- config
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_sentinelone.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .sentinelone
example: .sentinelone
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_sentinelone.yaml'

View file

@ -1,17 +0,0 @@
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

View file

@ -1,25 +0,0 @@
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'

View file

@ -1,25 +0,0 @@
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'

View file

@ -1,25 +0,0 @@
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'

View file

@ -1,22 +0,0 @@
title: Create Slack connector request
description: The Slack connector uses an API method to send Slack messages.
type: object
required:
- connector_type_id
- name
- secrets
properties:
config:
$ref: 'config_properties_slack_api.yaml'
connector_type_id:
type: string
description: The type of connector.
enum:
- .slack_api
example: .slack_api
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_slack_api.yaml'

View file

@ -1,20 +0,0 @@
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_webhook.yaml'

View file

@ -1,23 +0,0 @@
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'

View file

@ -1,20 +0,0 @@
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'

Some files were not shown because too many files have changed in this diff Show more