Browse Source

[docs] Update /get_filesystem public API section (#3078)

- Added new sample response.
- Improved the API description.
Harsh Gupta 3 years ago
parent
commit
af74791388
1 changed files with 2 additions and 2 deletions
  1. 2 2
      docs/docs-site/content/developer/api/rest/_index.md

+ 2 - 2
docs/docs-site/content/developer/api/rest/_index.md

@@ -357,11 +357,11 @@ Hue's [File Browser](https://docs.gethue.com/user/browsing/#data) offer uploads,
 
 
 ### Get Filesystems
 ### Get Filesystems
 
 
-Get the filesystems configured with Hue:
+Get the filesystems details such as configured filesystems in Hue which user has access to and its home directories:
 
 
     curl -X POST https://demo.gethue.com/api/storage/get_filesystems
     curl -X POST https://demo.gethue.com/api/storage/get_filesystems
     
     
-    {"status": 0, "filesystems": {"s3a": true}}
+    [{"file_system": "hdfs", "user_home_directory": "/user/demo"}, {"file_system": "s3a", "user_home_directory": "s3a://<some_s3_path>"}, {"file_system": "abfs", "user_home_directory": "abfs://<some_abfs_path>"}]
 
 
 ### List
 ### List