Fix some documentation urls in rest-api-spec (#40618) (#41145)

nik9000 · web-flow · commit c379206c1e2b · 2019-04-12T10:11:14.000-04:00
Fixes some documentation urls in the rest-api-spec. Some of these URLs
pointed to 404s and a few others pointed to deprecated documentation
when we have better documentation now. I'm not consistent about `master`
vs `current` because we're not consistent in other places and I think we
should solve all of those at once with something a little more
automatic.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.delete_pipeline.json
@@ -1,6 +1,6 @@
 {
   "ingest.delete_pipeline": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html",
     "methods": [ "DELETE" ],
     "url": {
       "path": "/_ingest/pipeline/{id}",
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.get_pipeline.json
@@ -1,6 +1,6 @@
 {
   "ingest.get_pipeline": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html",
     "methods": [ "GET" ],
     "url": {
       "path": "/_ingest/pipeline/{id}",
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.processor_grok.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.processor_grok.json
@@ -1,6 +1,6 @@
 {
   "ingest.processor_grok": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get",
     "methods": [ "GET" ],
     "url": {
       "path": "/_ingest/processor/grok",
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.put_pipeline.json
@@ -1,6 +1,6 @@
 {
   "ingest.put_pipeline": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html",
     "methods": [ "PUT" ],
     "url": {
       "path": "/_ingest/pipeline/{id}",
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.simulate.json b/rest-api-spec/src/main/resources/rest-api-spec/api/ingest.simulate.json
@@ -1,6 +1,6 @@
 {
   "ingest.simulate": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html",
     "methods": [ "GET", "POST" ],
     "url": {
       "path": "/_ingest/pipeline/_simulate",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.delete.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.delete.json
@@ -1,6 +1,6 @@
 {
   "license.delete": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html",
     "methods": ["DELETE"],
     "url": {
       "path": "/_license",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get.json
@@ -1,6 +1,6 @@
 {
   "license.get": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html",
     "methods": ["GET"],
     "url": {
       "path": "/_license",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get_basic_status.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get_basic_status.json
@@ -1,6 +1,6 @@
 {
   "license.get_basic_status": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html",
     "methods": ["GET"],
     "url": {
       "path": "/_license/basic_status",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get_trial_status.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.get_trial_status.json
@@ -1,6 +1,6 @@
 {
   "license.get_trial_status": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html",
     "methods": ["GET"],
     "url": {
       "path": "/_license/trial_status",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post.json
@@ -1,6 +1,6 @@
 {
   "license.post": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html",
     "methods": ["PUT", "POST"],
     "url": {
       "path": "/_license",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post_start_basic.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post_start_basic.json
@@ -1,6 +1,6 @@
 {
   "license.post_start_basic": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-basic.html",
     "methods": ["POST"],
     "url": {
       "path": "/_license/start_basic",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post_start_trial.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/license.post_start_trial.json
@@ -1,6 +1,6 @@
 {
   "license.post_start_trial": {
-    "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/start-trial.html",
     "methods": ["POST"],
     "url": {
       "path": "/_license/start_trial",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/migration.deprecations.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/migration.deprecations.json
@@ -1,6 +1,6 @@
 {
   "migration.deprecations": {
-    "documentation": "http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html",
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-deprecation.html",
     "methods": [ "GET" ],
     "url": {
       "path": "/{index}/_migration/deprecations",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.find_file_structure.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/ml.find_file_structure.json
@@ -1,6 +1,6 @@
 {
   "ml.find_file_structure": {
-    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-file-structure.html",
+    "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/current/ml-find-file-structure.html",
     "methods": [ "POST" ],
     "url": {
       "path": "/_ml/find_file_structure",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/monitoring.bulk.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/monitoring.bulk.json
@@ -1,6 +1,6 @@
 {
   "monitoring.bulk": {
-    "documentation": "http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/es-monitoring.html",
     "methods": ["POST", "PUT"],
     "url": {
       "path": "/_monitoring/bulk",
diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/security.get_user_privileges.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/security.get_user_privileges.json
@@ -1,6 +1,6 @@
 {
   "security.get_user_privileges": {
-    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-user-privileges.html",
+    "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-get-privileges.html",
     "methods": [ "GET" ],
     "url": {
       "path": "/_security/user/_privileges",

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ingest.delete_pipeline": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-pipeline-api.html",`
`4`	`4`	`"methods": [ "DELETE" ],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_ingest/pipeline/{id}",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ingest.get_pipeline": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-pipeline-api.html",`
`4`	`4`	`"methods": [ "GET" ],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_ingest/pipeline/{id}",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ingest.processor_grok": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/grok-processor.html#grok-processor-rest-get",`
`4`	`4`	`"methods": [ "GET" ],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_ingest/processor/grok",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ingest.put_pipeline": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-pipeline-api.html",`
`4`	`4`	`"methods": [ "PUT" ],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_ingest/pipeline/{id}",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"ingest.simulate": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/elasticsearch/plugins/master/ingest.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/simulate-pipeline-api.html",`
`4`	`4`	`"methods": [ "GET", "POST" ],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_ingest/pipeline/_simulate",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"license.delete": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/delete-license.html",`
`4`	`4`	`"methods": ["DELETE"],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_license",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"license.get": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-license.html",`
`4`	`4`	`"methods": ["GET"],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_license",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"license.get_basic_status": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-basic-status.html",`
`4`	`4`	`"methods": ["GET"],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_license/basic_status",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"license.get_trial_status": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/get-trial-status.html",`
`4`	`4`	`"methods": ["GET"],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_license/trial_status",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"license.post": {`
`3`		`- "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html",`
	`3`	`+ "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/master/update-license.html",`
`4`	`4`	`"methods": ["PUT", "POST"],`
`5`	`5`	`"url": {`
`6`	`6`	`"path": "/_license",`