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

[Security Solution] Deprecate some of the Bulk API endpoints #127756

Closed
7 of 9 tasks
xcrzx opened this issue Mar 15, 2022 · 4 comments · Fixed by #129448
Closed
7 of 9 tasks

[Security Solution] Deprecate some of the Bulk API endpoints #127756

xcrzx opened this issue Mar 15, 2022 · 4 comments · Fixed by #129448
Assignees
Labels
Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.2.0

Comments

@xcrzx
Copy link
Contributor

xcrzx commented Mar 15, 2022

Related to: #126068

Summary

On the frontend side of Elastic Security app, calls to some of our Bulk API endpoints were superseded by calls to the new Bulk Action API. The following endpoints are not used from Kibana anymore:

This means we don't need these endpoints ourselves, but we might have users who use them from their scripts and tools.

We would like to mark these 3 endpoints as deprecated and, ideally, let the users know:

  • when we're going to delete them (presumably after 18 months)
  • what APIs they could use instead (presumably the Bulk Action API, especially if we add new create and update actions to it)

Todo

  • Figure out the deprecation period
    • UPD: It's 18 months or more: MAX(18 months, time till the next major version).
  • Figure out what could be the replacement for the deprecated APIs (not immediately, but eventually)
    • UPD: Bulk actions API should be the replacement for actions like enabling/disabling, duplicating, deleting, or any other new actions in the future. In order to continue bulk creating or updating rules, users will need to switch to normal CRUD endpoints and call them N times in their scripts.
  • [DOCS] Mark old rules Bulk API as deprecated security-docs#1729 (PR)
  • Mention these deprecations in the release notes (PR)
  • Add a Warning: 299 header to responses of the deprecated endpoints. See this example for reference. (PR)
  • Log a console warning from each deprecated endpoint. See this example for reference. (PR)
  • Add a JSDoc annotation to each deprecated endpoint. See this example for reference. (PR)

These items were converted to tasks to be tracked separately:

Notes

Example PR with Cases endpoint deprecations: #124773

@xcrzx xcrzx added Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team v8.2.0 labels Mar 15, 2022
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@banderror banderror changed the title [Security Solution] Add a deprecation message to Bulk API responses [Security Solution] Deprecate some of the Bulk API endpoints Mar 21, 2022
@banderror
Copy link
Contributor

After having a chat with @xcrzx on deprecating the bulk APIs we decided to rephrase this ticket and add everything we will need to do to implement this deprecation. I just updated its title and description.

@xcrzx
Copy link
Contributor Author

xcrzx commented Apr 26, 2022

Closing this issue as the leftover items were converted into separate tickets:

@xcrzx xcrzx closed this as completed Apr 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature:Rule Management Security Solution Detection Rule Management area Team:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.2.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants