[ML] Replace apiDoc annotations with routes definitions for OpenAPI spec generation #190840
Merged
darnautov merged 21 commits intoelastic:mainfrom Aug 23, 2024
Merged
[ML] Replace apiDoc annotations with routes definitions for OpenAPI spec generation #190840darnautov merged 21 commits intoelastic:mainfrom
darnautov merged 21 commits intoelastic:mainfrom
Conversation
darnautov
added
:ml
release_note:skip
Contributor
|
Pinging @elastic/ml-ui (:ml) |
| * @apiSchema (params) recognizeModulesSchema | ||
| * @apiSchema (query) moduleFilterSchema | ||
| * @apiSuccess {object[]} modules Array of objects describing the modules which match the index pattern, sorted by module ID. | ||
| * @apiSuccessExample {json} Success-Response: |
Contributor
There was a problem hiding this comment.
What sort of info will be displayed now for an example response like this? Just wondering as these examples from the modules route are quite rich in information in showing you the structure of a module.
Contributor
Author
|
@elasticmachine merge upstream |
Contributor
|
It looks like some auto-formatting in |
Contributor
Author
walterra
approved these changes
Aug 23, 2024
Contributor
walterra
left a comment
walterra
left a comment
There was a problem hiding this comment.
LGTM! I was able to follow the setup steps and call the oas endpoint.
peteharverson
approved these changes
Aug 23, 2024
Contributor
peteharverson
left a comment
peteharverson
left a comment
There was a problem hiding this comment.
LGTM. Great work setting this up!
💛 Build succeeded, but was flaky
Failed CI Steps
Test Failures
Metrics [docs]Unknown metric groupsESLint disabled line counts
Total ESLint disabled count
History
To update your PR or re-run it, just comment with: cc @darnautov |
darnautov
added a commit
that referenced
this pull request
Aug 30, 2024
## Summary Fixes an issue introduced in #190840 where the module endpoint had a wrong type definition for validation the response causing the Rules page in Security plugin to crash.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
apidoc-markdowndependency and custom scripts for generating internal documentation for ML Kibana endpointssummaryanddescriptionprops for route handlers and kbn-schemas to generate an OpenAPI spec file/internal/ml/jobs/delete_jobsroute was not versioned for some reason, I changed thatHow to test
kibana.dev.yml