techdocsmith commented on code in PR #14372: URL: https://github.com/apache/druid/pull/14372#discussion_r1223344934
########## docs/api-reference/api-reference.md: ########## @@ -1,6 +1,6 @@ --- id: api-reference -title: HTTP API endpoints reference +title: HTTP API reference Review Comment: ```suggestion API reference ``` ########## docs/api-reference/api-reference.md: ########## @@ -1,6 +1,6 @@ --- id: api-reference -title: HTTP API endpoints reference +title: HTTP API reference sidebar_label: API endpoints reference Review Comment: ```suggestion sidebar_label: Overview ``` Since we need to keep the file name `api-reference.md`, suggest renaming the sidebar to "Overview" in line with other sections. That way API reference is not repeated in the sidebar. In any case, it's not just endpoints. <img width="257" alt="Screenshot 2023-06-08 at 10 24 12 AM" src="https://github.com/apache/druid/assets/38529548/0735b9f9-e495-4dbb-aa19-b99982b970b3";> ########## docs/api-reference/api-reference.md: ########## @@ -24,864 +24,24 @@ sidebar_label: API endpoints reference --> -This topic documents all of the API endpoints for each Druid service type. +This topic is an index to the Apache Druid API documentation. -## Common +## HTTP APIs +* [Automatic compaction](./automatic-compaction-api.md) to optimize segment sizes after ingestion. +* [Data management](./data-management-api.md) to manage data segments. +* [Dynamic configuration](./dynamic-configuration-api.md) to configure the behavior of the Coordinator and Overlord processes. +* [JSON querying](./json-querying-api.md) to submit JSON-based native queries. +* [Lookups](./lookups-api.md) to manage and modify key-value transformations. Review Comment: not sure about "transformations" here maybe "key-value datasources"? -- 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]
