Commit Graph

6 Commits

Author SHA1 Message Date
kolchfa-aws 85b18f7c58
Adds nodes stats API (#1369)
* Adds nodes stats API

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Refactored hot threads and info APIs

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Incorporated doc review comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Incorporated review feedback

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Formatting changes

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/index.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-hot-threads.md

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update nodes-info.md

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update nodes-info.md

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update _opensearch/rest-api/nodes-apis/nodes-info.md

Co-authored-by: Nate Bower <nbower@amazon.com>

* Update nodes-stats.md

* Incorporated nodes stats editorial comments

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>

Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Co-authored-by: Nate Bower <nbower@amazon.com>
2022-10-08 18:02:27 -04:00
Lukáš Vlček 98c7dd29a6 Fixing Nodes APIs issues
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>
2022-05-20 11:36:23 +02:00
Naarcha-AWS 03807527eb More feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 13:00:47 -05:00
Naarcha-AWS 6b2042745e Add feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 12:54:11 -05:00
Naarcha-AWS bde449d48a Writer review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 10:34:34 -05:00
Lukáš Vlček 2df0f8450b Introduce Nodes APIs
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>
2022-04-22 18:40:11 +02:00