Skip to content

Add default command_id for execute api #649

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tode-rl merged 2 commits into from
Oct 2, 2025
Merged

Add default command_id for execute api #649

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6b7be2
add default for execute api
tode-rl Oct 1, 2025
18fefcb
comment to explain deprecation
tode-rl Oct 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions src/runloop_api_client/resources/devboxes/devboxes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,7 +718,7 @@ def execute(
id: str,
*,
command: str,
command_id: str,
command_id: str = str(uuid7()),
optimistic_timeout: Optional[int] | Omit = omit,
shell_name: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
Expand Down Expand Up @@ -897,6 +897,7 @@ def execute_async(
)

@typing_extensions.deprecated("deprecated")
# Use execute, executeAsync, or executeAndAwaitCompletion instead
def execute_sync(
self,
id: str,
Expand All @@ -915,6 +916,9 @@ def execute_sync(
Execute a bash command in the Devbox shell, await the command completion and
return the output.

.. deprecated::
Use execute, executeAsync, or executeAndAwaitCompletion instead.

Args:
command: The command to execute via the Devbox shell. By default, commands are run from
the user home directory unless shell_name is specified. If shell_name is
Expand Down Expand Up @@ -2161,7 +2165,7 @@ async def execute(
id: str,
*,
command: str,
command_id: str,
command_id: str = str(uuid7()),
optimistic_timeout: Optional[int] | Omit = omit,
shell_name: Optional[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
Expand Down Expand Up @@ -2341,6 +2345,7 @@ async def execute_async(
)

@typing_extensions.deprecated("deprecated")
# Use execute, executeAsync, or executeAndAwaitCompletion instead
async def execute_sync(
self,
id: str,
Expand All @@ -2359,6 +2364,9 @@ async def execute_sync(
Execute a bash command in the Devbox shell, await the command completion and
return the output.

.. deprecated::
Use execute, executeAsync, or executeAndAwaitCompletion instead.

Args:
command: The command to execute via the Devbox shell. By default, commands are run from
the user home directory unless shell_name is specified. If shell_name is
Expand Down