From cc5e01a24247fecbf8cf277f7ff71f2c15300f36 Mon Sep 17 00:00:00 2001
From: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Date: Tue, 8 Sep 2020 12:19:04 -0400
Subject: [PATCH] [DOCS] Fix field caps API docs (#62110) (#62116)
---
docs/reference/search/field-caps.asciidoc | 21 ++++++++++++++-------
1 file changed, 14 insertions(+), 7 deletions(-)
diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc
index 7754cf22b55..9d352273999 100644
--- a/docs/reference/search/field-caps.asciidoc
+++ b/docs/reference/search/field-caps.asciidoc
@@ -1,5 +1,9 @@
[[search-field-caps]]
-=== Field Capabilities API
+=== Field capabilities API
+++++
+Field capabilities
+++++
+
Allows you to retrieve the capabilities of fields among multiple indices.
For data streams, the API returns field capabilities among the stream's backing
@@ -14,13 +18,13 @@ GET /_field_caps?fields=rating
[[search-field-caps-api-request]]
==== {api-request-title}
-`GET /_field_caps`
+`GET /_field_caps?fields=`
-`POST /_field_caps`
+`POST /_field_caps?fields=`
-`GET //_field_caps`
+`GET //_field_caps?fields=`
-`POST //_field_caps`
+`POST //_field_caps?fields=`
[[search-field-caps-api-desc]]
@@ -46,6 +50,11 @@ To target all data streams and indices in a cluster, omit this parameter or use
[[search-field-caps-api-query-params]]
==== {api-query-parms-title}
+`fields`::
+(Required, string)
+Comma-separated list of fields to retrieve capabilities for. Wildcard (`*`)
+expressions are supported.
+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.
@@ -56,8 +65,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
Defaults to `open`.
--
-include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=fields]
-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
`include_unmapped`::