techdocsmith commented on code in PR #14372:
URL: https://github.com/apache/druid/pull/14372#discussion_r1220254410


##########
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 data management API endpoints for Apache Druid. 
This included information on how to mark segments as `used` or `unused` and 
delete them from Druid.

Review Comment:
   ```suggestion
   This document describes the data management API endpoints for Apache Druid. 
This includes information on how to mark segments as `used` or `unused` and 
delete them from Druid.
   ```
   typo



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

Review Comment:
   Let's add brief descriptions to the bullets. Sorry I wasn't clear a about 
that.
   
   For example
   ```
   * [Automatic compaction](./automatic-compaction-api.md) to optimize segment 
sizes after ingestion.
   ```



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

Reply via email to