[GitHub] [ozone] yuangu002 commented on a change in pull request #2566: HDDS-5637. Add documentation for Recon Namespace REST APIs

[GitBox <gi...@apache.org>]

yuangu002 commented on a change in pull request #2566:
URL: https://github.com/apache/ozone/pull/2566#discussion_r695244671



##########
File path: hadoop-hdds/docs/content/interface/ReconApi.md
##########
@@ -232,7 +232,174 @@ Returns the UnhealthyContainerMetadata objects for all the unhealthycontainers.
 Returns the UnhealthyContainerMetadata objects for the containers in the givenstate.
 Possible unhealthy container states are `MISSING`, `MIS_REPLICATED`,`UNDER_REPLICATED`, `OVER_REPLICATED`.
 The response structure is same as `/containers/unhealthy`.
-     
+
+## Namespace Metadata
+
+### GET /api/v1/namespace/summary
+
+**Parameters**
+
+* path
+
+   The path request in string without any protocol prefix.
+
+**Returns**
+
+Returns a basic summary of the path, including entity type and aggregate count 
+of objects under the path.
+
+`status` is `OK` if path exists, `PATH_NOT_FOUND` otherwise.
+
+Example: /api/v1/namespace/summary?path=/

Review comment:
       Thanks @kerneltime for taking a look! Do we need examples of non-root path for all endpoints?




-- 
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: issues-unsubscribe@ozone.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@ozone.apache.org
For additional commands, e-mail: issues-help@ozone.apache.org