From b0a1e5c1e007e1d630af03e24ade5dd1d6396263 Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 25 Jul 2019 09:25:13 -0700 Subject: [PATCH 1/2] [DOCS] Minor edits to data frame transform APIs --- .../high-level/dataframe/delete_data_frame.asciidoc | 2 ++ docs/java-rest/high-level/dataframe/get_data_frame.asciidoc | 2 +- .../high-level/dataframe/get_data_frame_stats.asciidoc | 5 ++--- .../high-level/dataframe/preview_data_frame.asciidoc | 3 +-- docs/java-rest/high-level/dataframe/put_data_frame.asciidoc | 2 +- .../java-rest/high-level/dataframe/start_data_frame.asciidoc | 2 +- docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc index 4699d165e6015..5f04aa03718b5 100644 --- a/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/delete_data_frame.asciidoc @@ -6,6 +6,8 @@ [id="{upid}-{api}"] === Delete {dataframe-transform} API +Deletes an existing {dataframe-transform}. + [id="{upid}-{api}-request"] ==== Delete {dataframe-transform} request diff --git a/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc index ba4103e2fc42e..160dc378e729a 100644 --- a/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/get_data_frame.asciidoc @@ -6,7 +6,7 @@ [id="{upid}-{api}"] === Get {dataframe-transform} API -The get {dataframe-transform} API is used get one or more {dataframe-transforms}. +Retrieves configuration information about one or more {dataframe-transforms}. The API accepts a +{request}+ object and returns a +{response}+. [id="{upid}-{api}-request"] diff --git a/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc b/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc index 4c68d352606b8..578ea808b9e3d 100644 --- a/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc +++ b/docs/java-rest/high-level/dataframe/get_data_frame_stats.asciidoc @@ -6,8 +6,7 @@ [id="{upid}-{api}"] === Get {dataframe-transform} stats API -The get {dataframe-transform} stats API is used read the operational statistics -of one or more {dataframe-transforms}. +Retrieves the operational statistics of one or more {dataframe-transforms}. The API accepts a +{request}+ object and returns a +{response}+. [id="{upid}-{api}-request"] @@ -22,7 +21,7 @@ include-tagged::{doc-tests-file}[{api}-request] -------------------------------------------------- <1> Constructing a new GET Stats request referencing an existing {dataframe-transform} -==== Optional Arguments +==== Optional arguments The following arguments are optional. diff --git a/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc index 88f5fc9ad2e34..26453e5d4968f 100644 --- a/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/preview_data_frame.asciidoc @@ -6,8 +6,7 @@ [id="{upid}-{api}"] === Preview {dataframe-transform} API -The preview {dataframe-transform} API is used to preview the results of -a {dataframe-transform}. +Previews the results of a {dataframe-transform}. The API accepts a +{request}+ object as a request and returns a +{response}+. diff --git a/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc index 293722aa65bec..2de25fde30e2c 100644 --- a/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/put_data_frame.asciidoc @@ -6,7 +6,7 @@ [id="{upid}-{api}"] === Put {dataframe-transform} API -The put {dataframe-transform} API is used to create a new {dataframe-transform}. +Creates a new {dataframe-transform}. The API accepts a +{request}+ object as a request and returns a +{response}+. diff --git a/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc index eeb2c2eeb6112..b62f410180c1d 100644 --- a/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/start_data_frame.asciidoc @@ -6,7 +6,7 @@ [id="{upid}-{api}"] === Start {dataframe-transform} API -Start a {dataframe-transform}. +Starts a {dataframe-transform}. It accepts a +{request}+ object and responds with a +{response}+ object. [id="{upid}-{api}-request"] diff --git a/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc b/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc index 60981a17a8fb2..af364501d0d41 100644 --- a/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc +++ b/docs/java-rest/high-level/dataframe/stop_data_frame.asciidoc @@ -6,7 +6,7 @@ [id="{upid}-{api}"] === Stop {dataframe-transform} API -Stop a started {dataframe-transform}. +Stops a started {dataframe-transform}. It accepts a +{request}+ object and responds with a +{response}+ object. [id="{upid}-{api}-request"] From b231fcdbafff548f3fa07d09cec1bdd3e62a950a Mon Sep 17 00:00:00 2001 From: lcawl Date: Thu, 25 Jul 2019 09:29:23 -0700 Subject: [PATCH 2/2] [DOCS] Minor edits in HLRC delete job API --- docs/java-rest/high-level/ml/delete-job.asciidoc | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/java-rest/high-level/ml/delete-job.asciidoc b/docs/java-rest/high-level/ml/delete-job.asciidoc index 06c82c0a11258..300b3edef686b 100644 --- a/docs/java-rest/high-level/ml/delete-job.asciidoc +++ b/docs/java-rest/high-level/ml/delete-job.asciidoc @@ -27,9 +27,8 @@ The following arguments are optional: --------------------------------------------------- include-tagged::{doc-tests-file}[{api}-request-force] --------------------------------------------------- -<1> Use to forcefully delete an opened job; -this method is quicker than closing and deleting the job. -Defaults to `false`. +<1> Use to forcefully delete an opened job. This method is quicker than closing +and deleting the job. Defaults to `false`. ["source","java",subs="attributes,callouts,macros"] --------------------------------------------------- @@ -50,9 +49,9 @@ for completion: --------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] --------------------------------------------------- -<1> whether was job deletion was acknowledged or not; will be `null` when set -not to wait for completion -<2> the id of the job deletion task; will be `null` when set to wait for -completion +<1> Whether job deletion was acknowledged or not. It will be `null` when set +to not wait for completion. +<2> The ID of the job deletion task. It will be `null` when set to wait for +completion. include::../execution.asciidoc[]