honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 02:14:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Fix field caps API docs (#62110) (#62116)

Browse Source
This commit is contained in:
James Rodewig 2020-09-08 12:19:04 -04:00 committed by GitHub
parent 0f9532689f
commit cc5e01a242
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/reference/search/field-caps.asciidoc
View File

@ -1,5 +1,9 @@
[[search-field-caps]] [[search-field-caps]]
=== Field Capabilities API === Field capabilities API
++++
<titleabbrev>Field capabilities</titleabbrev>
++++
Allows you to retrieve the capabilities of fields among multiple indices. Allows you to retrieve the capabilities of fields among multiple indices.
For data streams, the API returns field capabilities among the stream's backing 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]] [[search-field-caps-api-request]]
==== {api-request-title} ==== {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]] [[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]] [[search-field-caps-api-query-params]]
==== {api-query-parms-title} ==== {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] include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+ +
Defaults to `true`. Defaults to `true`.
@ -56,8 +65,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
Defaults to `open`. 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::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]
`include_unmapped`:: `include_unmapped`::