Introduce Nodes APIs #521
Introduce Nodes APIs #521
Conversation
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: opensearch-project#424 Signed-off-by: Lukáš Vlček <[email protected]>
|
@krisfreedain if you could help with pointing out right person / team to review, thank you |
|
Thank you @lukas-vlcek @reta! @Naarcha-AWS @natebower - I wanted to get this in front of you. Lukas and Andriy at Aiven have put in some work on the docs! Thanks. |
|
@lukas-vlcek: I'll have this reviewed by EOD today. |
|
@Naarcha-AWS did you have a chance to look at it? I see that the PR got |
|
Hi @lukas-vlcek. Sorry for the delay. I went ahead and added some style edits to this PR. They can be found here: #584. |
|
Thanks for detailed review! 👍 |
|
@Naarcha-AWS I can see the online documentation has the "Nodes API" section now 👍 but it is missing sub-sections contained in this PR. Where did they go? Nodes info and Nodes hot threads. 😕 One nit picking though: Why did we change the "Nodes APIs" to singular "Nodes API" given it should have sub-sections? |
|
@Naarcha-AWS I pushed PR to fix this #592 |
Description
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.
Issues Resolved
There is meta-ticket: #424
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.
Signed-off-by: Lukáš Vlček [email protected]