techdocsmith commented on code in PR #14372: URL: https://github.com/apache/druid/pull/14372#discussion_r1218713723
########## docs/api-reference/dynamic-configuration-api.md: ########## @@ -0,0 +1,75 @@ +--- +id: dynamic-configuration-api +title: Dynamic configuration API +sidebar_label: Dynamic configuration +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for retrieving and managing dynamic configurations of the Coordinator and Overlord. Review Comment: ```suggestion This document describes the API endpoints to retrieve and manage the dynamic configurations for the [Coordinator](../configuration/index.html#overlord-dynamic-configuration) and [Overlord](..//configuration/index.html#dynamic-configuration) in Apache Druid. ``` ########## docs/api-reference/automatic-compaction-api.md: ########## @@ -0,0 +1,91 @@ +--- +id: automatic-compaction-api +title: Automatic compaction API +sidebar_label: Automatic compaction +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes API endpoints associated with automatic compaction in Apache Druid, detailing the status and configuration endpoints. Review Comment: Avoid admonitions for the beginning of docs. ```suggestion This document describes status and configuration API endpoints for [automatic compaction](../data-management/automatic-compaction.md) in Apache Druid. ``` ########## docs/api-reference/data-management-api.md: ########## @@ -0,0 +1,79 @@ +--- +id: data-management-api +title: Data management API +sidebar_label: Data management +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for data segment management. Review Comment: ```suggestion This document describes the data management API endpoints for Apache Druid. This included information on how to mark segments as `used` or `unused` and delete them from Druid. ``` In general, try to refer to Apache Druid in first paragraph of the Druid docs ########## docs/api-reference/legacy-metadata-api.md: ########## @@ -0,0 +1,295 @@ +--- +id: legacy-metadata-api +title: Legacy metadata API +sidebar_label: Legacy metadata +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for legacy metadata. Review Comment: ```suggestion This document describes the legacy API endpoints to retrieve datasource metadata from Apache Druid. Use the [SQL metadata tables](/querying/sql-metadata-tables.md) to retrieve datasource metadata instead. ``` ########## docs/api-reference/supervisor-api.md: ########## @@ -0,0 +1,111 @@ +--- +id: supervisor-api +title: Supervisor API +sidebar_label: Supervisor +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for managing and monitoring supervisors, including information retrieval and life cycle management. Review Comment: ```suggestion This document describes the API endpoints to manage and monitor supervisors for Apache Druid. ``` ########## docs/api-reference/lookups-api.md: ########## @@ -0,0 +1,278 @@ +--- +id: lookups-api +title: Lookups API +sidebar_label: Lookups +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints to configure, update, retrieve, and manage lookups. Review Comment: ```suggestion This document describes the API endpoints to configure, update, retrieve, and manage lookups for Apache Druid. ``` ########## docs/api-reference/service-status-api.md: ########## @@ -0,0 +1,176 @@ +--- +id: service-status-api +title: Service status API +sidebar_label: Service status +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for retrieving process status, cluster information, and task management. Review Comment: ```suggestion This document describes the API endpoints to retrieve service (process) status, cluster information for Apache Druid ``` Not sure why task management is here. We will need to verify that's correct. ########## docs/api-reference/json-querying-api.md: ########## @@ -0,0 +1,36 @@ +--- +id: json-querying-api +title: JSON querying API +sidebar_label: JSON querying +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for handling queries in Druid. Review Comment: ```suggestion This document describes the API endpoints to submit JSON-based [native queries](../querying/querying.md) to Apache Druid. ``` ########## docs/api-reference/retention-rules-api.md: ########## @@ -0,0 +1,89 @@ +--- +id: retention-rules-api +title: Retention rules API +sidebar_label: Retention rules +--- + +<!-- + ~ Licensed to the Apache Software Foundation (ASF) under one + ~ or more contributor license agreements. See the NOTICE file + ~ distributed with this work for additional information + ~ regarding copyright ownership. The ASF licenses this file + ~ to you under the Apache License, Version 2.0 (the + ~ "License"); you may not use this file except in compliance + ~ with the License. You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, + ~ software distributed under the License is distributed on an + ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + ~ KIND, either express or implied. See the License for the + ~ specific language governing permissions and limitations + ~ under the License. + --> + +> This document describes the API endpoints for managing retention rules and retrieving intervals. Review Comment: ```suggestion This document describes the API endpoints for managing retention rules in Apache Druid. ``` -- 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]
