[GitHub] [druid] kfaraz commented on a diff in pull request #13213: api: change API page formatting

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

kfaraz commented on code in PR #13213:
URL: https://github.com/apache/druid/pull/13213#discussion_r995379038


##########
docs/operations/api-reference.md:
##########
@@ -238,98 +229,92 @@ Returns a list of all segments, overlapping with any of given intervals, for a d
 Note that all _interval_ URL parameters are ISO 8601 strings delimited by a `_` instead of a `/`
 (e.g., 2016-06-27_2016-06-28).
 
-##### GET
-
-* `/druid/coordinator/v1/datasources`
+`GET /druid/coordinator/v1/datasources`
 
 Returns a list of datasource names found in the cluster as seen by the coordinator. This view is updated every [`druid.coordinator.period`](../configuration/index.md#coordinator-operation).
 
-* `/druid/coordinator/v1/datasources?simple`
+`GET /druid/coordinator/v1/datasources?simple`
 
 Returns a list of JSON objects containing the name and properties of datasources found in the cluster.  Properties include segment count, total segment byte size, replicated total segment byte size, minTime, and maxTime.
 
-* `/druid/coordinator/v1/datasources?full`
+`GET /druid/coordinator/v1/datasources?full`
 
 Returns a list of datasource names found in the cluster with all metadata about those datasources.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}`
 
 Returns a JSON object containing the name and properties of a datasource. Properties include segment count, total segment byte size, replicated total segment byte size, minTime, and maxTime.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}?full`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}?full`
 
 Returns full metadata for a datasource .
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals`
 
 Returns a set of segment intervals.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals?simple`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals?simple`
 
 Returns a map of an interval to a JSON object containing the total byte size of segments and number of segments for that interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals?full`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals?full`
 
 Returns a map of an interval to a map of segment metadata to a set of server names that contain the segment for that interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}`
 
 Returns a set of segment ids for an interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}?simple`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}?simple`
 
 Returns a map of segment intervals contained within the specified interval to a JSON object containing the total byte size of segments and number of segments for an interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}?full`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}?full`
 
 Returns a map of segment intervals contained within the specified interval to a map of segment metadata to a set of server names that contain the segment for an interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}/serverview`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/intervals/{interval}/serverview`
 
 Returns a map of segment intervals contained within the specified interval to information about the servers that contain the segment for an interval.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/segments`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/segments`
 
 Returns a list of all segments for a datasource in the cluster.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/segments?full`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/segments?full`
 
 Returns a list of all segments for a datasource in the cluster with the full segment metadata.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
 
 Returns full segment metadata for a specific segment in the cluster.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/tiers`
+`GET /druid/coordinator/v1/datasources/{dataSourceName}/tiers`
 
 Return the tiers that a datasource exists in.
 
 #### Note for coordinator's POST and DELETE API's
 The segments would be enabled when these API's are called, but then can be disabled again by the coordinator if any dropRule matches. Segments enabled by these API's might not be loaded by historical processes if no loadRule matches.  If an indexing or kill task runs at the same time as these API's are invoked, the behavior is undefined. Some segments might be killed and others might be enabled. It's also possible that all segments might be disabled but at the same time, the indexing task is able to read data from those segments and succeed.
 
-Caution : Avoid using indexing or kill tasks and these API's at the same time for the same datasource and time chunk. (It's fine if the time chunks or datasource don't overlap)
-
-##### POST
+> Caution : Avoid using indexing or kill tasks and these API's at the same time for the same datasource and time chunk. (It's fine if the time chunks or datasource don't overlap)
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}`
+`POST /druid/coordinator/v1/datasources/{dataSourceName}`
 
 Marks as used all segments belonging to a datasource. Returns a JSON object of the form
 `{"numChangedSegments": <number>}` with the number of segments in the database whose state has been changed (that is,
 the segments were marked as used) as the result of this API call.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
+`POST /druid/coordinator/v1/datasources/{dataSourceName}/segments/{segmentId}`
 
 Marks as used a segment of a datasource. Returns a JSON object of the form `{"segmentStateChanged": <boolean>}` with
 the boolean indicating if the state of the segment has been changed (that is, the segment was marked as used) as the
 result of this API call.
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/markUsed`
+`POST /druid/coordinator/v1/datasources/{dataSourceName}/markUsed`
 
-* `/druid/coordinator/v1/datasources/{dataSourceName}/markUnused`
+`POST /druid/coordinator/v1/datasources/{dataSourceName}/markUnused`
 
-Marks segments (un)used for a datasource by interval or set of segment Ids.
-
-When marking used only segments that are not overshadowed will be updated.
+Marks segments (un)used for a datasource by interval or set of segment Ids.When marking used only segments that are not overshadowed will be updated.

Review Comment:
   ```suggestion
   Marks segments (un)used for a datasource by interval or set of segment Ids. When marking used only segments that are not overshadowed will be updated.
   ```
   This is causing the build failure.



-- 
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.

To unsubscribe, e-mail: commits-unsubscribe@druid.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


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