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

[OAS][ML] Add sync API tags and description, minor OpenAPI fixes #189230

Merged
merged 5 commits into from
Jul 26, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 25, 2024

Summary

This PR:

  • adds a tag value and description copied from https://www.elastic.co/guide/en/kibana/current/machine-learning-api-sync.html so it'll appear in the generated openAPI document.
  • removes the /s/space-id version of the paths from the manually-maintained openAPI document, since per discussions elsewhere that info will be omitted from the generated document and will be covered in an introductory page instead.
  • removes the securitySchema details from the manually-maintained openAPI document, since it can inherit the document-level security information instead when it's joined with the rest of the Kibana APIs

@lcawl lcawl added :ml release_note:skip Skip the PR/issue when compiling release notes docs backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS labels Jul 25, 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 July 25, 2024 22:01
@lcawl lcawl requested review from a team as code owners July 25, 2024 22:01
@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

Copy link
Contributor

@karenzone karenzone 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) July 26, 2024 15:05
@elastic-vault-github-plugin-prod elastic-vault-github-plugin-prod bot requested a review from a team as a code owner July 26, 2024 16:29
@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 841e95c into elastic:main Jul 26, 2024
19 checks passed
@lcawl lcawl deleted the ml-tags branch July 26, 2024 20:32
@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:
- Observability Onboarding: Show otel tile on integrations page (#189163)
- [Search] Fix index error incorrectly showing up (#189283)
- [Search] Add index errors in Search Index page (#188682)

Manual backport

To create the backport manually run:

node scripts/backport --pr 189230

Questions ?

Please refer to the Backport tool documentation

@lcawl
Copy link
Contributor Author

lcawl commented Jul 26, 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 Jul 29, 2024
…es (#189230) (#189320)

# Backport

This will backport the following commits from `main` to `8.15`:
- [[OAS][ML] Add sync API tags and description, minor OpenAPI fixes
(#189230)](#189230)

<!--- Backport version: 8.9.8 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-07-26T20:28:43Z","message":"[OAS][ML]
Add sync API tags and description, minor OpenAPI fixes
(#189230)","sha":"841e95c64b6fa29e680906140e356be43e73f75c","branchLabelMapping":{"^v8.16.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":[":ml","release_note:skip","docs","backport:prev-minor","Feature:OAS","v8.16.0"],"number":189230,"url":"https://github.com/elastic/kibana/pull/189230","mergeCommit":{"message":"[OAS][ML]
Add sync API tags and description, minor OpenAPI fixes
(#189230)","sha":"841e95c64b6fa29e680906140e356be43e73f75c"}},"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/189230","number":189230,"mergeCommit":{"message":"[OAS][ML]
Add sync API tags and description, minor OpenAPI fixes
(#189230)","sha":"841e95c64b6fa29e680906140e356be43e73f75c"}}]}]
BACKPORT-->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:prev-minor Backport to (8.x) the previous minor version (i.e. one version back from main) docs Feature:OAS Work or issues related to Core-provided mechanisms for generating OAS :ml release_note:skip Skip the PR/issue when compiling release notes v8.15.0 v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants