mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-25 21:36:52 +08:00
Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: sp.wack <83104063+amanape@users.noreply.github.com> Co-authored-by: Engel Nyst <enyst@users.noreply.github.com>
59 lines
1.5 KiB
Python
59 lines
1.5 KiB
Python
from datetime import datetime
|
|
from enum import Enum
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
from openhands.agent_server.utils import utc_now
|
|
|
|
|
|
class SandboxStatus(Enum):
|
|
STARTING = 'STARTING'
|
|
RUNNING = 'RUNNING'
|
|
PAUSED = 'PAUSED'
|
|
ERROR = 'ERROR'
|
|
MISSING = 'MISSING'
|
|
"""Missing - possibly deleted"""
|
|
|
|
|
|
class ExposedUrl(BaseModel):
|
|
"""URL to access some named service within the container."""
|
|
|
|
name: str
|
|
url: str
|
|
|
|
|
|
# Standard names
|
|
AGENT_SERVER = 'AGENT_SERVER'
|
|
VSCODE = 'VSCODE'
|
|
|
|
|
|
class SandboxInfo(BaseModel):
|
|
"""Information about a sandbox."""
|
|
|
|
id: str
|
|
created_by_user_id: str | None
|
|
sandbox_spec_id: str
|
|
status: SandboxStatus
|
|
session_api_key: str | None = Field(
|
|
description=(
|
|
'Key to access sandbox, to be added as an `X-Session-API-Key` header '
|
|
'in each request. In cases where the sandbox statues is STARTING or '
|
|
'PAUSED, or the current user does not have full access '
|
|
'the session_api_key will be None.'
|
|
)
|
|
)
|
|
exposed_urls: list[ExposedUrl] | None = Field(
|
|
default_factory=lambda: [],
|
|
description=(
|
|
'URLs exposed by the sandbox (App server, Vscode, etc...)'
|
|
'Sandboxes with a status STARTING / PAUSED / ERROR may '
|
|
'not return urls.'
|
|
),
|
|
)
|
|
created_at: datetime = Field(default_factory=utc_now)
|
|
|
|
|
|
class SandboxPage(BaseModel):
|
|
items: list[SandboxInfo]
|
|
next_page_id: str | None = None
|