Skip to content

OpenAPI docs for APM UI APIs#197946

Merged
miloszmarcinkowski merged 9 commits intoelastic:mainfrom
miloszmarcinkowski:197582-apmdocs-add-openapi-spec-for-undocumented-public-apis
Oct 31, 2024
Merged

OpenAPI docs for APM UI APIs#197946
miloszmarcinkowski merged 9 commits intoelastic:mainfrom
miloszmarcinkowski:197582-apmdocs-add-openapi-spec-for-undocumented-public-apis

Conversation

@miloszmarcinkowski
Copy link
Copy Markdown
Contributor

@miloszmarcinkowski miloszmarcinkowski commented Oct 28, 2024 •
edited by kibanamachine
Loading

Summary

Closes #197582

This PR adds missing OpenAPI specification for APM UI APIs.

Documentation specs have been divided into files per path. See readme for specific information.

@miloszmarcinkowski miloszmarcinkowski force-pushed the 197582-apmdocs-add-openapi-spec-for-undocumented-public-apis branch 5 times, most recently from e65c9b7 to f8e3ac5 Compare October 30, 2024 16:40
@miloszmarcinkowski miloszmarcinkowski added backport:prev-minor v9.0.0 v8.17.0 release_note:skip Skip the PR/issue when compiling release notes labels Oct 30, 2024
@miloszmarcinkowski miloszmarcinkowski force-pushed the 197582-apmdocs-add-openapi-spec-for-undocumented-public-apis branch from ffaf2bb to aa8a052 Compare October 31, 2024 10:17
@miloszmarcinkowski miloszmarcinkowski marked this pull request as ready for review October 31, 2024 11:12
@miloszmarcinkowski miloszmarcinkowski requested a review from a team October 31, 2024 11:12
@botelastic botelastic bot added ci:project-deploy-observability Create an Observability project Team:obs-ux-infra_services - DEPRECATED DEPRECATED - Use Team:obs-presentation. labels Oct 31, 2024
@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 31, 2024

Pinging @elastic/obs-ux-infra_services-team (Team:obs-ux-infra_services)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Oct 31, 2024

🤖 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!)

@miloszmarcinkowski
Copy link
Copy Markdown
Contributor Author

miloszmarcinkowski commented Oct 31, 2024

run docs-build

@miloszmarcinkowski miloszmarcinkowski force-pushed the 197582-apmdocs-add-openapi-spec-for-undocumented-public-apis branch from 796cd0f to 88e55f9 Compare October 31, 2024 11:32
jennypavlova
jennypavlova approved these changes Oct 31, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@jennypavlova jennypavlova left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 Thanks for adding that!

@elasticmachine
Copy link
Copy Markdown
Contributor

elasticmachine commented Oct 31, 2024 •
edited
Loading

💚 Build Succeeded

  • Buildkite Build
  • Commit: 88e55f9
  • Kibana Serverless Image: docker.elastic.co/kibana-ci/kibana-serverless:pr-197946-88e55f92f91e

Metrics [docs]

✅ unchanged

History

  • 💔 Build #247393 failed 796cd0f60f068b79547831e5a23aee764bb70cde

@miloszmarcinkowski miloszmarcinkowski merged commit e083814 into elastic:main Oct 31, 2024
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 31, 2024

Starting backport for target branches: 8.x

https://github.com/elastic/kibana/actions/runs/11613329997

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Oct 31, 2024

💔 All backports failed

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

Manual backport

To create the backport manually run:

node scripts/backport --pr 197946

Questions ?

Please refer to the Backport tool documentation

@miloszmarcinkowski miloszmarcinkowski mentioned this pull request Oct 31, 2024
Merged
miloszmarcinkowski added a commit that referenced this pull request Oct 31, 2024
@miloszmarcinkowski
OpenAPI docs for APM UI APIs - manual backport to 8.x (#198550)
fbee293 
## Summary

Manually backport #197946 into `8.x`.
@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Nov 4, 2024

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 197946 locally

@kibanamachine kibanamachine added the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 4, 2024
@miloszmarcinkowski
Copy link
Copy Markdown
Contributor Author

miloszmarcinkowski commented Nov 5, 2024

Manually backported to 8.x
#198550

@kibanamachine
Copy link
Copy Markdown
Contributor

kibanamachine commented Nov 5, 2024

Friendly reminder: Looks like this PR hasn’t been backported yet.
To create automatically backports add a backport:* label or prevent reminders by adding the backport:skip label.
You can also create backports manually by running node scripts/backport --pr 197946 locally

@miloszmarcinkowski miloszmarcinkowski added the backport:skip This PR does not require backporting label Nov 5, 2024
@kibanamachine kibanamachine removed the backport missing Added to PRs automatically when the are determined to be missing a backport. label Nov 5, 2024
This was referenced Nov 14, 2024
Merged
Merged
@kibanamachine kibanamachine mentioned this pull request Nov 25, 2024
Merged
1 task
@kibanamachine kibanamachine mentioned this pull request Dec 3, 2024
Merged
@kibanamachine kibanamachine mentioned this pull request Dec 17, 2024
Merged
This was referenced Mar 11, 2025
Merged
Merged
@kibanamachine kibanamachine mentioned this pull request Mar 26, 2025
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jennypavlova jennypavlova jennypavlova approved these changes

Assignees

No one assigned

Labels

backport:skip This PR does not require backporting ci:project-deploy-observability Create an Observability project release_note:skip Skip the PR/issue when compiling release notes Team:obs-ux-infra_services - DEPRECATED DEPRECATED - Use Team:obs-presentation. v8.17.0 v9.0.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[APM][Docs] Add OpenAPI spec for undocumented public APIs

4 participants

@miloszmarcinkowski @elasticmachine @kibanamachine @jennypavlova