docs: add api docs for expose (#1130)

* docs: add api docs for expose Signed-off-by: nullday <[email protected]> * Reformat Signed-off-by: nullday <[email protected]> Signed-off-by: nullday <[email protected]>
tensorchord · Nov 1, 2022 · 3233cd6 · 3233cd6
1 parent 7bf8c00
commit 3233cd6
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/envd/api/runtime/__init__.py b/envd/api/runtime/__init__.py
@@ -42,7 +42,12 @@ def command(commands: Dict[str, str]):
     """
 
 
-def expose(envd_port: str, host_port: Optional[str], service: Optional[str]):
+def expose(
+    envd_port: str,
+    host_port: Optional[str],
+    service: Optional[str],
+    listen_addr: Optional[str],
+):
     """Expose port to host
     Proposal: https://github.com/tensorchord/envd/pull/780
 
@@ -51,6 +56,7 @@ def expose(envd_port: str, host_port: Optional[str], service: Optional[str]):
         host_port (Optional[str]): port in the host, if not provided or
             `host_port=0`, `envd` will randomly choose a free port
         service (Optional[str]): service name
+        listen_addr (Optional[str]): address to listen on
     """