mirror of
https://github.com/basicmachines-co/basic-memory
synced 2026-06-21 13:47:35 +00:00
Paul Hernandez
76 lines
2.8 KiB
Python
76 lines
2.8 KiB
Python
"""Schemas for cloud-related API responses."""
|
|
|
|
from pydantic import BaseModel, Field
|
|
|
|
|
|
class TenantMountInfo(BaseModel):
|
|
"""Response from /tenant/mount/info endpoint."""
|
|
|
|
tenant_id: str = Field(..., description="Unique identifier for the tenant")
|
|
bucket_name: str = Field(..., description="S3 bucket name for the tenant")
|
|
|
|
|
|
class MountCredentials(BaseModel):
|
|
"""Response from /tenant/mount/credentials endpoint."""
|
|
|
|
access_key: str = Field(..., description="S3 access key for mount")
|
|
secret_key: str = Field(..., description="S3 secret key for mount")
|
|
|
|
|
|
class CloudProject(BaseModel):
|
|
"""Representation of a cloud project."""
|
|
|
|
name: str = Field(..., description="Project name")
|
|
path: str = Field(..., description="Project path on cloud")
|
|
|
|
|
|
class CloudProjectList(BaseModel):
|
|
"""Response from /proxy/v2/projects endpoint."""
|
|
|
|
projects: list[CloudProject] = Field(default_factory=list, description="List of cloud projects")
|
|
|
|
|
|
class CloudProjectCreateRequest(BaseModel):
|
|
"""Request to create a new cloud project."""
|
|
|
|
name: str = Field(..., description="Project name")
|
|
path: str = Field(..., description="Project path (permalink)")
|
|
set_default: bool = Field(default=False, description="Set as default project")
|
|
|
|
|
|
class CloudProjectCreateResponse(BaseModel):
|
|
"""Response from creating a cloud project."""
|
|
|
|
message: str = Field(..., description="Status message about the project creation")
|
|
status: str = Field(..., description="Status of the creation (success or error)")
|
|
default: bool = Field(..., description="True if the project was set as the default")
|
|
old_project: dict | None = Field(None, description="Information about the previous project")
|
|
new_project: dict | None = Field(
|
|
None, description="Information about the newly created project"
|
|
)
|
|
|
|
|
|
class WorkspaceInfo(BaseModel):
|
|
"""Workspace entry from /workspaces/ endpoint."""
|
|
|
|
tenant_id: str = Field(..., description="Workspace tenant identifier")
|
|
workspace_type: str = Field(..., description="Workspace type (personal or organization)")
|
|
name: str = Field(..., description="Workspace display name")
|
|
role: str = Field(..., description="Current user's role in the workspace")
|
|
organization_id: str | None = Field(None, description="Organization ID for org workspaces")
|
|
has_active_subscription: bool = Field(
|
|
default=False, description="Whether the workspace has an active subscription"
|
|
)
|
|
|
|
|
|
class WorkspaceListResponse(BaseModel):
|
|
"""Response from /workspaces/ endpoint."""
|
|
|
|
workspaces: list[WorkspaceInfo] = Field(
|
|
default_factory=list, description="Available workspaces"
|
|
)
|
|
count: int = Field(default=0, description="Number of available workspaces")
|
|
current_workspace_id: str | None = Field(
|
|
default=None, description="Current workspace tenant ID when available"
|
|
)
|