From d3ddedf9fc3a1807c2737b2887aacaade7822e84 Mon Sep 17 00:00:00 2001
From: Dimitris Athanasiou <dimitris@elastic.co>
Date: Sat, 6 Jul 2019 02:03:29 +0300
Subject: [PATCH] [7.x][ML] Add missing doc links to df-analytics rest spec and
 HLRC javadocs (#44025) (#44033)

---
 .../client/MachineLearningClient.java         | 42 ++++++++++++-------
 .../api/ml.delete_data_frame_analytics.json   |  1 +
 .../api/ml.evaluate_data_frame.json           |  1 +
 .../api/ml.get_data_frame_analytics.json      |  1 +
 .../ml.get_data_frame_analytics_stats.json    |  1 +
 .../api/ml.put_data_frame_analytics.json      |  1 +
 .../api/ml.start_data_frame_analytics.json    |  1 +
 .../api/ml.stop_data_frame_analytics.json     |  1 +
 8 files changed, 35 insertions(+), 14 deletions(-)

diff --git a/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java b/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java
index ea72c355a02..0861e4b7b77 100644
--- a/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java
+++ b/client/rest-high-level/src/main/java/org/elasticsearch/client/MachineLearningClient.java
@@ -1894,7 +1894,8 @@ public final class MachineLearningClient {
      * Creates a new Data Frame Analytics config
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">PUT Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html">
+     *     PUT Data Frame Analytics documentation</a>
      *
      * @param request The {@link PutDataFrameAnalyticsRequest} containing the
      * {@link org.elasticsearch.client.ml.dataframe.DataFrameAnalyticsConfig}
@@ -1916,7 +1917,8 @@ public final class MachineLearningClient {
      * Creates a new Data Frame Analytics config asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">PUT Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html">
+     *     PUT Data Frame Analytics documentation</a>
      *
      * @param request The {@link PutDataFrameAnalyticsRequest} containing the
      * {@link org.elasticsearch.client.ml.dataframe.DataFrameAnalyticsConfig}
@@ -1937,7 +1939,8 @@ public final class MachineLearningClient {
      * Gets a single or multiple Data Frame Analytics configs
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">GET Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html">
+     *     GET Data Frame Analytics documentation</a>
      *
      * @param request The {@link GetDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1957,7 +1960,8 @@ public final class MachineLearningClient {
      * Gets a single or multiple Data Frame Analytics configs asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">GET Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html">
+     *     GET Data Frame Analytics documentation</a>
      *
      * @param request The {@link GetDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1977,7 +1981,8 @@ public final class MachineLearningClient {
      * Gets the running statistics of a Data Frame Analytics
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">GET Data Frame Analytics Stats documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html">
+     *     GET Data Frame Analytics Stats documentation</a>
      *
      * @param request The {@link GetDataFrameAnalyticsStatsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -1996,7 +2001,8 @@ public final class MachineLearningClient {
      * Gets the running statistics of a Data Frame Analytics asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">GET Data Frame Analytics Stats documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html">
+     *     GET Data Frame Analytics Stats documentation</a>
      *
      * @param request The {@link GetDataFrameAnalyticsStatsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2016,7 +2022,8 @@ public final class MachineLearningClient {
      * Starts Data Frame Analytics
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Start Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html">
+     *     Start Data Frame Analytics documentation</a>
      *
      * @param request The {@link StartDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2036,7 +2043,8 @@ public final class MachineLearningClient {
      * Starts Data Frame Analytics asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Start Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html">
+     *     Start Data Frame Analytics documentation</a>
      *
      * @param request The {@link StartDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2056,7 +2064,8 @@ public final class MachineLearningClient {
      * Stops Data Frame Analytics
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Stop Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html">
+     *     Stop Data Frame Analytics documentation</a>
      *
      * @param request The {@link StopDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2076,7 +2085,8 @@ public final class MachineLearningClient {
      * Stops Data Frame Analytics asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Stop Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html">
+     *     Stop Data Frame Analytics documentation</a>
      *
      * @param request The {@link StopDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2096,7 +2106,8 @@ public final class MachineLearningClient {
      * Deletes the given Data Frame Analytics config
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">DELETE Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html">
+     *     DELETE Data Frame Analytics documentation</a>
      *
      * @param request The {@link DeleteDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2116,7 +2127,8 @@ public final class MachineLearningClient {
      * Deletes the given Data Frame Analytics config asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">DELETE Data Frame Analytics documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html">
+     *     DELETE Data Frame Analytics documentation</a>
      *
      * @param request The {@link DeleteDataFrameAnalyticsRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2136,7 +2148,8 @@ public final class MachineLearningClient {
      * Evaluates the given Data Frame
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Evaluate Data Frame documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html">
+     *     Evaluate Data Frame documentation</a>
      *
      * @param request The {@link EvaluateDataFrameRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
@@ -2156,7 +2169,8 @@ public final class MachineLearningClient {
      * Evaluates the given Data Frame asynchronously and notifies listener upon completion
      * <p>
      * For additional info
-     * see <a href="https://www.TODO.com">Evaluate Data Frame documentation</a>
+     * see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html">
+     *     Evaluate Data Frame documentation</a>
      *
      * @param request The {@link EvaluateDataFrameRequest}
      * @param options Additional request options (e.g. headers), use {@link RequestOptions#DEFAULT} if nothing needs to be customized
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json
index cf4d0ed4ec7..f5db2405df7 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.delete_data_frame_analytics.json
@@ -1,5 +1,6 @@
 {
   "ml.delete_data_frame_analytics": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/delete-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "DELETE" ],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.evaluate_data_frame.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.evaluate_data_frame.json
index fb6e5ca5156..416887c003d 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.evaluate_data_frame.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.evaluate_data_frame.json
@@ -1,5 +1,6 @@
 {
   "ml.evaluate_data_frame": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "POST" ],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics.json
index dfb8de1310d..c42e36737e9 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics.json
@@ -1,5 +1,6 @@
 {
   "ml.get_data_frame_analytics": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "GET"],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json
index 4ae7b754403..f8fad160f89 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.get_data_frame_analytics_stats.json
@@ -1,5 +1,6 @@
 {
   "ml.get_data_frame_analytics_stats": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/get-dfanalytics-stats.html",
     "stability": "experimental",
     "methods": [ "GET"],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.put_data_frame_analytics.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.put_data_frame_analytics.json
index 5cee69e3ab9..c7566a42ae0 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.put_data_frame_analytics.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.put_data_frame_analytics.json
@@ -1,5 +1,6 @@
 {
   "ml.put_data_frame_analytics": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/put-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "PUT" ],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.start_data_frame_analytics.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.start_data_frame_analytics.json
index 3436623c61b..a6c5f308540 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.start_data_frame_analytics.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.start_data_frame_analytics.json
@@ -1,5 +1,6 @@
 {
   "ml.start_data_frame_analytics": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/start-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "POST" ],
     "url": {
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json
index ee1a9c85be4..d90479bac60 100644
--- a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json
+++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.stop_data_frame_analytics.json
@@ -1,5 +1,6 @@
 {
   "ml.stop_data_frame_analytics": {
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/stop-dfanalytics.html",
     "stability": "experimental",
     "methods": [ "POST" ],
     "url": {