[GitHub] dclim commented on a change in pull request #6128: Unified API doc page

[GitBox <gi...@apache.org>]

dclim commented on a change in pull request #6128: Unified API doc page
URL: https://github.com/apache/incubator-druid/pull/6128#discussion_r208690060
 
 

 ##########
 File path: docs/content/operations/api-reference.md
 ##########
 @@ -0,0 +1,426 @@
+---
+layout: doc_page
+---
+
+# API Reference
+
+This page documents all of the API endpoints for each Druid service type.
+
+## Table of Contents
+  * [Coordinator](#coordinator)
+  * [Overlord](#overlord)
+  * [MiddleManager](#middlemanager)
+  * [Peon](#peon)
+  * [Broker](#broker)
+  * [Historical](#historical)
+
+## Common
+
+The following endpoints are supported by all nodes.
+
+### GET
+
+* `/status`
+
+Returns the Druid version, loaded extensions, memory used, total memory and other useful information about the node.
+
+* `/health`
 
 Review comment:
   This should actually be `/status/health`

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org
For additional commands, e-mail: commits-help@druid.apache.org