paul-rogers commented on PR #13213: URL: https://github.com/apache/druid/pull/13213#issuecomment-1276850120
Wonderful! The current format has long been a struggle for me: it just seems jumbled. Note on placement: burying the API docs in "Operations" has always seemed odd." I know it is a heavy lift, but would be great if we had a "API" section. Related: not all the REST APIs are on the API page. Some are sprinkled elsewhere. So, would be great to put them in one place, with references where needed. While I'm asking for the world, having API as one big page is cumbersome: seldom do I need to see everything in one go. Perhaps we can break it down into multiple pages, each focused on some related topic. (The current headings might suggest a first cut.) Suggestion: we don't need the HTTP methods as headers, just put the method in with the URL. We don't really need the bullets. The result is that there is more room for formatted explanations. Example: ### Process Information #### `GET /status` Returns the Druid version, loaded extensions, memory used, total memory and other useful information about the process. #### `GET /status/health` An endpoint that always returns a boolean "true" value with a 200 OK response, useful for automated health checks. #### `GET /status/properties` Returns the current configuration properties of the process. #### `POST /mode/turbo` Posts a request to double the speed of your server. **Deprecated**: *Turbo mode is now standard in Druid since version 0.12.* -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
