unikraft-cloud-plugin-sandbox-api 1.1.0.dev17__tar.gz → 1.1.1.dev12__tar.gz

{unikraft_cloud_plugin_sandbox_api-1.1.0.dev17 → unikraft_cloud_plugin_sandbox_api-1.1.1.dev12}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: unikraft-cloud-plugin-sandbox-api
-Version: 1.1.0.dev17
+Version: 1.1.1.dev12
 Summary: Generated Python client for the Unikraft Cloud `sandbox` plugin API
 Keywords: unikraft,unikraft-cloud,plugin,sandbox,sdk
 Author: Unikraft GmbH

{unikraft_cloud_plugin_sandbox_api-1.1.0.dev17 → unikraft_cloud_plugin_sandbox_api-1.1.1.dev12}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "unikraft-cloud-plugin-sandbox-api"
-version = "1.1.0.dev17"
+version = "1.1.1.dev12"
 description = "Generated Python client for the Unikraft Cloud `sandbox` plugin API"
 readme = "README.md"
 license = "BSD-3-Clause"

{unikraft_cloud_plugin_sandbox_api-1.1.0.dev17 → unikraft_cloud_plugin_sandbox_api-1.1.1.dev12}/src/unikraft_cloud_plugin_sandbox_api/_meta.py

@@ -5,16 +5,16 @@
 # can tell a rebuild of the same sources from a change under the same version.
 
 #: The version this package was published as.
-VERSION = "1.1.0.dev17"
+VERSION = "1.1.1.dev12"
 
 #: The oldest unikraft-cloud SDK whose ApiClient is a transport for this package.
 SDK_MIN = "0.2.0"
 
 #: SHA-256 of the OpenAPI specification.
-SPEC_HASH = "fe2a902ae04c2934eb14f7e7db0f5e75f9598471532986f01a939229d38b06d4"
+SPEC_HASH = "cfae5b85e8cd454a69654af5d529bf2fda72cf3fd56422e2fe843636b8457843"
 
 #: SHA-256 over the generator's templates and static files.
 TEMPLATES_HASH = "5efe373fc719c482bc42cc6ff89c27852a6bfef78c9e6d841a1f21eab2f97859"
 
 #: SHA-256 over the generation configuration: the SDK floor and the generator.
-CONFIG_HASH = "4332d5b927c34d12c6ba2d2ba5ef3350298d5ee9f95fb06fd6dbcca1d5877ae2"
+CONFIG_HASH = "15795a51671a13fcc063368040d9d013ebbf5ee0a5053750f3d6ed8d8c67e31b"

{unikraft_cloud_plugin_sandbox_api-1.1.0.dev17 → unikraft_cloud_plugin_sandbox_api-1.1.1.dev12}/src/unikraft_cloud_plugin_sandbox_api/commands_gen.py

@@ -106,6 +106,22 @@ class CommandsApi:
             **options,
         )
 
+    async def resize_command_terminal(
+        self,
+        uuid: str,
+        *,
+        body: models.CommandResizeRequest,
+        **options: Unpack[CallOptions],
+    ) -> models.EmptyResponse:
+        """Resize Command Terminal"""
+        return await self.transport.request(
+            models.EmptyResponse,
+            method="POST",
+            path=f"/commands/{quote(uuid, safe='')}/resize",
+            body=body,
+            **options,
+        )
+
     async def run_command(
         self,
         *,

{unikraft_cloud_plugin_sandbox_api-1.1.0.dev17 → unikraft_cloud_plugin_sandbox_api-1.1.1.dev12}/src/unikraft_cloud_plugin_sandbox_api/models_gen.py

@@ -105,6 +105,21 @@ class CommandLogsResponse(BaseModel):
     """The operation time in microseconds."""
 
 
+class CommandResizeRequest(BaseModel):
+    """The request to resize a command's terminal."""
+
+    # Fields the specification does not describe are kept rather than dropped,
+    # so a newly added one survives a round trip and does not break this client.
+    # A field the specification requires is required here too, so a request
+    # missing one fails at construction rather than at the server.
+    model_config = ConfigDict(extra="allow", populate_by_name=True)
+
+    cols: int
+    """The new width, in columns."""
+    rows: int
+    """The new height, in rows."""
+
+
 class CommandSignalRequest(BaseModel):
     """The request to send a signal to a command."""
 
@@ -194,6 +209,13 @@ class GetCommandData(BaseModel):
     """The current working directory, if supplied at startup, else null"""
     env: dict[str, str] | None = None
     """Environment variables, if supplied at startup, else null"""
+    pty: bool | None = None
+    """Whether the command runs on a pseudo-terminal."""
+    duration_ms: int | None = None
+    """
+    Milliseconds from start to exit, or to now while the command runs. `null`
+    for a command restored from a status file written before it was recorded.
+    """
     exitcode: int | None = None
     """
     The exit code of the command. It is `null` while the command is still
@@ -338,7 +360,7 @@ class ResponseError(BaseModel):
 
 
 class RunCommandData(BaseModel):
-    """The identity of a newly started command."""
+    """The command that was started, as `GET .../{uuid}` describes it."""
 
     # Fields the specification does not describe are kept rather than dropped,
     # so a newly added one survives a round trip and does not break this client.
@@ -347,7 +369,33 @@ class RunCommandData(BaseModel):
     model_config = ConfigDict(extra="allow", populate_by_name=True)
 
     uuid: str | None = None
-    """The UUID assigned to the newly started command."""
+    """The UUID of the command."""
+    cmdline: CommandLineShell | CommandLineArgs | None = None
+    """
+    The command the command was started with, in the form it was supplied in:
+    a shell command line, or an argument vector.
+    """
+    cwd: str | None = None
+    """The current working directory, if supplied at startup, else null"""
+    env: dict[str, str] | None = None
+    """Environment variables, if supplied at startup, else null"""
+    pty: bool | None = None
+    """Whether the command runs on a pseudo-terminal."""
+    duration_ms: int | None = None
+    """
+    Milliseconds from start to exit, or to now while the command runs. `null`
+    for a command restored from a status file written before it was recorded.
+    """
+    exitcode: int | None = None
+    """
+    The exit code of the command. It is `null` while the command is still
+    running.
+    """
+    logs: CommandLogsData | None = None
+    """
+    Only with `req_timeout_s`: the output, as `GET .../logs` returns it.
+    Absent if the logs were deleted while the request waited.
+    """
 
 
 class RunCommandRequest(BaseModel):
@@ -370,6 +418,50 @@ class RunCommandRequest(BaseModel):
     """(OPTIONAL) Current working directory"""
     env: dict[str, str] | None = None
     """(OPTIONAL) Environment variables"""
+    pty: bool | None = None
+    """
+    (OPTIONAL) Run the command on a pseudo-terminal instead of pipes. Its
+    output, stdout and stderr merged as a terminal shows them, is served as
+    `stdout`; input fed to it is echoed by the terminal; an `eof` on stdin
+    types the terminal's end-of-input character rather than closing anything;
+    and deleting the logs hangs the terminal up, which ends most commands.
+    `TERM` is set to `xterm-256color` unless `env` provides one.
+    """
+    cols: int | None = None
+    """(OPTIONAL) The terminal's width in columns. Needs `pty`; 80 by default."""
+    rows: int | None = None
+    """(OPTIONAL) The terminal's height in rows. Needs `pty`; 24 by default."""
+    stdin: str | None = None
+    """
+    (OPTIONAL) Bytes to feed into standard input before anything else,
+    base64-encoded, exactly as a `POST .../stdin` right after the start would.
+    """
+    stdin_eof: bool | None = None
+    """
+    (OPTIONAL) Whether to close standard input after `stdin` (at once when
+    there is none). Defaults to `true` when `req_timeout_s` is given, since
+    nothing can be fed until the request answers, and to `false` otherwise.
+    """
+    req_timeout_s: float | None = None
+    """
+    (OPTIONAL) Block until the command exits or this many seconds have
+    passed, then answer with the command's state and output (`logs`). More
+    than 0 and at most 55: a proxy in front cuts a silent request at about a
+    minute. A timeout is not an error: the answer has `exitcode: null`, the
+    output so far, and the command keeps running, addressable by UUID as any
+    other. Absent: answer as soon as the command has started.
+    """
+    logs_limit: int | None = None
+    """
+    (OPTIONAL) With `req_timeout_s`: at most this many bytes of each stream in
+    the answer, the rest staying at `GET .../logs`. Whole streams by default.
+    """
+    forget: bool | None = None
+    """
+    (OPTIONAL) With `req_timeout_s`: forget the command once it has finished,
+    as `DELETE .../{uuid}` would, so that one request is the whole exchange.
+    Does nothing on a timeout, when the UUID is still needed.
+    """
 
 
 class RunCommandResponse(BaseModel):
@@ -451,6 +543,7 @@ for _model in (
     CommandLogsRange,
     CommandLogsRequest,
     CommandLogsResponse,
+    CommandResizeRequest,
     CommandSignalRequest,
     CommandStdinRequest,
     CommandWaitTimeoutRequest,