Skip to content

[DOCS] Add code snippet testing for more ML APIs #31404

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 19, 2018
Merged

[DOCS] Add code snippet testing for more ML APIs #31404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddeb68a
[DOCS] Test delete calendar event API
lcawl Jun 18, 2018
b67472b
[DOCS] Tests ML validate APIs
lcawl Jun 18, 2018
784770d
[DOCS] Removes comment from validate API
lcawl Jun 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions x-pack/docs/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ buildRestTests.expectedUnconvertedCandidates = [
'en/rest-api/license/delete-license.asciidoc',
'en/rest-api/license/update-license.asciidoc',
'en/ml/api-quickref.asciidoc',
'en/rest-api/ml/delete-calendar-event.asciidoc',
'en/rest-api/ml/delete-snapshot.asciidoc',
'en/rest-api/ml/forecast.asciidoc',
'en/rest-api/ml/get-bucket.asciidoc',
Expand All @@ -71,8 +70,6 @@ buildRestTests.expectedUnconvertedCandidates = [
'en/rest-api/ml/preview-datafeed.asciidoc',
'en/rest-api/ml/revert-snapshot.asciidoc',
'en/rest-api/ml/update-snapshot.asciidoc',
'en/rest-api/ml/validate-detector.asciidoc',
'en/rest-api/ml/validate-job.asciidoc',
'en/rest-api/watcher/stats.asciidoc',
'en/watcher/example-watches/watching-time-series-data.asciidoc',
]
Expand Down
3 changes: 2 additions & 1 deletion x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ calendar:
DELETE _xpack/ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st
--------------------------------------------------
// CONSOLE
// TEST[skip:automatically-generated ID]
// TEST[catch:missing]

When the event is removed, you receive the following results:
[source,js]
Expand All @@ -53,3 +53,4 @@ When the event is removed, you receive the following results:
"acknowledged": true
}
----
// NOTCONSOLE
3 changes: 1 addition & 2 deletions x-pack/docs/en/rest-api/ml/validate-detector.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ see <<ml-detectorconfig,detector configuration objects>>.
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].
//<<privileges-list-cluster>>.


==== Examples
Expand All @@ -45,7 +44,6 @@ POST _xpack/ml/anomaly_detectors/_validate/detector
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the validation completes, you receive the following results:
[source,js]
Expand All @@ -54,3 +52,4 @@ When the validation completes, you receive the following results:
"acknowledged": true
}
----
// TESTRESPONSE
3 changes: 1 addition & 2 deletions x-pack/docs/en/rest-api/ml/validate-job.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ see <<ml-job-resource,Job Resources>>.
You must have `manage_ml`, or `manage` cluster privileges to use this API.
For more information, see
{xpack-ref}/security-privileges.html[Security Privileges].
//<<privileges-list-cluster>>.
Copy link
Member

@davidkyle davidkyle Jun 19, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This same line is in validate-detector.asciidoc I guess that can also be removed



==== Examples
Expand Down Expand Up @@ -56,7 +55,6 @@ POST _xpack/ml/anomaly_detectors/_validate
}
--------------------------------------------------
// CONSOLE
// TEST[skip:todo]

When the validation is complete, you receive the following results:
[source,js]
Expand All @@ -65,3 +63,4 @@ When the validation is complete, you receive the following results:
"acknowledged": true
}
----
// TESTRESPONSE