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

[DOCS][OAS] Add Fleet APIs #190571

Merged
merged 11 commits into from
Aug 15, 2024
Merged

[DOCS][OAS] Add Fleet APIs #190571

merged 11 commits into from
Aug 15, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Aug 15, 2024 •
edited by kibanamachine
Loading

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:

  • Verify display names that I've added for the tags
  • Add descriptions for each tag
  • Verify that this content is not applicable to serverless

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team docs backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) labels Aug 15, 2024
@obltmachine
Copy link

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review August 15, 2024 02:18
@lcawl lcawl requested a review from a team as a code owner August 15, 2024 02:18
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@lcawl lcawl requested a review from kpollich August 15, 2024 02:19
kpollich
kpollich reviewed Aug 15, 2024
View reviewed changes
Copy link
Member

@kpollich kpollich left a comment

Choose a reason for hiding this comment

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

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
kpollich approved these changes Aug 15, 2024
View reviewed changes
Copy link
Member

@kpollich kpollich left a comment

Choose a reason for hiding this comment

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

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 🚀

kilfoyle
kilfoyle approved these changes Aug 15, 2024
View reviewed changes
Copy link
Contributor

@kilfoyle kilfoyle left a comment

Choose a reason for hiding this comment

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

LGTM! 🦕
These look great!

@lcawl lcawl enabled auto-merge (squash) August 15, 2024 16:23
@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

@lcawl lcawl merged commit 444b8d0 into elastic:main Aug 15, 2024
21 checks passed
@lcawl lcawl deleted the fleet-apis branch August 15, 2024 17:52
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
❌ 8.15 Backport failed because of merge conflicts

You might need to backport the following PRs to 8.15:
- [HTTP/OAS] Merge OpenAPI specs by using kbn-openapi-bundler (#189262)

Manual backport

To create the backport manually run:

node scripts/backport --pr 190571

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit to lcawl/kibana that referenced this pull request Aug 15, 2024
@lcawl
[DOCS][OAS] Add Fleet APIs (elastic#190571)
e98ea43 
(cherry picked from commit 444b8d0)
@lcawl lcawl mentioned this pull request Aug 15, 2024
Merged
@lcawl
Copy link
Contributor Author

lcawl commented Aug 15, 2024

💚 All backports created successfully

Status Branch Result
✅ 8.15

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

Questions ?

Please refer to the Backport tool documentation

lcawl added a commit that referenced this pull request Aug 15, 2024
@lcawl
[8.15] [DOCS][OAS] Add Fleet APIs (#190571) (#190639)
e3bb56c 
# 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":"[email protected]"},"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-->
@juliaElastic juliaElastic mentioned this pull request Sep 11, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kilfoyle kilfoyle kilfoyle approved these changes

@kpollich kpollich kpollich approved these changes

Assignees
No one assigned
Labels
backport:prev-minor Backport to (9.0) the previous minor version (i.e. one version back from main) docs release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.15.1 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@lcawl @obltmachine @elasticmachine @kibana-ci @kibanamachine @kpollich @kilfoyle