Commit graph

177 commits

Author SHA1 Message Date
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
James Rodewig
5772c1c7dd
[DOCS] [2 of 5] Change // CONSOLE comments to [source,console] (#46353) 2019-09-09 13:13:41 -04:00
James Rodewig
a5c60fb59a
[DOCS] Reformat index segments API docs (#46345) 2019-09-05 08:33:17 -04:00
James Rodewig
46d7849032
Change {var} convention to <var> (#45904) 2019-08-23 10:57:20 -04:00
Tal Levy
7106288c54
Add is_write_index column to cat.aliases (#44772)
Aliases have had the option to set `is_write_index` since 6.4,
but the cat.aliases action was never updated.
2019-08-21 07:40:07 -07:00
James Rodewig
e0c9234ba9
[DOCS] Reformat cat API titles (#45407) 2019-08-13 08:35:08 -04:00
James Rodewig
7e0c90f680 [DOCS] Correct anchor for cat segments API examples 2019-08-13 08:27:57 -04:00
James Rodewig
c89f28f803
[DOCS] Reformats cat shards API (#45392) 2019-08-13 08:24:53 -04:00
James Rodewig
93f09bc37a
[DOCS] Reformats cat templates API (#45403) 2019-08-12 08:45:28 -04:00
James Rodewig
0341e691ac
[DOCS] Reformats cat snapshots API (#45402) 2019-08-12 08:40:33 -04:00
James Rodewig
f77d0a4370
[DOCS] Reformats cat thread pool API (#45385) 2019-08-12 08:36:36 -04:00
James Rodewig
a884fe5ae8
[DOCS] Reformats cat repositories API (#45382) 2019-08-12 08:30:25 -04:00
James Rodewig
c70e16da15
[DOCS] Reformats cat segments API (#45397) 2019-08-12 08:25:09 -04:00
James Rodewig
6ba11f6839
[DOCS] Reformats cat recovery API (#45345) 2019-08-12 08:17:01 -04:00
James Rodewig
0ab8f04c8a
[DOCS] Reformats cat plugins API (#45344) 2019-08-09 08:48:19 -04:00
James Rodewig
7423c0edd4
[DOCS] Reformats cat nodes API (#45285) 2019-08-08 08:37:22 -04:00
James Rodewig
564416bd36
[DOCS] Reformats cat pending tasks API (#45287) 2019-08-08 08:31:43 -04:00
James Rodewig
b010fa8835
[DOCS] Reformats cat nodeattrs API (#45255) 2019-08-07 09:31:07 -04:00
James Rodewig
56a380b1a8
[DOCS] Reformats cat indices API (#45239) 2019-08-07 09:08:09 -04:00
James Rodewig
7a79be42f0
[DOCS] Reformat cat master API (#45240) 2019-08-07 09:03:31 -04:00
Jason Tedor
5fee557163
Introduce formal node ML role (#45174)
This commit builds on the ability for plugins to introduce new roles to
add a formal node ML role.
2019-08-06 12:58:46 -04:00
James Rodewig
bb02e3157d
[DOCS] Reformat cat fielddata API (#45202) 2019-08-06 10:33:30 -04:00
James Rodewig
09491910d4
[DOCS] Reformat cat health API (#45218) 2019-08-06 08:40:52 -04:00
James Rodewig
5bf58c279d
[DOCS] Reformat cat count API (#45160) 2019-08-06 08:36:22 -04:00
David Turner
6d4afa8f75
Relax recovery duration in docs test (#45186)
Sometimes the recovery in this docs test takes long enough that it is expressed
in `s` rather than `ms`. This commit relaxes the assertion to account for this.
2019-08-06 09:28:20 +01:00
James Rodewig
4a81606147
[DOCS] Reformats cat allocation API (#45158) 2019-08-05 11:17:37 -04:00
James Rodewig
bc83df1bff
[DOCS] Reformat cat alias API (#45119) 2019-08-05 08:27:15 -04:00
Jason Tedor
ac5cc15308
Fix cat recovery display of bytes fields (#40379)
The cat APIs support the ?bytes parameter to format bytes value. The cat
recovery API does not follow this because the fields were not using
ByteSizeValue. This commit addresses this.
2019-07-24 00:12:04 -07:00
James Rodewig
fab98dfa55
[DOCS] Remove heading offsets for REST APIs (#44568)
Several files in the REST APIs nav section are included using
:leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.)
in those files and removes the :leveloffset: tags.

Other supporting changes:
* Alphabetizes top-level REST API nav items.
* Change 'indices APIs' heading to 'index APIs.'
* Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:35:36 -04:00
Andrey Ershov
680d6edc0b
Get snapshots support for multiple repositories (#42090)
This commit adds multiple repositories support to get snapshots
request.
If some repository throws an exception this method does not fail fast
instead, it returns results for all repositories.
This PR is opened in favour of #41799, because we decided to change
the response format in a non-BwC manner. It makes sense to read a
discussion of the aforementioned PR.
This is the continuation of work done here #15151.
2019-06-19 16:04:13 +03:00
Jason Tedor
aa12af8a3c
Enable node roles to be pluggable (#43175)
This commit introduces the possibility for a plugin to introduce
additional node roles.
2019-06-13 14:43:14 -04:00
James Rodewig
655032b07e
[DOCS] Change // TESTRESPONSE[_cat] to // TESTRESPONSE[non_json] (#43006) 2019-06-10 09:33:32 -04:00
Glen Smith
c8974045ae Remove stray back tick that's messing up table format (#41705) 2019-05-21 08:59:40 -04:00