user_group

UserGroupCreate

Bases: BaseModel

Schema for UserGroup creation

ATTRIBUTE	DESCRIPTION
name	Group name TYPE: NonEmptyStr

Source code in fractal_server/app/schemas/user_group.py

class UserGroupCreate(BaseModel):
    """
    Schema for `UserGroup` creation

    Attributes:
        name: Group name
    """

    model_config = ConfigDict(extra="forbid")

    name: NonEmptyStr
    viewer_paths: ListUniqueAbsolutePathStr = Field(default_factory=list)

UserGroupRead

Bases: BaseModel

Schema for UserGroup read

NOTE: user_ids does not correspond to a column of the UserGroup table, but it is rather computed dynamically in relevant endpoints.

ATTRIBUTE	DESCRIPTION
id	Group ID TYPE: int
name	Group name TYPE: str
timestamp_created	Creation timestamp TYPE: AwareDatetime
user_ids	IDs of users of this group TYPE: list[int] | None

Source code in fractal_server/app/schemas/user_group.py

class UserGroupRead(BaseModel):
    """
    Schema for `UserGroup` read

    NOTE: `user_ids` does not correspond to a column of the `UserGroup` table,
    but it is rather computed dynamically in relevant endpoints.

    Attributes:
        id: Group ID
        name: Group name
        timestamp_created: Creation timestamp
        user_ids: IDs of users of this group
    """

    id: int
    name: str
    timestamp_created: AwareDatetime
    user_ids: list[int] | None = None
    viewer_paths: list[str]

    @field_serializer("timestamp_created")
    def serialize_datetime(v: datetime) -> str:
        return v.isoformat()

UserGroupUpdate

Bases: BaseModel

Schema for UserGroup update

Source code in fractal_server/app/schemas/user_group.py

class UserGroupUpdate(BaseModel):
    """
    Schema for `UserGroup` update
    """

    model_config = ConfigDict(extra="forbid")

    viewer_paths: ListUniqueAbsolutePathStr = None