Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RAM] Docs for slack improvements #153885

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
3f88e68
add test which create auto snapshots for slack connector
guskovaue Mar 8, 2023
8d7ee38
add preconfigured web api connector section
guskovaue Mar 22, 2023
8815a62
create Configure a Slack account with Web AP
guskovaue Mar 28, 2023
81777d7
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
guskovaue Mar 28, 2023
64f998b
addition to previous comment
guskovaue Mar 28, 2023
ef3df61
attempt to write openapi
guskovaue Mar 28, 2023
c6fbfea
[DOCS] Add enumerated data type in update_connector_request_slack.yaml
lcawl Mar 29, 2023
d42e63f
[DOCS] Uncomment update_connector_request_slack.yaml
lcawl Mar 29, 2023
b8b2397
[DOCS] Generate API doc output
lcawl Mar 29, 2023
005360e
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
guskovaue Mar 29, 2023
c1d1fc9
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Mar 29, 2023
156ee4c
write openapi docs
guskovaue Mar 29, 2023
bf55d9e
Merge branch 'RAM-152880-change-docs-for-slack-improvements' of githu…
guskovaue Mar 29, 2023
947291f
delete old file
guskovaue Mar 29, 2023
65c26c5
[DOCS] Re-add configuring-slack anchor
lcawl Mar 29, 2023
9ed200a
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
guskovaue Apr 25, 2023
ef43470
[CI] Auto-commit changed files from 'node scripts/eslint --no-cache -…
kibanamachine Apr 25, 2023
7aeb227
Update docs/management/connectors/action-types/slack.asciidoc
guskovaue Apr 25, 2023
7c82f75
changes after separating slack connectors
guskovaue Apr 25, 2023
8a9d0c7
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
guskovaue Apr 25, 2023
c1badca
test for automated screenshots
guskovaue Apr 27, 2023
f354bb2
change api docs
guskovaue Apr 27, 2023
739b7ce
[DOCS] Regenerate connector-apis-passthru.asciidoc
lcawl Apr 27, 2023
50a4f6b
uncomment what was commented
guskovaue Apr 28, 2023
6597de2
Merge branch 'RAM-152880-change-docs-for-slack-improvements' of githu…
guskovaue Apr 28, 2023
751ed10
[DOCS] Add automate screenshots
lcawl Apr 28, 2023
5276631
[DOCS] Describe differences between connector types
lcawl May 1, 2023
7a112a5
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
lcawl May 2, 2023
4ba21d6
Edits slack connector message text
lcawl May 2, 2023
2032e4b
Edit channel validation message
lcawl May 2, 2023
eafb15c
Merge branch 'main' into RAM-152880-change-docs-for-slack-improvements
guskovaue May 3, 2023
0918ba9
fix a message line
guskovaue May 4, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
changes after separating slack connectors
  • Loading branch information
guskovaue committed Apr 25, 2023
commit 7c82f75326c7cea315d11cab43e142d3535e1105
10 changes: 3 additions & 7 deletions docs/management/connectors/action-types/slack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,8 @@ adding `xpack.actions.preconfigured` settings to your `kibana.yml` file.
--
xpack.actions.preconfigured:
my-slack:
name: preconfigured-slack-connector-type
name: preconfigured-slack-webhook-connector-type
actionTypeId: .slack
config:
type: 'webhook'
secrets:
webhookUrl: 'https://hooks.slack.com/services/xxxx/xxxx/xxxx' <1>
--
Expand All @@ -49,10 +47,8 @@ xpack.actions.preconfigured:
--
xpack.actions.preconfigured:
my-slack:
name: preconfigured-slack-connector-type
actionTypeId: .slack
config:
type: 'web_api'
name: preconfigured-slack-api-connector-type
actionTypeId: .slack_api
secrets:
token: 'xoxb-xxxx-xxxx-xxxx' <1>
--
Expand Down
Original file line number Diff line number Diff line change
@@ -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_api
example: .slack_api
name:
type: string
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_slack_api.yaml'
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ properties:
description: The display name for the connector.
example: my-connector
secrets:
$ref: 'secrets_properties_slack.yaml'
$ref: 'secrets_properties_slack_webhook.yaml'
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
title: Connector secrets properties for a Webhook Slack connector
description: Defines secrets for connectors when type is `.slack`.
required:
- token
- webhookUrl
type: object
properties:
webhookUrl:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,21 +1,13 @@
title: Update Slack connector request
type: object
required:
- config
- name
- secrets
properties:
name:
type: string
description: The display name for the connector.
config:
type: string
enum:
- web_api
- webhook
secrets:
type: object
description: The secrets object containing the necessary fields for authentication.
oneOf:
- $ref: 'secrets_properties_slack_web_api.yaml'
- $ref: 'secrets_properties_slack_webhook.yaml'
$ref: 'secrets_properties_slack_api.yaml'
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
title: Update Slack connector request
type: object
required:
- name
- secrets
properties:
name:
type: string
description: The display name for the connector.
secrets:
type: object
description: The secrets object containing the necessary fields for authentication.
$ref: 'secrets_properties_slack_webhook.yaml'