* added resource_stats object to sample responses
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added information about log files
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed resource_stats from existing sample responses that lack the detailed flag
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added example with detailed parameter
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Changed phrasing to use active voice
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed extra comma from sample JSON and rephrased feature description
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Replaced query string in detailed flag example with placeholder
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Small wording change
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Add ML node instructions
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Change cluster settings from ml to dynamic
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Quick typo fix
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Adjust ML docs to remove dymanic mention. Adjust CAT example to be general
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Add editorial feedback.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Fix columns in example
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* for cluster manager term update
Signed-off-by: alicejw <alicejw@amazon.com>
* for small fix
Signed-off-by: alicejw <alicejw@amazon.com>
* to change to
Signed-off-by: alicejw <alicejw@amazon.com>
1. Fixing all reported dead links.
2. Changing `title` value in index.md back to plural form, i.e. "Nodes APIs".
The second change fixed missing child pages. I am not saying I insist on use of plural form but if we want to change it to a singular form then we also have to change `parent` fields in all child pages to correctly refer to valid parent, otherwise all child pages and content is missing.
As for the debate of use APIs vs API (plural vs singular) I just want to point out that right now there are many other parent pages using plural form. If we want to change that then I suggest doing it in separate PR and include other relevant parent pages too.
Closes: #591
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
Additional improvements:
- The master_timeout is marked as deprecated and cluster_manager_timeout is suggested instead
- A required permissions is also documented
- The JSON example response is completed
Closes: #552
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
In this commit we are introducing a new section in REST API Reference for Nodes APIs.
We are adding documentation for "Nodes hot threads" and "Nodes info". Because Nodes APIs share common request parameters we also add more detailed section into parent index page (notice that the nodes-filter parameter was moved from "Cluster stats" page and was improved, and relevant links were updated).
There are more Nodes APIs that still need to be documented, this is just a good start.
We updated nav_order parameter for some pages as well.
Relevant ticket: #424
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
Jeff Huss
Anil Jaiswal
Naarcha-AWS
Alice Williams
alicejw
kolchfa-aws
Fanit Kolchina
Naarcha-AWS
Lukáš Vlček