Browse Source

[docs] Add /get_filesystem API and improve some curl API examples (#2724)

Harsh Gupta 3 years ago
parent
commit
d5088ce1b2
1 changed files with 17 additions and 9 deletions
  1. 17 9
      docs/docs-site/content/developer/api/rest/_index.md

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

@@ -353,10 +353,18 @@ We can choose a dialect for `doc_type` e.g. impala, mysql, hive, phoenix, etc.
 
 ## File Browsing
 
-### List
-
 Hue's [File Browser](https://docs.gethue.com/user/browsing/#data) offer uploads, downloads, operations (create, delete, chmod...) and listing of data in HDFS (hdfs:// or no prefix), S3 (s3a:// prefix), ADLS (adls:// or abfs:// prefixes) storages.
 
+### Get Filesystems
+
+Get the filesystems configured with Hue:
+
+    curl -X POST https://demo.gethue.com/api/storage/get_filesystems
+    
+    {"status": 0, "filesystems": {"s3a": true}}
+
+### List
+
 Here is how to list the content of a path, here a S3 bucket `s3a://demo-gethue`:
 
     curl -X GET https://demo.gethue.com/api/storage/view=s3a://demo-gethue
@@ -564,13 +572,13 @@ This is the same as creating a new connector instance, but as we provide the `id
 
 ### Delete
 
-    curl -X POST 'https://demo.gethue.com/api/connector/instance/delete' -d 'connector={"id": "1"}'
+    curl -X POST https://demo.gethue.com/api/connector/instance/delete -d 'connector={"id": "1"}'
 
 ### Test
 
 Check if the connectivity is healthy:
 
-    curl -X POST 'https://demo.gethue.com/api/connector/instance/test/' -d 'connector={"nice_name":"Hive Docker Local","name":"41","dialect":"hive","interface":"hiveserver2","settings":[{"name":"server_host","value":"localhost"},{"name":"server_port","value":10000},{"name":"is_llap","value":false},{"name":"use_sasl","value":"true"}],"id":"41","category":"editor","description":"Recommended","dialect_properties":{"is_sql":true,"sql_identifier_quote":"`","sql_identifier_comment_single":"--","has_catalog":false,"has_database":true,"has_table":true,"has_live_queries":false,"has_optimizer_risks":true,"has_optimizer_values":true,"has_auto_limit":false,"has_reference_language":true,"has_reference_functions":true,"has_use_statement":true}}'
+    curl -X POST https://demo.gethue.com/api/connector/instance/test/ -d 'connector={"nice_name":"Hive Docker Local","name":"41","dialect":"hive","interface":"hiveserver2","settings":[{"name":"server_host","value":"localhost"},{"name":"server_port","value":10000},{"name":"is_llap","value":false},{"name":"use_sasl","value":"true"}],"id":"41","category":"editor","description":"Recommended","dialect_properties":{"is_sql":true,"sql_identifier_quote":"`","sql_identifier_comment_single":"--","has_catalog":false,"has_database":true,"has_table":true,"has_live_queries":false,"has_optimizer_risks":true,"has_optimizer_values":true,"has_auto_limit":false,"has_reference_language":true,"has_reference_functions":true,"has_use_statement":true}}'
 
 ### Examples
 
@@ -584,7 +592,7 @@ Install or update the connector examples:
 
 Get user records in Hue. Requires **admin privileges**.
 
-    curl -X GET http://demo.gethue.com/api/iam/get_users
+    curl -X GET https://demo.gethue.com/api/iam/get_users
 
 Optional GET params:
 - **username:** filter by username
@@ -595,13 +603,13 @@ E.g. `?username=demo&groups=default&is_active=true`
 
 Search user records by list of user IDs. Requires **admin privileges**.
 
-    curl -X GET http://demo.gethue.com/api/iam/users?userids=[1100714,1100715]
+    curl -X GET https://demo.gethue.com/api/iam/users?userids=[1100714,1100715]
     
     {"users": [{"id": 1100714,"username": "demo","first_name": "","last_name": "","email": "","last_login": "2021-10-06T01:36:49.663","editURL": "/useradmin/users/edit/demo"},{"id": 1100715,"username": "hue","first_name": "","last_name": "","email": "","last_login": "2021-08-11T07:15:48.793","editURL": "/useradmin/users/edit/hue"}]}
 
 User list_for_autocomplete API:
 
-    curl -X GET http://demo.gethue.com/api/iam/users/autocomplete
+    curl -X GET https://demo.gethue.com/api/iam/users/autocomplete
  
 Optional GET params:
 - **extend_user:** true or false (info about each user's groups)
@@ -614,7 +622,7 @@ The [metadata API](https://github.com/cloudera/hue/tree/master/desktop/libs/meta
 
 ### Searching for entities
     
-    curl -X POST http://demo.gethue.com/api/metadata/search/entities_interactive/' -d 'query_s="*sample"&sources=["documents", "sql", "hdfs", "s3"]'
+    curl -X POST https://demo.gethue.com/api/metadata/search/entities_interactive/ -d 'query_s="*sample"&sources=["documents", "sql", "hdfs", "s3"]'
 
 Some of the parameters:
 - **query_s:** search term
@@ -624,7 +632,7 @@ Some of the parameters:
 
 Searching for entities with the `dummy` catalog:
 
-    curl -X POST http://demo.gethue.com/api/metadata/search/entities_interactive/ -d 'query_s="*sample"&interface="dummy"'
+    curl -X POST https://demo.gethue.com/api/metadata/search/entities_interactive/ -d 'query_s="*sample"&interface="dummy"'
 
 ### Finding an entity