Conversation
lcawl
added
release_note:skip
🤖 GitHub commentsExpand to view the GitHub comments
Just comment with:
|
|
Pinging @elastic/fleet (Team:Fleet) |
kpollich
left a comment
kpollich
left a comment
There was a problem hiding this comment.
The display names here look good to me, and I'm sure we can iterate on these moving forward. I do think this might get blown away when we run our OpenAPI build script though on the Fleet side.
What do we need to do on the Fleet side to make sure we're updating these docs as APIs change? We're planning to take on #184685 in a few weeks, which will replace our current manual compilation process for the bundled.yaml/json files with an automated one.
If we ensure the result of the code gen tooling is outputing to the same fleet/common/openapi/bundled.yaml file, it seems like we wouldn't have to do anything and the merge_ess_oas.js script would take care of building the kibana.yaml spec file served by bump.sh, right?
I'm rubber ducking 🦆 in this GitHub comment as I read through the PR, but please let me know if I've gotten anything wrong, and if the Fleet team needs to make any process changes on our side to integrate better with these docs.
I'm so incredibly excited to be able to publish these docs in a friendly interface!
kpollich
left a comment
kpollich
left a comment
There was a problem hiding this comment.
I do think this might get blown away when we run our OpenAPI build script though on the Fleet side.
This does not happen so we're all good here! Just confirmed pulling down this branch
LGTM from me 🚀
💚 Build Succeeded
Metrics [docs]
History
To update your PR or re-run it, just comment with: |
💔 All backports failed
Manual backportTo create the backport manually run: Questions ?Please refer to the Backport tool documentation |
(cherry picked from commit 444b8d0)
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
# Backport This will backport the following commits from `main` to `8.15`: - [[DOCS][OAS] Add Fleet APIs (#190571)](#190571) <!--- Backport version: 8.9.8 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Lisa Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-08-15T17:49:58Z","message":"[DOCS][OAS] Add Fleet APIs (#190571)","sha":"444b8d010e5b3d82e1545d63adcb60e4476e5c43","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","Team:Fleet","docs","backport:prev-minor","v8.16.0"],"number":190571,"url":"https://github.com/elastic/kibana/pull/190571","mergeCommit":{"message":"[DOCS][OAS] Add Fleet APIs (#190571)","sha":"444b8d010e5b3d82e1545d63adcb60e4476e5c43"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.16.0","labelRegex":"^v8.16.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/190571","number":190571,"mergeCommit":{"message":"[DOCS][OAS] Add Fleet APIs (#190571)","sha":"444b8d010e5b3d82e1545d63adcb60e4476e5c43"}}]}] BACKPORT-->
7 participants
Summary
This PR merges content from https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/openapi/bundled.json into the OpenAPI documents in oas_docs so that it can be published on https://www.elastic.co/docs/api/doc/kibana
It also fixes some linting rules that were failing erroneously on common parameters.
The following tasks are still outstanding: