clintropolis commented on a change in pull request #10967:
URL: https://github.com/apache/druid/pull/10967#discussion_r611006539
##########
File path: docs/operations/api-reference.md
##########
@@ -157,19 +157,37 @@ If no used segments are found for the given inputs, this
API returns `204 No Con
##### GET
+* `/druid/coordinator/v1/metadata/segments`
+
+Returns a list of all segments for each datasource enabled in the cluster.
+
+*
`/druid/coordinator/v1/metadata/segments?datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources enabled in
the cluster.
+
+* `/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus`
+
+Returns a list of all segments for each datasource with the full segment
metadata and an extra field `overshadowed`.
+
+*
`/druid/coordinator/v1/metadata/segments?includeOvershadowedStatus&datasources={dataSourceName1}&datasources={dataSourceName2}`
+
+Returns a list of all segments for one or more specific datasources with the
full segment metadata and an extra field `overshadowed`.
+
Review comment:
I wonder if we should add some sort of note that these segment API
methods are primarily intended for internal use and maybe should be used with
care in large clusters.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
