From 3233cd6517fd8b9c840ac5c8e1f5f85454e947bb Mon Sep 17 00:00:00 2001 From: nullday Date: Tue, 1 Nov 2022 13:53:11 +0800 Subject: [PATCH] docs: add api docs for expose (#1130) * docs: add api docs for expose Signed-off-by: nullday * Reformat Signed-off-by: nullday Signed-off-by: nullday --- envd/api/runtime/__init__.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/envd/api/runtime/__init__.py b/envd/api/runtime/__init__.py index db10244a2..fedc0f403 100644 --- 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 """