Skip to content

[DOCS] Fix field caps API docs #62110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2020
Merged

[DOCS] Fix field caps API docs #62110

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f03dd11
[DOCS] Fix Field Caps API docs
jrodewig Sep 8, 2020
564c132
Fix title caps
jrodewig Sep 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions docs/reference/search/field-caps.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
[[search-field-caps]]
=== Field Capabilities API
=== Field capabilities API
++++
<titleabbrev>Field capabilities</titleabbrev>
++++


Allows you to retrieve the capabilities of fields among multiple indices.
For data streams, the API returns field capabilities among the stream's backing
Expand All @@ -14,13 +18,13 @@ GET /_field_caps?fields=rating
[[search-field-caps-api-request]]
==== {api-request-title}

`GET /_field_caps`
`GET /_field_caps?fields=<fields>`

`POST /_field_caps`
`POST /_field_caps?fields=<fields>`

`GET /<target>/_field_caps`
`GET /<target>/_field_caps?fields=<fields>`

`POST /<target>/_field_caps`
`POST /<target>/_field_caps?fields=<fields>`


[[search-field-caps-api-desc]]
Expand All @@ -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`.
Expand All @@ -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`::
Expand Down