[Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology #92451

gmmorris · 2021-02-23T16:29:54Z

Summary

This PR covers the connectors portion, of new terminology in Kibana alerting, where we use action as the current terminology.

This new terminology change includes URLs, parameters, body, and response in the new APIs.
As part of this we also correct the API Request and Response bodies to follow the Style Guide by mapping camelCase fields to snake_case where needed.

Docs preview: https://kibana_92451.docs-preview.app.elstc.co/guide/en/kibana/master/actions-and-connectors-legacy-apis.html

Enhancement vs. Deprecation

This PR deprecates the following apis, and adds the following apis in their place:

Deprecated	Added (enhancement)
`/api/actions/action`	`/api/actions/connector`
`/api/actions/action/{id}`	`/api/actions/connector/{id}`
`/api/actions`	`/api/actions/connectors`
`/api/actions/action/{id}`	`/api/actions/connector/{id}`
`/api/actions/list_action_types`	`/api/actions/connector_types`
`/api/actions/action/{id}`	`/api/actions/connector/{id}`
`/api/actions/action/{id}/_execute`	`/api/actions/connector/{id}/_execute`

Checklist

Delete any items that are not applicable to this PR.

~~Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
Documentation was added for features that require explanation or tutorials
Unit or functional tests were updated or added to match the most common scenarios
~~Any UI touched in this PR is usable by keyboard only (learn more about keyboard accessibility)~~
~~Any UI touched in this PR does not create any new axe failures (run axe in browser: FF, Chrome)~~
~~If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the docker list~~
~~This renders correctly on smaller devices using a responsive layout. (You can test this in your browser)~~
~~This was checked for cross-browser compatibility~~

For maintainers

This was checked for breaking API changes and was labeled appropriately

* master: (199 commits) Convert Canvas docs to MDX for use in Elastic Docs (elastic#91969) [Bazel] More resilient Workspace Status (elastic#93244) [Discover] Change icon of saved search in open search panel and embeddable selection (elastic#93001) [Workplace Search] Role Mappings to Kibana (elastic#93123) [Fleet] Use type-only imports where possible (elastic#92979) [Lens] Set pie chart slices sorted clockwise (elastic#92617) Remove ms label from CPU load on status page (elastic#92836) [App Search] Migrate Create Meta Engine View (elastic#92127) [Time to Visualize] Disable Visualize URL Tracker When Linked to OriginatingApp (elastic#92917) [ILM] Allow multiple searchable snapshot actions (elastic#92789) Improve consistency for display of management items (elastic#92694) skip flaky suite (elastic#93152) skip flaky suite (elastic#93152) [ILM] Refactor edit_policy client integration tests into separate feature files (elastic#92826) Add developer documentation about the building blocks we offer plugin developers (elastic#92743) [Security Solution] Case ui enhancement (elastic#91863) [Security Solution] [Detections] Updates warning message when no indices match provided index patterns (elastic#93094) Collect agent telemetry even when fleet server is disabled. (elastic#93198) [Lens] Fix runtime validation error message (elastic#93195) [Lens] Remove warning about ordinal x-domain (elastic#93049) ...

elasticmachine · 2021-03-03T17:49:23Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

ymao1

Initial code review looks great! Just a question about using verifyAccessAndContext everywhere. Will test out the API in the morning

docs/api/actions-and-connectors.asciidoc

docs/api/actions-and-connectors/execute.asciidoc

docs/api/actions-and-connectors/get.asciidoc

x-pack/plugins/actions/server/routes/legacy/get.ts

x-pack/plugins/actions/server/routes/legacy/get_all.ts

x-pack/plugins/actions/server/routes/legacy/list_action_types.ts

x-pack/plugins/actions/server/routes/legacy/update.ts

x-pack/plugins/actions/server/routes/list_action_types.ts

Co-authored-by: ymao1 <[email protected]>

…into actions/terminology-api * 'actions/terminology-api' of github.com:gmmorris/kibana: Apply suggestions from code review

ymao1

Tested out all the old and new APIs locally...everything looks great!

mikecote

Changes LGTM!

docs/api/actions-and-connectors/legacy/index.asciidoc

mikecote · 2021-03-04T15:43:52Z

docs/api/actions-and-connectors.asciidoc

@@ -3,21 +3,23 @@

 Manage Actions and Connectors.


Meta comment: I wonder if this is time to remove "Actions and Connectors" confusion. Since they are the same, we could call them "Connectors"? ex: "Manage Connectors" (+folder / file names).

Are they the same though?
We'll still use action to refer to the execution of something by using a connector, right?
Especially one we support multiple actions per connector...

We'll still use action to refer to the execution of something by using a connector, right?

Correct but we only have the concept of actions on the side of the alert now, no?

I asked myself: "Is there any docs in the actions and connectors page the user can read to learn more about actions?"

x-pack/plugins/actions/server/routes/index.ts

Co-authored-by: Mike Côté <[email protected]>

* master: (107 commits) [Logs UI] Fix log stream data fetching (elastic#93201) [App Search] Added relevance tuning search preview (elastic#93054) [Canvas] Fix reports embeddables (elastic#93482) [ILM] Added new functional test in ILM for creating a new policy (elastic#92936) Remove direct dependency on statehood package (elastic#93592) [Maps] Track tile loading status (elastic#91585) [Discover][Doc] Improve main documentation (elastic#91854) [Upgrade Assistant] Disable UA and add prompt (elastic#92834) [Snapshot Restore] Remove cloud validation for slm policy (elastic#93609) [Maps] Support GeometryCollections in GeoJson upload (elastic#93507) [XY Charts] fix partial histogram endzones annotations (elastic#93091) [Core] Simplify context typings (elastic#93579) [Alerting] Improving health status check (elastic#93282) [Discover] Restore context documentation (elastic#90784) [core-docs] Edits core-intro section for the new docs system (elastic#93540) add missed codeowners (elastic#89714) fetch node labels via script execution (elastic#93225) [Security Solution] Adds getMockTheme function (elastic#92840) Sort dependencies in package.json correctly (elastic#93590) [Bug] missing timepicker:quickRanges migration (elastic#93409) ...

…into actions/terminology-api * 'actions/terminology-api' of github.com:gmmorris/kibana: Update docs/api/actions-and-connectors/legacy/index.asciidoc

gmmorris · 2021-03-04T22:27:13Z

@elasticmachine merge upstream

…into actions/terminology-api * 'actions/terminology-api' of github.com:gmmorris/kibana: Make Dashboard Unsaved Changes Space Specific (elastic#92680) Hide Value and Funtional boost for geolocation (elastic#93683) [Fleet] Set all keyword and text fields for `index.query.default_field` index template setting (elastic#91791) can not query the world (elastic#93556) [Security Solutions] Sets our default date time to be "today" instead of "Last 24 hours" to enable cachability and fixes one date math bug in the URL (elastic#93548) [Security Solution][Endpoint][Admin][Policy] Register as AV os restrictions tooltip note (elastic#93306) fix agg config sub agg dsl generation (elastic#93276)

* master: styling (elastic#93663)

kibanamachine · 2021-03-05T01:27:03Z

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

💔 Build #111243 failed 4b20afb
💔 Build #111199 failed 3a87a7d
💚 Build #111014 succeeded 71c8965
💛 Build #110754 was flaky c750557
💚 Build #110747 succeeded bb283bf

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

kibanamachine · 2021-03-05T11:52:08Z

💔 Backport failed

❌ 7.x: Commit could not be cherrypicked due to conflicts

To backport manually, check out the target branch and run:
node scripts/backport --pr 92451

…r the new Alerting terminology (elastic#92451) * moved legacy actions api to legacy folder * introduced connector create api * added new delete route * added new execute and get_all * introduced all connector APIs * renamed action to connector in Apis * comment on camel case type * fixed va * updated docs * legacy title * corrected APIs * legacy links * added linik to deprecatred APIs * added linik to deprecatred APIs from index * moved legacy apis down one level * Apply suggestions from code review Co-authored-by: ymao1 <[email protected]> * renamed route file for connectorTypesRoute * define legacy route * Update docs/api/actions-and-connectors/legacy/index.asciidoc Co-authored-by: Mike Côté <[email protected]> * api docs Co-authored-by: ymao1 <[email protected]> Co-authored-by: Mike Côté <[email protected]> Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # api_docs/actions.json

…r the new Alerting terminology (#92451) (#93762) * moved legacy actions api to legacy folder * introduced connector create api * added new delete route * added new execute and get_all * introduced all connector APIs * renamed action to connector in Apis * comment on camel case type * fixed va * updated docs * legacy title * corrected APIs * legacy links * added linik to deprecatred APIs * added linik to deprecatred APIs from index * moved legacy apis down one level * Apply suggestions from code review Co-authored-by: ymao1 <[email protected]> * renamed route file for connectorTypesRoute * define legacy route * Update docs/api/actions-and-connectors/legacy/index.asciidoc Co-authored-by: Mike Côté <[email protected]> * api docs Co-authored-by: ymao1 <[email protected]> Co-authored-by: Mike Côté <[email protected]> Co-authored-by: Kibana Machine <[email protected]> # Conflicts: # api_docs/actions.json Co-authored-by: Gidi Meir Morris <[email protected]>

gmmorris added 16 commits February 23, 2021 16:28

moved legacy actions api to legacy folder

47594cb

introduced connector create api

e4cac15

added new delete route

14e9f1f

added new execute and get_all

4ec8d3a

introduced all connector APIs

1caa038

renamed action to connector in Apis

abf36db

comment on camel case type

a1ab01d

fixed va

234cdfc

updated docs

c7f9b0d

legacy title

098b766

corrected APIs

f71f42f

legacy links

6f2333d

added linik to deprecatred APIs

020385a

added linik to deprecatred APIs from index

bb283bf

moved legacy apis down one level

c750557

gmmorris marked this pull request as ready for review March 3, 2021 17:48

gmmorris requested a review from a team as a code owner March 3, 2021 17:48

gmmorris added Feature:Actions release_note:deprecation release_note:enhancement Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.13.0 v8.0.0 labels Mar 3, 2021

gmmorris changed the title ~~[Alerting] align Actions and Connectors terminology~~ [Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology Mar 3, 2021

ymao1 reviewed Mar 4, 2021

View reviewed changes

gmmorris and others added 3 commits March 4, 2021 11:22

Apply suggestions from code review

d005de3

Co-authored-by: ymao1 <[email protected]>

renamed route file for connectorTypesRoute

97e2549

Merge branch 'actions/terminology-api' of github.com:gmmorris/kibana …

71c8965

…into actions/terminology-api * 'actions/terminology-api' of github.com:gmmorris/kibana: Apply suggestions from code review

ymao1 approved these changes Mar 4, 2021

View reviewed changes

mikecote self-requested a review March 4, 2021 15:41

mikecote approved these changes Mar 4, 2021

View reviewed changes

gmmorris and others added 4 commits March 4, 2021 20:05

define legacy route

923cd1e

Update docs/api/actions-and-connectors/legacy/index.asciidoc

62a21e9

Co-authored-by: Mike Côté <[email protected]>

Merge branch 'actions/terminology-api' of github.com:gmmorris/kibana …

3a87a7d

…into actions/terminology-api * 'actions/terminology-api' of github.com:gmmorris/kibana: Update docs/api/actions-and-connectors/legacy/index.asciidoc

kibanamachine and others added 4 commits March 4, 2021 17:27

Merge branch 'master' into actions/terminology-api

4b20afb

api docs

3deed12

Merge branch 'master' into actions/terminology-api

822d988

* master: styling (elastic#93663)

mikecote added the auto-backport Deprecated - use backport:version if exact versions are needed label Mar 5, 2021

mikecote merged commit 7cfd15c into elastic:master Mar 5, 2021

mikecote mentioned this pull request Mar 5, 2021

[7.x] [Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology (#92451) #93762

Merged

mikecote mentioned this pull request Mar 8, 2021

Create new rule HTTP APIs that use the new terminology #90377

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology #92451

[Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology #92451

gmmorris commented Feb 23, 2021 •

edited

Loading

elasticmachine commented Mar 3, 2021

ymao1 left a comment

ymao1 left a comment

mikecote left a comment

mikecote Mar 4, 2021

gmmorris Mar 4, 2021

mikecote Mar 4, 2021

gmmorris commented Mar 4, 2021

kibanamachine commented Mar 5, 2021

kibanamachine commented Mar 5, 2021

[Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology #92451

[Alerting] adds Connectors APIs and deprecates old Actions APIs as per the new Alerting terminology #92451

Conversation

gmmorris commented Feb 23, 2021 • edited Loading

Summary

Enhancement vs. Deprecation

Checklist

For maintainers

elasticmachine commented Mar 3, 2021

ymao1 left a comment

Choose a reason for hiding this comment

ymao1 left a comment

Choose a reason for hiding this comment

mikecote left a comment

Choose a reason for hiding this comment

mikecote Mar 4, 2021

Choose a reason for hiding this comment

gmmorris Mar 4, 2021

Choose a reason for hiding this comment

mikecote Mar 4, 2021

Choose a reason for hiding this comment

gmmorris commented Mar 4, 2021

kibanamachine commented Mar 5, 2021

💚 Build Succeeded

Metrics [docs]

History

kibanamachine commented Mar 5, 2021

💔 Backport failed

gmmorris commented Feb 23, 2021 •

edited

Loading