From ca8c9be01696d81998de15ef0ec50cd021cb5dfd Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Wed, 1 Dec 2021 09:06:12 -0500 Subject: [PATCH] [DOCS] Remove source query params from update/delete by query APIs (#81131) Removes source-related query parameters from the update by query and delete by query API documentation. These parameters don't return source fields as part of the response. --- docs/reference/docs/delete-by-query.asciidoc | 6 ------ docs/reference/docs/update-by-query.asciidoc | 6 ------ .../resources/rest-api-spec/api/delete_by_query.json | 12 ------------ .../resources/rest-api-spec/api/update_by_query.json | 12 ------------ 4 files changed, 36 deletions(-) diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index 9a719e2fcfcc9..13f31711127e9 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -235,12 +235,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] - -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] - -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] - include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] diff --git a/docs/reference/docs/update-by-query.asciidoc b/docs/reference/docs/update-by-query.asciidoc index fa68f219ff075..87c0d46948d9a 100644 --- a/docs/reference/docs/update-by-query.asciidoc +++ b/docs/reference/docs/update-by-query.asciidoc @@ -232,12 +232,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=slices] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=sort] -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source] - -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_excludes] - -include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=source_includes] - include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=stats] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after] diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json index 9b57fa6c200eb..cc36acea13492 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json @@ -121,18 +121,6 @@ "type":"list", "description":"A comma-separated list of : pairs" }, - "_source":{ - "type":"list", - "description":"True or false to return the _source field or not, or a list of fields to return" - }, - "_source_excludes":{ - "type":"list", - "description":"A list of fields to exclude from the returned _source field" - }, - "_source_includes":{ - "type":"list", - "description":"A list of fields to extract and return from the _source field" - }, "terminate_after":{ "type":"number", "description":"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early." diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json index 6083eccebd652..8cf44f289ce01 100644 --- a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json +++ b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json @@ -125,18 +125,6 @@ "type":"list", "description":"A comma-separated list of : pairs" }, - "_source":{ - "type":"list", - "description":"True or false to return the _source field or not, or a list of fields to return" - }, - "_source_excludes":{ - "type":"list", - "description":"A list of fields to exclude from the returned _source field" - }, - "_source_includes":{ - "type":"list", - "description":"A list of fields to extract and return from the _source field" - }, "terminate_after":{ "type":"number", "description":"The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early."