[8.x] 🌊 Streams: Prepare API for publishing (#213127)#214415
Merged
flash1293 merged 3 commits intoelastic:8.xfrom Mar 13, 2025
Merged
[8.x] 🌊 Streams: Prepare API for publishing (#213127)#214415flash1293 merged 3 commits intoelastic:8.xfrom
flash1293 merged 3 commits intoelastic:8.xfrom
Conversation
Add streams API to documentation as an experimental feature <img width="2555" alt="Screenshot 2025-03-07 at 11 44 54" src="https://github.com/user-attachments/assets/f54e5e6e-0c20-4bad-9cff-27747d0f76e2" /> There are a couple of changes in here: * Split streams API in internal and public and mark the public parts as experimental * Add the public parts to the Kibana documentation * Add description and summary * Adjust the server repository wrapper to pass through summary and description # To test * Generate OAS bundle: `node scripts/capture_oas_snapshot --include-path /api/streams --update` * Apply overlays `cd oas_docs && make api-docs` * Make sure bump.sh is installed (`npm install -g bump-cli`) * Run for preview: `cd oas_docs && bump preview output/kibana.yaml` # Open questions * Does the split into public and internal make sense? * Is it a problem if this is visible in the user-facing documentation page before we actually release streams? Or would it be OK if the API is marked as experimental? (mostly a question for @LucaWintergerst ) --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> (cherry picked from commit 4681b6c) # Conflicts: # .buildkite/scripts/steps/checks/capture_oas_snapshot.sh # oas_docs/bundle.serverless.json # oas_docs/overlays/kibana.overlays.serverless.yaml # x-pack/platform/plugins/shared/streams/server/routes/streams/crud/route.ts # x-pack/platform/plugins/shared/streams/server/routes/streams/management/route.ts
miltonhultgren
approved these changes
Mar 13, 2025
…t --include-path /api/status --include-path /api/alerting/rule/ --include-path /api/alerting/rules --include-path /api/actions --include-path /api/security/role --include-path /api/spaces --include-path /api/dashboards --update --no-serverless'
Contributor
💚 Build Succeeded
Metrics [docs]Async chunks
History
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.x: