jon-wei commented on a change in pull request #6128: Unified API doc page
URL: https://github.com/apache/incubator-druid/pull/6128#discussion_r208803254
##########
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`
+
+An endpoint that always returns a boolean "true" value with a 200 OK response,
useful for automated health checks.
+
+* `/properties`
+
+Returns the current configuration properties of the node.
+
+## Coordinator
+
+HTTP Endpoints
+--------------
+
+The coordinator node exposes several HTTP endpoints for interactions.
+
+### GET
+
+#### Coordinator information
+
+* `/druid/coordinator/v1/leader`
+
+Returns the current leader coordinator of the cluster.
+
+* `/druid/coordinator/v1/isLeader`
+
+Returns a JSON object with field "leader", either true or false, indicating if
this server is the current leader
+coordinator of the cluster. In addition, returns HTTP 200 if the server is the
current leader and HTTP 404 if not.
+This is suitable for use as a load balancer status check if you only want the
active leader to be considered in-service
+at the load balancer.
+
+* `/druid/coordinator/v1/loadstatus`
+
+Returns the percentage of segments actually loaded in the cluster versus
segments that should be loaded in the cluster.
+
+ * `/druid/coordinator/v1/loadstatus?simple`
+
+Returns the number of segments left to load until segments that should be
loaded in the cluster are available for queries. This does not include
replication.
+
+* `/druid/coordinator/v1/loadstatus?full`
+
+Returns the number of segments left to load in each tier until segments that
should be loaded in the cluster are all available. This includes replication.
+
+* `/druid/coordinator/v1/loadqueue`
+
+Returns the ids of segments to load and drop for each historical node.
+
+* `/druid/coordinator/v1/loadqueue?simple`
+
+Returns the number of segments to load and drop, as well as the total segment
load and drop size in bytes for each historical node.
+
+* `/druid/coordinator/v1/loadqueue?full`
+
+Returns the serialized JSON of segments to load and drop for each historical
node.
+
+#### Metadata store information
+
+* `/druid/coordinator/v1/metadata/datasources`
+
+Returns a list of the names of enabled datasources in the cluster.
+
+* `/druid/coordinator/v1/metadata/datasources?includeDisabled`
+
+Returns a list of the names of enabled and disabled datasources in the cluster.
+
+* `/druid/coordinator/v1/metadata/datasources?full`
+
+Returns a list of all enabled datasources with all metadata about those
datasources as stored in the metadata store.
+
+* `/druid/coordinator/v1/metadata/datasources/{dataSourceName}`
+
+Returns full metadata for a datasource as stored in the metadata store.
+
+* `/druid/coordinator/v1/metadata/datasources/{dataSourceName}/segments`
+
+Returns a list of all segments for a datasource as stored in the metadata
store.
+
+* `/druid/coordinator/v1/metadata/datasources/{dataSourceName}/segments?full`
+
+Returns a list of all segments for a datasource with the full segment metadata
as stored in the metadata store.
+
+* POST `/druid/coordinator/v1/metadata/datasources/{dataSourceName}/segments`
Review comment:
I reordered by function
----------------------------------------------------------------
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:
[email protected]
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
