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

[DOCS] Add overlays for ML examples #3659

Merged
merged 2 commits into from
Jan 30, 2025
Merged

[DOCS] Add overlays for ML examples #3659

merged 2 commits into from
Jan 30, 2025

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Jan 30, 2025

Relates to #2482

This PR converts machine learning example files from JSON to YAML format (to be able to comment out unsupported fields).
It then updates the overlays to incorporate those examples in the OpenAPI output.

Verified

This commit was signed with the committer’s verified signature.
lcawl Lisa Cawley
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
ml.clear_trained_model_deployment_cache 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_calendar_event 🟢 4/4 4/4
ml.delete_calendar_job 🟢 3/3 3/3
ml.delete_calendar 🟢 5/5 5/5
ml.delete_data_frame_analytics 🟢 2/2 2/2
ml.delete_datafeed 🟢 3/3 3/3
ml.delete_expired_data 🟢 5/5 5/5
ml.delete_filter 🟢 27/27 27/27
ml.delete_forecast 🟢 3/3 3/3
ml.delete_job 🟢 47/47 47/47
ml.delete_model_snapshot 🟢 2/2 2/2
ml.delete_trained_model_alias 🟢 3/3 3/3
ml.delete_trained_model 🟢 5/5 5/5
ml.open_job 🟢 83/83 83/83
ml.put_job 🟢 227/227 225/225
nodes.info 🔴 114/114 1/114

You can validate these APIs yourself by using the make validate target.

Verified

This commit was signed with the committer’s verified signature.
lcawl Lisa Cawley
@lcawl lcawl marked this pull request as ready for review January 30, 2025 07:11
@lcawl lcawl requested review from a team as code owners January 30, 2025 07:11
@lcawl lcawl requested a review from a team January 30, 2025 07:12
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
ml.clear_trained_model_deployment_cache 🟢 1/1 1/1
ml.close_job 🟢 64/64 63/63
ml.delete_calendar_event 🟢 4/4 4/4
ml.delete_calendar_job 🟢 3/3 3/3
ml.delete_calendar 🟢 5/5 5/5
ml.delete_data_frame_analytics 🟢 2/2 2/2
ml.delete_datafeed 🟢 3/3 3/3
ml.delete_expired_data 🟢 5/5 5/5
ml.delete_filter 🟢 27/27 27/27
ml.delete_forecast 🟢 3/3 3/3
ml.delete_job 🟢 47/47 47/47
ml.delete_model_snapshot 🟢 2/2 2/2
ml.delete_trained_model_alias 🟢 3/3 3/3
ml.delete_trained_model 🟢 5/5 5/5
ml.estimate_model_memory 🟢 16/16 16/16
ml.evaluate_data_frame 🟢 15/15 15/15
ml.explain_data_frame_analytics 🟢 7/7 7/7
ml.open_job 🟢 83/83 83/83
ml.put_job 🟢 227/227 225/225
nodes.info 🔴 114/114 1/114

You can validate these APIs yourself by using the make validate target.

Copy link

@kilfoyle kilfoyle 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 merged commit 31d9111 into main Jan 30, 2025
8 checks passed
@lcawl lcawl deleted the examples-2 branch January 30, 2025 18:25
github-actions bot pushed a commit that referenced this pull request Jan 30, 2025
(cherry picked from commit 31d9111)
@lcawl lcawl restored the examples-2 branch January 30, 2025 18:42
@lcawl lcawl deleted the examples-2 branch January 30, 2025 18:45
lcawl added a commit that referenced this pull request Jan 30, 2025

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
(cherry picked from commit 31d9111)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants