Skip to content

Commit 53adee2

Browse files
author
stlc-bot
committed
chore(security): Improve security docs and tighten JWT audience
Stainless-Generated-From: 8076923f9d8292b27cc565c0aef7e35567853004
1 parent 4c0df1f commit 53adee2

4 files changed

Lines changed: 19 additions & 7 deletions

File tree

‎scripts/mock‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎src/runloop_api_client/resources/devboxes/devboxes.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -926,10 +926,12 @@ def enable_tunnel(
926926
URL-based access to the Devbox without exposing internal IDs. The tunnel URL
927927
format is: https://{port}-{tunnel_key}.tunnel.runloop.ai
928928
929-
Each Devbox can have one tunnel.
929+
Each Devbox can have one tunnel. If tunnel config is omitted, or auth_mode is
930+
omitted, the tunnel defaults to open (public hostname, no bearer token).
930931
931932
Args:
932-
auth_mode: Authentication mode for the tunnel. Defaults to 'public' if not specified.
933+
auth_mode: Authentication mode for the tunnel. Defaults to open if omitted: the hostname is
934+
a public capability and does not require a tunnel bearer token.
933935
934936
http_keep_alive: When true, HTTP traffic through the tunnel counts as activity for idle lifecycle
935937
policies, resetting the idle timer. Defaults to true if not specified.
@@ -2762,10 +2764,12 @@ async def enable_tunnel(
27622764
URL-based access to the Devbox without exposing internal IDs. The tunnel URL
27632765
format is: https://{port}-{tunnel_key}.tunnel.runloop.ai
27642766
2765-
Each Devbox can have one tunnel.
2767+
Each Devbox can have one tunnel. If tunnel config is omitted, or auth_mode is
2768+
omitted, the tunnel defaults to open (public hostname, no bearer token).
27662769
27672770
Args:
2768-
auth_mode: Authentication mode for the tunnel. Defaults to 'public' if not specified.
2771+
auth_mode: Authentication mode for the tunnel. Defaults to open if omitted: the hostname is
2772+
a public capability and does not require a tunnel bearer token.
27692773
27702774
http_keep_alive: When true, HTTP traffic through the tunnel counts as activity for idle lifecycle
27712775
policies, resetting the idle timer. Defaults to true if not specified.

‎src/runloop_api_client/types/devbox_create_params.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,11 @@ class Tunnel(TypedDict, total=False):
142142
"""
143143

144144
auth_mode: Optional[Literal["open", "authenticated"]]
145-
"""Authentication mode for the tunnel. Defaults to 'public' if not specified."""
145+
"""Authentication mode for the tunnel.
146+
147+
Defaults to open if omitted: the hostname is a public capability and does not
148+
require a tunnel bearer token.
149+
"""
146150

147151
http_keep_alive: Optional[bool]
148152
"""

‎src/runloop_api_client/types/devbox_enable_tunnel_params.py‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,11 @@
1010

1111
class DevboxEnableTunnelParams(TypedDict, total=False):
1212
auth_mode: Optional[Literal["open", "authenticated"]]
13-
"""Authentication mode for the tunnel. Defaults to 'public' if not specified."""
13+
"""Authentication mode for the tunnel.
14+
15+
Defaults to open if omitted: the hostname is a public capability and does not
16+
require a tunnel bearer token.
17+
"""
1418

1519
http_keep_alive: Optional[bool]
1620
"""

0 commit comments

Comments
 (0)