OpenSearch/docs/reference
Nik Everett 923820c6c9 Document the `detailed` parameter of tasks API (#22425)
Provides an example of using is and an example return description
and explains that we've added descriptions for some tasks but not
even close to all of them. And that we expect to change the
descriptions as we learn more.

Closes #22407

* Fix example

Getting a single task is always detailed, no need to specify.

* Rewrite like imotov wants it
2017-01-06 10:24:52 -05:00
..
aggregations Fixed id's of 'worked example' in scripted metric aggs docs (#22430) 2017-01-05 14:37:27 -05:00
analysis Add the ability to set an analyzer on keyword fields. (#21919) 2016-12-30 09:36:10 +01:00
cat Remove lang-python and lang-javascript (#20734) 2016-11-21 22:13:25 -05:00
cluster Document the `detailed` parameter of tasks API (#22425) 2017-01-06 10:24:52 -05:00
docs Fix listing format in reindex docs (#22420) 2017-01-03 12:44:49 -05:00
how-to Add a recommendation against large documents to the docs. (#21652) 2016-11-21 15:01:36 +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 Use reader for doc stats 2016-12-23 09:44:56 -05:00
ingest Link directly to the attachments in arrays section 2016-12-22 20:52:08 +08:00
mapping Docs: Detail on false/strict dynamic mapping setting (#22451) 2017-01-05 14:36:18 -05:00
migration Remove deprecated `minimum_number_should_match` in BoolQueryBuilder 2017-01-03 15:14:33 +01:00
modules Descriptions for scripting enabled (#22388) 2016-12-30 12:50:17 -05:00
query-dsl Docs: Added link from bool and constant score query to filter context 2016-12-29 11:05:28 +01:00
search Merge pull request #21393 from masaruh/alias_boost 2016-12-16 15:07:51 +09:00
setup Fixing a second "second" reference in docs (#22345) 2016-12-28 18:50:10 +01: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 Send error_trace by default when testing (#22195) 2016-12-15 13:35:14 -05:00
cat.asciidoc Allows multiple patterns to be specified for index templates (#21009) 2016-11-10 18:00:30 -05:00
cluster.asciidoc Convert more docs to CONSOLE 2016-09-21 09:36:21 -04:00
docs.asciidoc Add support for waiting until a refresh occurs 2016-06-06 11:37:53 -04:00
getting-started.asciidoc Clarify first search API explanation of parameters (#21958) 2016-12-12 15:00:53 +01: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 Add support for `quote_field_suffix` to `simple_query_string`. (#21060) 2016-10-28 09:11:57 +02:00
index-modules.asciidoc Add a hard limit for `index.number_of_shard` (#20682) 2016-09-29 11:03:30 +02:00
index.asciidoc [docs] Document Docker installation method 2016-11-17 15:06:32 +02: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 Reorganised docs for mapping safeguard settings 2016-09-22 14:58:17 +02:00
modules.asciidoc Remove lang-python and lang-javascript (#20734) 2016-11-21 22:13:25 -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 Remove indices query (#21837) 2016-11-30 19:37:01 +01:00
release-notes.asciidoc Remove links to release notes 2016-09-08 18:07:39 +02:00
search.asciidoc Makes search action cancelable by task management API 2016-10-25 12:27:34 -10:00
setup.asciidoc Improve the out-of-the-box experience 2016-12-01 17:26:29 -05:00
testing.asciidoc [DOCS] Test framework documentation 2013-12-02 18:01:45 +01:00