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] Add description for task manager health API #184249

Merged
merged 3 commits into from
May 29, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 24, 2024

Summary

Relates to #180056

This PR an operation summary for the [get task manager healthAPI](https://www.elastic.co/guide/en/kibana/current/task-manager-api-health.html in the generated OpenAPI document.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -u elastic http://localhost:5601/api/oas\?pathStartsWith\=/api/task_manager | jq > test.json

The output will contain info like this:

 "paths": {
    "/api/task_manager/_health": {
      "get": {
        "summary": "Get task manager health",

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Feature:Task Manager Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) docs v8.15.0 labels May 24, 2024
@apmmachine
Copy link
Contributor

🤖 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 May 24, 2024 18:25
@lcawl lcawl requested a review from a team as a code owner May 24, 2024 18:25
@elasticmachine
Copy link
Contributor

Pinging @elastic/response-ops (Team:ResponseOps)

Copy link
Contributor

@ymao1 ymao1 left a comment

Choose a reason for hiding this comment

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

LGTM

@lcawl lcawl enabled auto-merge (squash) May 29, 2024 14:35
@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 f2a4bba into elastic:main May 29, 2024
34 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 29, 2024
rshen91 pushed a commit to rshen91/kibana that referenced this pull request May 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs Feature:Task Manager release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants