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.

Sign up for GitHub

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

Jump to bottom

[Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles #193669

Merged
merged 3 commits into from
Sep 24, 2024
Merged

[Security Solution] Omit Solution from tags and titles in Security Solution's OpenAPI bundles #193669

merged 3 commits into from
Sep 24, 2024

Conversation

maximpn
Copy link
Contributor

@maximpn maximpn commented Sep 23, 2024 •
edited by kibanamachine
Loading

Relates to: #184428

Summary

This PR omit Solution from from tag names and titles in Security Solution's OpenAPI bundles based on Security Docs team recommendation.

@maximpn maximpn added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 docs Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS v8.16.0 labels Sep 23, 2024
@maximpn maximpn self-assigned this Sep 23, 2024
@maximpn maximpn force-pushed the fix-security-solution-openapi-tags branch from 3057a28 to e729ceb Compare September 23, 2024 13:48
@maximpn maximpn marked this pull request as ready for review September 23, 2024 16:35
@maximpn maximpn requested review from a team as code owners September 23, 2024 16:35
@elasticmachine
Copy link
Contributor

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

janmonschke
janmonschke approved these changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@janmonschke janmonschke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THI changes look good to me!

tomsonpl
tomsonpl approved these changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@tomsonpl tomsonpl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Defend Workflows code changes LGTM 🚀 Thank you!

xcrzx
xcrzx approved these changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@xcrzx xcrzx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@maximpn Just curious, do we also drop "Solution" from our public docs as well?

@maximpn
Copy link
Contributor Author

maximpn commented Sep 24, 2024

Hi @xcrzx,

Just curious, do we also drop "Solution" from our public docs as well?

Checking Elastic Security Docs I can't easily spot Solution word. If it exists somewhere it makes sense to remove it for coherent naming and stick to Security/Elastic Security.

@maximpn maximpn force-pushed the fix-security-solution-openapi-tags branch from 4b33eef to 856ffb6 Compare September 24, 2024 14:15
@maximpn maximpn enabled auto-merge (squash) September 24, 2024 17:56
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

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

cc @maximpn

@maximpn maximpn merged commit 101fcfe into elastic:main Sep 24, 2024
40 checks passed
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
❌ 8.x Backport failed because of merge conflicts

You might need to backport the following PRs to 8.x:
- [Threat Hunting Investigations] Use OpenAPI types in more timeline routes (#189977)
- [Security Solution] Add a missing domain tag to Endpoint Exceptions API (#193019)

Manual backport

To create the backport manually run:

node scripts/backport --pr 193669

Questions ?

Please refer to the Backport tool documentation

@maximpn maximpn deleted the fix-security-solution-openapi-tags branch September 25, 2024 05:58
@kibanamachine kibanamachine mentioned this pull request Sep 25, 2024
Merged
4 tasks
@maximpn maximpn mentioned this pull request Sep 26, 2024
Merged
@maximpn
Copy link
Contributor Author

maximpn commented Sep 26, 2024

💚 All backports created successfully

Status Branch Result
✅ 8.x

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

Questions ?

Please refer to the Backport tool documentation

maximpn added a commit to maximpn/kibana that referenced this pull request Sep 26, 2024
@maximpn
[Security Solution] Omit Solution from tags and titles in Security …
b09dc6b 
…Solution's OpenAPI bundles (elastic#193669)

**Relates to:** elastic#184428

## Summary

This PR omit `Solution` from from tag names and titles in Security Solution's OpenAPI bundles based on Security Docs team recommendation.

(cherry picked from commit 101fcfe)

# Conflicts:
#	oas_docs/output/kibana.serverless.staging.yaml
#	oas_docs/output/kibana.staging.yaml
#	packages/kbn-securitysolution-lists-common/docs/openapi/ess/security_solution_lists_api_2023_10_31.bundled.schema.yaml
#	packages/kbn-securitysolution-lists-common/docs/openapi/serverless/security_solution_lists_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/osquery/docs/openapi/ess/osquery_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/osquery/docs/openapi/serverless/osquery_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/ess/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/ess/security_solution_timeline_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_entity_analytics_api_2023_10_31.bundled.schema.yaml
#	x-pack/plugins/security_solution/docs/openapi/serverless/security_solution_timeline_api_2023_10_31.bundled.schema.yaml
maximpn added a commit that referenced this pull request Sep 26, 2024
@maximpn
[8.x] [Security Solution] Omit Solution from tags and titles in Sec…
e0fca2a 
…urity Solution's OpenAPI bundles (#193669) (#194088)

# Backport

This will backport the following commits from `main` to `8.x`:
- [[Security Solution] Omit `Solution` from tags and titles in Security
Solution's OpenAPI bundles
(#193669)](#193669)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Maxim
Palenov","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-09-24T19:23:00Z","message":"[Security
Solution] Omit `Solution` from tags and titles in Security Solution's
OpenAPI bundles (#193669)\n\n**Relates to:**
https://github.com/elastic/kibana/issues/184428\r\n\r\n##
Summary\r\n\r\nThis PR omit `Solution` from from tag names and titles in
Security Solution's OpenAPI bundles based on Security Docs team
recommendation.","sha":"101fcfe43697270483a13d6a9b4bafeb92447bde","branchLabelMapping":{"^v9.0.0$":"main","^v8.16.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","docs","Team:
SecuritySolution","backport:prev-minor","Feature:OAS","v8.16.0"],"number":193669,"url":"https://github.com/elastic/kibana/pull/193669","mergeCommit":{"message":"[Security
Solution] Omit `Solution` from tags and titles in Security Solution's
OpenAPI bundles (#193669)\n\n**Relates to:**
https://github.com/elastic/kibana/issues/184428\r\n\r\n##
Summary\r\n\r\nThis PR omit `Solution` from from tag names and titles in
Security Solution's OpenAPI bundles based on Security Docs team
recommendation.","sha":"101fcfe43697270483a13d6a9b4bafeb92447bde"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/193669","number":193669,"mergeCommit":{"message":"[Security
Solution] Omit `Solution` from tags and titles in Security Solution's
OpenAPI bundles (#193669)\n\n**Relates to:**
https://github.com/elastic/kibana/issues/184428\r\n\r\n##
Summary\r\n\r\nThis PR omit `Solution` from from tag names and titles in
Security Solution's OpenAPI bundles based on Security Docs team
recommendation.","sha":"101fcfe43697270483a13d6a9b4bafeb92447bde"}},{"branch":"8.x","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tomsonpl tomsonpl tomsonpl approved these changes

@hop-dev hop-dev hop-dev approved these changes

@xcrzx xcrzx xcrzx approved these changes

@ashokaditya ashokaditya ashokaditya approved these changes

@dhurley14 dhurley14 dhurley14 approved these changes

@janmonschke janmonschke janmonschke approved these changes

@natasha-moore-elastic natasha-moore-elastic Awaiting requested review from natasha-moore-elastic

Assignees

@maximpn maximpn

Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS release_note:skip Skip the PR/issue when compiling release notes Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.16.0 v9.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@maximpn @elasticmachine @kibana-ci @kibanamachine @janmonschke @dhurley14 @ashokaditya @xcrzx @hop-dev @tomsonpl