honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference
History
Jim Ferenczi a8250b26e7 Add FieldCapabilities (_field_caps) API (#23007) 
This change introduces a new API called `_field_caps` that allows to retrieve the capabilities of specific fields.

Example:

````
GET t,s,v,w/_field_caps?fields=field1,field2
````
... returns:
````
{
   "fields": {
      "field1": {
         "string": {
            "searchable": true,
            "aggregatable": true
         }
      },
      "field2": {
         "keyword": {
            "searchable": false,
            "aggregatable": true,
            "non_searchable_indices": ["t"]
            "indices": ["t", "s"]
         },
         "long": {
            "searchable": true,
            "aggregatable": false,
            "non_aggregatable_indices": ["v"]
            "indices": ["v", "w"]
         }
      }
   }
}
````

In this example `field1` have the same type `text` across the requested indices `t`, `s`, `v`, `w`.
Conversely `field2` is defined with two conflicting types `keyword` and `long`.
Note that `_field_caps` does not treat this case as an error but rather return the list of unique types seen for this field.
 		2017-03-31 15:34:46 +02:00
..
aggregations CONSOLEify geo aggregation docs 2017-03-30 21:28:52 -04:00
analysis Update compound-word-tokenfilter.asciidoc (#23817) 2017-03-30 12:27:32 +02:00
cat Documentation: Consoleify cat shards/recovery API docs (#23116) 2017-02-22 09:18:10 +01:00
cluster Clarify task cancellation command (#23667) 2017-03-30 20:21:21 +02:00
docs Unmark reindex as experimental 2017-03-16 22:02:15 -04:00
how-to Add note and link to 'tune for disk usage' (#23252) 2017-02-20 20:31:19 +01:00
images Docs: clarify calculation of sigma and lambda in function_score (#20267) 2016-09-02 14:41:07 +02:00
index-modules Restores the original default format of search slow log 2016-12-09 12:38:28 -05:00
indices Doc values can no longer be updated 2017-03-31 15:29:01 +02:00
ingest Update ingest-node.asciidoc 2017-03-22 10:44:11 +01:00
mapping CONSOLEify geo-shape docs 2017-03-31 09:11:54 -04:00
migration Merge branch 'pr/remove-repositories-azure-settings' 2017-03-31 12:33:12 +02:00
modules [DOCS] Multiple clusters connected to the same repository (#23807) 2017-03-30 13:08:41 -04:00
painless-api-reference Expose multi-valued dates to scripts and document painless's date functions (#22875) 2017-02-01 21:57:07 -05:00
query-dsl CONSOLEify geo-shape docs 2017-03-31 09:11:54 -04:00
search Add FieldCapabilities (_field_caps) API (#23007) 2017-03-31 15:34:46 +02:00
setup Add early-access check 2017-03-24 14:52:50 -04:00
testing Update docs after test-framework moved 2016-11-02 09:51:55 -04:00
aggregations.asciidoc `value_type` is useful regardless of scripting. (#22160) 2016-12-22 14:35:12 +01:00
analysis.asciidoc Add the ability to set an analyzer on keyword fields. (#21919) 2016-12-30 09:36:10 +01:00
api-conventions.asciidoc Docs: Specify that byte units use powers of 1024 (#23574) 2017-03-16 12:39:45 -04:00
cat.asciidoc [DOCS] Fixed various typos in the 'cat APIs' section (#23216) 2017-02-16 20:41:42 +01:00
cluster.asciidoc Convert more docs to CONSOLE 2016-09-21 09:36:21 -04:00
docs.asciidoc Inclusion of link to Multi Delete (#22619) 2017-01-16 12:58:59 +01:00
getting-started.asciidoc Docs: fix health response test 2017-03-28 08:29:10 -04:00
glossary.asciidoc Improve glossary to not refer to types as "like a table" (#17704) 2016-04-13 14:29:47 +02:00
how-to.asciidoc Correct grammar in list in how-to docs 2017-01-17 20:57:22 -05:00
index-modules.asciidoc Allow an index to be partitioned with custom routing (#22274) 2017-01-18 08:51:23 +01:00
index.asciidoc Centralised doc versions in docs/Versions.asciidoc 2017-02-04 11:16:19 +01:00
indices.asciidoc Removed the upgrade API docs 2016-10-11 12:21:46 +02:00
ingest.asciidoc Renamed all AUTOSENSE snippets to CONSOLE (#18210) 2016-05-09 15:42:23 +02:00
mapping.asciidoc Disallow include_in_all for 6.0+ indices 2017-02-07 19:31:51 -07:00
modules.asciidoc Docs: Cross-cluster search doc wasn't being included 2017-01-18 10:02:51 +01:00
painless-api-reference.asciidoc Generate reference links for painless API (#22775) 2017-01-26 10:39:19 -05:00
query-dsl.asciidoc Fixed broken xrefs to query-dsl-not-query, which has been removed. 2015-10-20 13:01:37 -07:00
redirects.asciidoc Update redirects.asciidoc (#23148) 2017-02-13 16:23:25 +01:00
release-notes.asciidoc Remove links to release notes 2016-09-08 18:07:39 +02:00
search.asciidoc percolator: remove deprecated percolate and mpercolate apis 2017-01-10 11:18:27 +01:00
setup.asciidoc Docs: Add setup section for the keystore tool and secure settings (#22838) 2017-01-30 14:56:45 -08:00
testing.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00