From 8921deb03430770e3053dabea76896e58b0cdec5 Mon Sep 17 00:00:00 2001 From: Nik Everett Date: Fri, 12 Apr 2019 08:20:28 -0400 Subject: [PATCH] Fix some documentation urls in rest-api-spec (#40618) 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. --- .../resources/rest-api-spec/api/ingest.delete_pipeline.json | 2 +- .../main/resources/rest-api-spec/api/ingest.get_pipeline.json | 2 +- .../main/resources/rest-api-spec/api/ingest.processor_grok.json | 2 +- .../main/resources/rest-api-spec/api/ingest.put_pipeline.json | 2 +- .../src/main/resources/rest-api-spec/api/ingest.simulate.json | 2 +- .../test/resources/rest-api-spec/api/xpack.license.delete.json | 2 +- .../src/test/resources/rest-api-spec/api/xpack.license.get.json | 2 +- .../rest-api-spec/api/xpack.license.get_basic_status.json | 2 +- .../rest-api-spec/api/xpack.license.get_trial_status.json | 2 +- .../test/resources/rest-api-spec/api/xpack.license.post.json | 2 +- .../rest-api-spec/api/xpack.license.post_start_basic.json | 2 +- .../rest-api-spec/api/xpack.license.post_start_trial.json | 2 +- .../rest-api-spec/api/xpack.migration.deprecations.json | 2 +- .../rest-api-spec/api/xpack.ml.find_file_structure.json | 2 +- .../test/resources/rest-api-spec/api/xpack.monitoring.bulk.json | 2 +- .../rest-api-spec/api/xpack.security.get_user_privileges.json | 2 +- 16 files changed, 16 insertions(+), 16 deletions(-) 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 index 1c515e4509581..c3b51de862097 100644 --- 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 index 317250874233b..16a07e072b771 100644 --- 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 index 55afada728122..bf40be853e2d1 100644 --- 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 index e4c3c2eb3f9a3..1ea77901d8dbd 100644 --- 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 index d02f97d81dd70..c16008ad6b659 100644 --- 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/xpack.license.delete.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.delete.json index 6b5a449b04f3f..9109c545281cd 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.delete.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.delete.json @@ -1,6 +1,6 @@ { "xpack.license.delete": { - "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/6.7/delete-license.html", "methods": ["DELETE"], "url": { "path": "/_xpack/license", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get.json index f8498a3db9799..ca787da4838e3 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get.json @@ -1,6 +1,6 @@ { "xpack.license.get": { - "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/6.7/get-license.html", "methods": ["GET"], "url": { "path": "/_xpack/license", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_basic_status.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_basic_status.json index 80e9cfe9ab461..dc3abc98d8daf 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_basic_status.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_basic_status.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/get-trial-status.html", "methods": ["GET"], "url": { "path": "/_xpack/license/basic_status", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_trial_status.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_trial_status.json index 9824b02240577..cd81b097e8aa3 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_trial_status.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.get_trial_status.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/get-basic-status.html", "methods": ["GET"], "url": { "path": "/_xpack/license/trial_status", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post.json index 0899a742a8156..f7bf42aef47ae 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post.json @@ -1,6 +1,6 @@ { "xpack.license.post": { - "documentation": "https://www.elastic.co/guide/en/x-pack/current/license-management.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/6.7/update-license.html", "methods": ["PUT", "POST"], "url": { "path": "/_xpack/license", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_basic.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_basic.json index 77c7a10878fea..d3320848d0482 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_basic.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_basic.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/start-basic.html", "methods": ["POST"], "url": { "path": "/_xpack/license/start_basic", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_trial.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_trial.json index a1e5d27da1eda..942d2383d9379 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_trial.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.license.post_start_trial.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/start-trial.html", "methods": ["POST"], "url": { "path": "/_xpack/license/start_trial", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.migration.deprecations.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.migration.deprecations.json index f639880f510a8..357aea7a24cd8 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.migration.deprecations.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.migration.deprecations.json @@ -1,6 +1,6 @@ { "xpack.migration.deprecations": { - "documentation": "http://www.elastic.co/guide/en/migration/current/migration-api-deprecation.html", + "documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/6.7/migration-api-deprecation.html", "methods": [ "GET" ], "url": { "path": "/{index}/_xpack/migration/deprecations", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.ml.find_file_structure.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.ml.find_file_structure.json index 66dc18c8c20b3..f7cb966ba79ab 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.ml.find_file_structure.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.ml.find_file_structure.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/ml-find-file-structure.html", "methods": [ "POST" ], "url": { "path": "/_xpack/ml/find_file_structure", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.monitoring.bulk.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.monitoring.bulk.json index 71f1b1fc13bf7..6e1d2cdb881e0 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.monitoring.bulk.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.monitoring.bulk.json @@ -1,6 +1,6 @@ { "xpack.monitoring.bulk": { - "documentation": "http://www.elastic.co/guide/en/monitoring/current/appendix-api-bulk.html", + "documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/6.7/es-monitoring.html", "methods": ["POST", "PUT"], "url": { "path": "/_xpack/monitoring/_bulk", diff --git a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.security.get_user_privileges.json b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.security.get_user_privileges.json index 56b9609c2640d..d1542574749f1 100644 --- a/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.security.get_user_privileges.json +++ b/x-pack/plugin/src/test/resources/rest-api-spec/api/xpack.security.get_user_privileges.json @@ -1,6 +1,6 @@ { "xpack.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/6.7/security-api-get-privileges.html", "methods": [ "GET" ], "url": { "path": "/_xpack/security/user/_privileges",