Commit Graph

209 Commits

Author SHA1 Message Date
James Rodewig a94e5cb7c4
[DOCS] Replace Wikipedia links with attribute (#61171) 2020-08-17 09:44:24 -04:00
James Rodewig fc22f59891 [DOCS] Fix outdated twitter reference 2020-08-05 09:29:28 -04:00
Przemysław Witek 29ee3a05b6
Deprecate allow_no_jobs and allow_no_datafeeds in favor of allow_no_match (#60601) 2020-08-05 12:29:07 +02:00
James Rodewig 6782474583
[DOCS] Replace `twitter` dataset in cat API docs (#60588) 2020-08-03 09:26:17 -04:00
Dan Hermann ac195c60f9
Document new stats in _cat/nodes (#60445) 2020-08-03 07:41:29 -05:00
Lisa Cawley 1781d4a7b9
[DOCS] Fix security links in machine learning APIs (#60098) 2020-07-23 12:14:56 -07:00
James Rodewig c7ca1d5941 [DOCS] Make `<target>` defs consistent 2020-06-30 15:53:32 -04:00
James Rodewig b292459ab1
[DOCS] Add data streams to cat APIs (#58699) 2020-06-30 15:06:51 -04:00
Lisa Cawley 27111f9faa
[DOCS] Updates pull and issue release attributes (#58348) 2020-06-18 12:38:49 -07:00
Hendrik Muhs 75ea6a4b17
[Transform] fix page size return in cat transform, add dps (#57871)
fixes the page size reported after moving page size to settings(#56007) and
adds documents per second(throttling) to the output.

fixes #56498
2020-06-10 08:04:47 +02:00
Lisa Cawley 8b9293b3bf
[DOCS] Replace docdir attribute with es-repo-dir (#57489) 2020-06-01 15:55:05 -07:00
Nick Canzoneri 8d70f0696f
[DOCS] Fix remote cluster client node docs (#57176)
Changes:

* Documents the `r` role in the _cat/nodes API docs

* Fixes a typo in the node docs
2020-05-27 08:41:45 -04:00
Gordon Brown 741b64695f
Add expand_wildcards to _cat/indices and _cat/aliases docs (#56964)
This commit adds the `expand_wildcards` parameter documentation to the
`_cat/indices` and `_cat/aliases` docs, as those APIs now support
`expand_wildcards`. Additionally, clarifies the `expand_wildcards` docs with
respect to hidden indices.
2020-05-21 16:27:43 -06:00
Hendrik Muhs a73511e4c7
[DOC] document transform settings and docs_per_second (#56178)
add documentation for throttling, added in #56007
2020-05-11 09:21:36 +02:00
Jake Landis 32269f1a6d
_cat/threadpool remove "size" and add "time" params (#55736)
The rest spec and documentation for _cat/threadpool supports a "size" parameter.
However, the "size" parameter will have no impact since there are no values
of type "SizeValue" of the return value of this _cat api.

This commit removes the "size" param from the spec and documentation.

This commit also adds support for the "time" param since and support to
format the time param for the "keep_alive" column. By default, the output
should not change since the "TimeValue" rendered default (via RestTable)
is toString(), and the code prior to this also called toString().

closes #54478
2020-05-06 14:26:08 -05:00
Lee Hinman 61acf602fc
Add support for V2 index templates to /_cat/templates (#55829)
This adds support for V2 index templates to the cat templates API. It uses the `order` field as
priority in order not to break compatibility, while adding the `composed_of` field to show component
templates that are used from an index template.

Relates to #53101
2020-04-28 09:25:54 -06:00
David Roberts dcb6ed03cd
[ML] Adding failed_category_count to model_size_stats (#55716)
The failed_category_count statistic records the number of times
categorization wanted to create a new category but couldn't
because the job had reached its model_memory_limit.

Relates elastic/ml-cpp#1130
2020-04-25 08:01:21 +01:00
James Baiera 3e282e097f
[DOCS] Remove unused cat tasks request parameters (#54539) 2020-04-03 14:24:48 -04:00
Lisa Cawley 5d590b5be6
[DOCS] Add processing details to get transforms stats API (#54368) 2020-04-01 09:50:57 -07:00
Benjamin Trent 3c81082fdf
[Transform] fixing naming in HLRC and _cat to match API content (#54300)
Fixing the naming of the HLRC values to match the ToXContent field names (i.e. the field names returned from an API call).

Also fixes the names in the _cat API as well.

closes #53946
2020-03-30 08:10:15 -04:00
Lisa Cawley 6fceef73e4
[DOCS] Augments cat transforms API (#53776)
Co-Authored-By: Benjamin Trent <ben.w.trent@gmail.com>
2020-03-25 12:35:01 -07:00
Lisa Cawley 35ad63036e
[DOCS] Add transform nodes (#53698) 2020-03-18 15:23:41 -07:00
Benjamin Trent 3dae2e97d8
[Transform] renamed _cat/transform to _cat/transforms (#53743)
renaming _cat/transform to  _cat/transforms for uniformity with the other _cat apis.
2020-03-18 18:23:01 -04:00
Lisa Cawley f605ec2d3c
[DOCS] Adds stub for cat transform API (#53737) 2020-03-18 08:29:18 -07:00
Lisa Cawley b6534834f9
[DOCS] Adds cat anomaly detectors API (#52866) 2020-02-28 12:15:21 -08:00
István Zoltán Szabó efc70837aa
[DOCS] Reformats cat DFA API docs. (#52885) 2020-02-27 14:20:29 +01:00
István Zoltán Szabó 03d95372d7
[DOCS] Adds cat trained model API documentation (#52824) 2020-02-27 12:50:11 +01:00
Lisa Cawley 42fbca7dc6
[DOCS] Adds cat datafeeds API (#52738) 2020-02-26 09:20:36 -08:00
István Zoltán Szabó 490e8b47e6
[DOCS] Adds cat data frame analytics API (#52764)
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2020-02-26 11:09:37 +01:00
baifan cdd858ab95
[DOCS] Fix `disk.used_percent` typo in `_cat/nodes` docs (#51854)
Corrects an example for the `disk.used_percent` parameter in `_cat/nodes` API.
2020-02-04 09:15:06 -05:00
Henning Andersen ccc323f524
[DOCS] Task management API experimental status issue (#51634)
Add issue reference to documentation.

Relates #51628
2020-01-30 14:15:05 +01:00
Yannick Welsch a57a9a31c3 Stricter checks of setup and teardown in docs tests (#51430)
Made checks stricter after backporting PR.
2020-01-28 17:53:57 +01:00
Ted Timmons a636fdabb7 [Docs] Fix short alias for 'unassigned.for' (#51059)
The short alias for `unassigned.for` is `uf`, not 'ua'.
2020-01-16 12:09:54 +01:00
David Turner 8c6f821c75
Remove the 'local' parameter of /_cat/nodes (#50594)
The cat nodes API performs a `ClusterStateAction` then a `NodesInfoAction`.
Today it accepts the `?local` parameter and passes this to the
`ClusterStateAction` but this parameter has no effect on the `NodesInfoAction`.
This is surprising, because `GET _cat/nodes?local` looks like it might be a
completely local call but in fact it still depends on every node in the
cluster.

This parameter was deprecated in 7.x in #50499 and this commit removes it.

Relates #50088
2020-01-06 14:12:51 +00:00
Oleg 1c2492136d Deprecate the 'local' parameter of /_cat/nodes (#50499)
The cat nodes API performs a `ClusterStateAction` then a `NodesInfoAction`.
Today it accepts the `?local` parameter and passes this to the
`ClusterStateAction` but this parameter has no effect on the `NodesInfoAction`.
This is surprising, because `GET _cat/nodes?local` looks like it might be a
completely local call but in fact it still depends on every node in the
cluster.

This commit deprecates the `?local` parameter on this API so that it can be
removed in 8.0.

Relates #50088
2020-01-02 14:22:40 +00:00
James Rodewig 0062d5f301
[DOCS] Remove shadow replica reference (#50029)
Removes a reference to shadow replicas from the cat shards API docs
and a comment in cluster/routing/UnassignedInfo.java.

Shadow replicas were removed with #23906.
2019-12-10 09:30:04 -05:00
James Rodewig 25ffce9391
[DOCS] Remove individual task retrieval from cat/tasks API (#49550) 2019-11-25 10:31:13 -05:00
Kelly Campbell 1542a728c9 [DOCS] Correct GET path in cat tasks API docs (#49494)
Previously, the request example included `GET _cat/_tasks`. However, the resource should be `tasks`, not `_tasks`.
2019-11-25 09:37:17 -05:00
Lisa Cawley d8a12a7c9d
[DOCS] Adds machine learning node type and filters (#49121) 2019-11-15 11:27:36 -05:00
Brandon DeVault 567b13cbf4 [DOCS] Added the voting node.role value (#48162)
* [DOCS] Added the voting node.role value 

With the elasticsearch.yml option "node.voting_only: true", if you perform a "_cat/nodes" there is a new option for `v` that will display if the node is a voting node.

* [DOCS] Added the voting node.role value

Updated "voting node" to read "voting-only node"
2019-10-22 15:25:29 +02:00
James Rodewig 64c1dfa727
[DOCS] Remove unsupported `local` and `master_timeout` parms from cat API docs (#47933) 2019-10-14 11:38:46 -04:00
Alan Woodward 566e1b7d33
Remove type field from DocWriteRequest and associated Response objects (#47671)
This commit removes the type field from index, update and delete requests, and their
associated responses.

Relates to #41059
2019-10-11 10:23:55 +01:00
James Rodewig 15e2de6db8
[DOCS] Document `bytes` and `time` params in cat API docs (#47672) 2019-10-10 08:29:27 -04:00
Przemko Robakowski fbda3a7e19
Explicit name for doc snippets (#46951)
* Explicit name for doc snippets

This change adds option to specify explicit name for doc snippet.
This name will be used instead of line number when creating
yml file in buildRestTests task.
Stable names should improve tracking changes through history and allow
Gradle to skip tests on non-code docs changes.

* Avoid duplication in names

* Changes id declaration, more examples

* Fix names in examples

* Unit test added

* Throw exception on duplicate names

* Moved UT to Java
2019-10-07 23:06:49 +02:00
James Rodewig 730c35c4cd
[DOCS] Reformat index recovery API docs (#46493) 2019-10-03 16:13:21 -04:00
James Rodewig 7583c07fa8
[DOCS] Reorder index APIs alphabetically (#46981) 2019-10-01 15:13:27 -04:00
James Rodewig 26fef85887 [DOCS] Clarify `actions` parm def for tasks APIs 2019-10-01 11:49:08 -04:00
James Rodewig 9f5f9f19d0
[DOCS] Document cat tasks API (#47321) 2019-10-01 11:47:14 -04:00
James Rodewig 4568d30ef6
[DOCS] Document missing query parms for cat recovery API (#47181)
Documents the following query parameters for
the /_cat/recovery API:

* `active_only`
* `detailed`
* `index`
2019-09-27 12:19:47 -04:00
James Rodewig 0b07befb1b
[DOCS] Correct typo in ICU Analysis plugin description (#47175) 2019-09-27 10:48:00 -04:00