-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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
Switch "suggest user profiles" API to internal use #173141
Switch "suggest user profiles" API to internal use #173141
Conversation
Pinging @elastic/security-solution (Team: SecuritySolution) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this change is ok given what you've outlined. I would like @marshallmain to confirm before merging.
Are there any updates we'd need to make OpenAPI side?
Good point, there is one place in endpoint description file where we need to update the route path, but it does not affect any other files. Updated and pushed changes. |
💚 Build Succeeded
Metrics [docs]Page load bundle
History
To update your PR or re-run it, just comment with: cc @e40pud |
## Summary With this changes I make "suggestions user profiles" API to be internal instead of public. We did not reveal it via documentation and it is better to mark it as an internal API. This API was introduced in this PR elastic#170579 and was not released yet. I also realised that currently the route does not reflect the fact that it is finding user profiles: `/api/detection_engine/signals/_find` The new version will have `users` as part of the path: `/internal/detection_engine/users/_find` (cherry picked from commit 7e168c7)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
…173249) # Backport This will backport the following commits from `main` to `8.12`: - [Switch "suggest user profiles" API to internal use (#173141)](#173141) <!--- Backport version: 8.9.7 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Ievgen Sorokopud","email":"[email protected]"},"sourceCommit":{"committedDate":"2023-12-13T10:10:10Z","message":"Switch \"suggest user profiles\" API to internal use (#173141)\n\n## Summary\r\n\r\nWith this changes I make \"suggestions user profiles\" API to be internal\r\ninstead of public. We did not reveal it via documentation and it is\r\nbetter to mark it as an internal API.\r\n\r\nThis API was introduced in this PR\r\nhttps://github.com//pull/170579 and was not released yet.\r\n\r\nI also realised that currently the route does not reflect the fact that\r\nit is finding user profiles:\r\n\r\n`/api/detection_engine/signals/_find`\r\n\r\nThe new version will have `users` as part of the path:\r\n\r\n`/internal/detection_engine/users/_find`","sha":"7e168c7fa9af17f80d3daa53a632754efb553c36","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team: SecuritySolution","backport:prev-minor","Team:Detection Engine","v8.13.0"],"number":173141,"url":"https://github.com/elastic/kibana/pull/173141","mergeCommit":{"message":"Switch \"suggest user profiles\" API to internal use (#173141)\n\n## Summary\r\n\r\nWith this changes I make \"suggestions user profiles\" API to be internal\r\ninstead of public. We did not reveal it via documentation and it is\r\nbetter to mark it as an internal API.\r\n\r\nThis API was introduced in this PR\r\nhttps://github.com//pull/170579 and was not released yet.\r\n\r\nI also realised that currently the route does not reflect the fact that\r\nit is finding user profiles:\r\n\r\n`/api/detection_engine/signals/_find`\r\n\r\nThe new version will have `users` as part of the path:\r\n\r\n`/internal/detection_engine/users/_find`","sha":"7e168c7fa9af17f80d3daa53a632754efb553c36"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.13.0","labelRegex":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/173141","number":173141,"mergeCommit":{"message":"Switch \"suggest user profiles\" API to internal use (#173141)\n\n## Summary\r\n\r\nWith this changes I make \"suggestions user profiles\" API to be internal\r\ninstead of public. We did not reveal it via documentation and it is\r\nbetter to mark it as an internal API.\r\n\r\nThis API was introduced in this PR\r\nhttps://github.com//pull/170579 and was not released yet.\r\n\r\nI also realised that currently the route does not reflect the fact that\r\nit is finding user profiles:\r\n\r\n`/api/detection_engine/signals/_find`\r\n\r\nThe new version will have `users` as part of the path:\r\n\r\n`/internal/detection_engine/users/_find`","sha":"7e168c7fa9af17f80d3daa53a632754efb553c36"}}]}] BACKPORT--> Co-authored-by: Ievgen Sorokopud <[email protected]>
Summary
With this changes I make "suggestions user profiles" API to be internal instead of public. We did not reveal it via documentation and it is better to mark it as an internal API.
This API was introduced in this PR #170579 and was not released yet.
I also realised that currently the route does not reflect the fact that it is finding user profiles:
/api/detection_engine/signals/_find
The new version will have
users
as part of the path:/internal/detection_engine/users/_find