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

Switch "suggest user profiles" API to internal use #173141

Merged
merged 4 commits into from
Dec 13, 2023

Conversation

e40pud
Copy link
Contributor

@e40pud e40pud commented Dec 12, 2023

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

@e40pud e40pud added release_note:skip Skip the PR/issue when compiling release notes Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Engine Security Solution Detection Engine Area labels Dec 12, 2023
@e40pud e40pud self-assigned this Dec 12, 2023
@e40pud e40pud requested a review from a team as a code owner December 12, 2023 10:44
@elasticmachine
Copy link
Contributor

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

@e40pud e40pud requested review from yctercero, marshallmain and a team December 12, 2023 10:45
@e40pud e40pud added the backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) label Dec 12, 2023
Copy link
Contributor

@yctercero yctercero left a 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?

@e40pud
Copy link
Contributor Author

e40pud commented Dec 12, 2023

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.

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id before after diff
securitySolution 66.9KB 66.9KB +6.0B

History

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

cc @e40pud

@e40pud e40pud merged commit 7e168c7 into elastic:main Dec 13, 2023
36 checks passed
kibanamachine pushed a commit to kibanamachine/kibana that referenced this pull request Dec 13, 2023
## 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)
@kibanamachine
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
8.12

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

kibanamachine added a commit that referenced this pull request Dec 13, 2023
…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]>
@e40pud e40pud deleted the security/bugfix/internal-find-users-api branch December 13, 2023 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) release_note:skip Skip the PR/issue when compiling release notes Team:Detection Engine Security Solution Detection Engine Area Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.12.0 v8.13.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants