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 ML sync API description #184154

Merged
merged 2 commits into from
May 24, 2024
Merged

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 23, 2024

Summary

Relates to #180056

This PR adds a string that gets output as the operation summary 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 -uelastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/ml | jq > test.json

The output will contain info like this:

   "paths": {
    "/api/ml/saved_objects/sync": {
      "get": {
        "summary": "Synchronize machine learning saved objects",

@lcawl lcawl added :ml release_note:skip Skip the PR/issue when compiling release notes docs v8.15.0 labels May 23, 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 23, 2024 19:20
@lcawl lcawl requested a review from a team as a code owner May 23, 2024 19:20
@elasticmachine
Copy link
Contributor

Pinging @elastic/ml-ui (:ml)

Copy link
Contributor

@peteharverson peteharverson 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 24, 2024 16:10
@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

@lcawl lcawl merged commit 7de4fef into elastic:main May 24, 2024
17 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 24, 2024
@lcawl lcawl deleted the ml-descriptions branch May 24, 2024 19:53
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 :ml 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.

6 participants