vtlim commented on code in PR #15077: URL: https://github.com/apache/druid/pull/15077#discussion_r1346607766
########## docs/api-reference/dynamic-configuration-api.md: ########## @@ -23,53 +23,591 @@ sidebar_label: Dynamic configuration ~ under the License. --> -This document describes the API endpoints to retrieve and manage the dynamic configurations for the [Coordinator](../configuration/index.md#overlord-dynamic-configuration) and [Overlord](../configuration/index.md#dynamic-configuration) in Apache Druid. +This document describes the API endpoints to retrieve and manage dynamic configurations for the [Coordinator](../design/coordinator.md) and [Overlord](../design/overlord.md) in Apache Druid. + +In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. +Replace it with the information for your deployment. +For example, use `http://localhost:8888` for quickstart deployments. ## Coordinator dynamic configuration -See [Coordinator Dynamic Configuration](../configuration/index.md#dynamic-configuration) for details. +The Coordinator has dynamic configurations to tune certain behavior on the fly, without requiring a service restart. +For information on dynamic configuration spec properties, see [Coordinator dynamic configuration](../configuration/index.md#dynamic-configuration). Review Comment: ```suggestion For information on the supported properties, see [Coordinator dynamic configuration](../configuration/index.md#dynamic-configuration). ``` ########## docs/api-reference/dynamic-configuration-api.md: ########## @@ -23,53 +23,591 @@ sidebar_label: Dynamic configuration ~ under the License. --> -This document describes the API endpoints to retrieve and manage the dynamic configurations for the [Coordinator](../configuration/index.md#overlord-dynamic-configuration) and [Overlord](../configuration/index.md#dynamic-configuration) in Apache Druid. +This document describes the API endpoints to retrieve and manage dynamic configurations for the [Coordinator](../design/coordinator.md) and [Overlord](../design/overlord.md) in Apache Druid. + +In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. +Replace it with the information for your deployment. +For example, use `http://localhost:8888` for quickstart deployments. ## Coordinator dynamic configuration -See [Coordinator Dynamic Configuration](../configuration/index.md#dynamic-configuration) for details. +The Coordinator has dynamic configurations to tune certain behavior on the fly, without requiring a service restart. +For information on dynamic configuration spec properties, see [Coordinator dynamic configuration](../configuration/index.md#dynamic-configuration). + +### Get Coordinator dynamic configuration Review Comment: Since these are all in the "Coordinator" heading, what do you think about removing it from the subsection headings to make it a bit easier to skim? So for example, something like: * Get dynamic configuration * Update dynamic configuration * Get dynamic configuration history Current preview:  ########## docs/api-reference/dynamic-configuration-api.md: ########## @@ -23,53 +23,591 @@ sidebar_label: Dynamic configuration ~ under the License. --> -This document describes the API endpoints to retrieve and manage the dynamic configurations for the [Coordinator](../configuration/index.md#overlord-dynamic-configuration) and [Overlord](../configuration/index.md#dynamic-configuration) in Apache Druid. +This document describes the API endpoints to retrieve and manage dynamic configurations for the [Coordinator](../design/coordinator.md) and [Overlord](../design/overlord.md) in Apache Druid. + +In this topic, `http://ROUTER_IP:ROUTER_PORT` is a placeholder for your Router service address and port. +Replace it with the information for your deployment. +For example, use `http://localhost:8888` for quickstart deployments. ## Coordinator dynamic configuration -See [Coordinator Dynamic Configuration](../configuration/index.md#dynamic-configuration) for details. +The Coordinator has dynamic configurations to tune certain behavior on the fly, without requiring a service restart. +For information on dynamic configuration spec properties, see [Coordinator dynamic configuration](../configuration/index.md#dynamic-configuration). + +### Get Coordinator dynamic configuration + +Retrieves current Coordinator dynamic configuration. Returns a JSON object with the dynamic configuration properties and values. Review Comment: ```suggestion Retrieves the current Coordinator dynamic configuration. Returns a JSON object with the dynamic configuration properties and values. ``` -- 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]
