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 descriptions for upgrade assistant APIs #184269

Merged
merged 2 commits into from
May 28, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 24, 2024

Summary

Relates to #180056

This PR adds operation summaries for the upgrade assistant APIs 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/upgrade_assistant | jq > test.json
    "/api/upgrade_assistant/reindex/{indexName}": {
      "post": {
        "summary": "Start or resume reindex",

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes Feature:Upgrade Assistant 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 22:56
@lcawl lcawl requested a review from a team as a code owner May 24, 2024 22:56
@lcawl lcawl enabled auto-merge (squash) May 28, 2024 00:37
@kibana-ci
Copy link
Collaborator

💛 Build succeeded, but was flaky

Failed CI Steps

Test Failures

  • [job] [logs] FTR Configs #45 / endpoint "before all" hook in "endpoint"

Metrics [docs]

✅ unchanged

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

@lcawl lcawl merged commit e595d28 into elastic:main May 28, 2024
18 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 28, 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:Upgrade Assistant release_note:skip Skip the PR/issue when compiling release notes v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants