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

[HTTP/OAS] Enable x-internal prop support in bundler's merge utility #198104

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

maximpn
Copy link
Contributor

@maximpn maximpn commented Oct 29, 2024

Summary

This PR enables support for x-internal property in OpenAPI documents when merging them by OpenAPI Bundler's merge utility. It will help to prevent leaks of internal/WIP parts of OpenAPI bundles which weren't processed by the OpenAPI Bundler at the earlier stages.

Details

@thomasneirynck brought up a Slack discussion (internal) regarding using of x-internal property in OpenAPI documents for excluding parts of API endpoint definitions. OpenAPI bundler supports it and uses it for bundling Security Solution OpenAPI bundles. This PR enables this functionality for the merge utility used to merge OpenAPI bundles sourced from different parts of Kibana to produce a single Kibana bundle.

@maximpn maximpn added release_note:skip Skip the PR/issue when compiling release notes v9.0.0 Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team 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.17.0 labels Oct 29, 2024
@maximpn maximpn requested a review from xcrzx October 29, 2024 04:58
@maximpn maximpn self-assigned this Oct 29, 2024
@maximpn maximpn marked this pull request as ready for review October 29, 2024 04:58
@maximpn maximpn requested a review from a team as a code owner October 29, 2024 04:58
@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

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

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

@maximpn maximpn marked this pull request as draft October 29, 2024 05:02
@elasticmachine
Copy link
Contributor

🤖 Jobs for this PR can be triggered through checkboxes. 🚧

ℹ️ To trigger the CI, please tick the checkbox below 👇

  • Click to trigger kibana-pull-request for this PR!
  • Click to trigger kibana-deploy-project-from-pr for this PR!

@elasticmachine
Copy link
Contributor

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] Jest Tests #10 / Timeline esql tab existing esql query is present should show the esql tab when the advanced setting is disabled

Metrics [docs]

✅ unchanged

cc @maximpn

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) 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: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.17.0 v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants