flip_api.domain.schemas.projects

Attributes

T

Classes

`UserAccessInfo`
`ProjectQueryInfo`
`ApprovedTrustInfo`
`ProjectDetailResponse`
`ProjectListItemSchema`
`PagedResponse`	Abstract base class for generic types.
`ImagingProject`
`XnatProjectStatusInfo`
`ApproveProjectBodyPayload`
`ProjectDetails`
`StageProjectRequest`

Module Contents

class flip_api.domain.schemas.projects.UserAccessInfo

Bases: sqlmodel.SQLModel

id: uuid.UUID

email: str

class flip_api.domain.schemas.projects.ProjectQueryInfo

Bases: sqlmodel.SQLModel

id: uuid.UUID

query_string: str

class flip_api.domain.schemas.projects.ApprovedTrustInfo

Bases: sqlmodel.SQLModel

id: uuid.UUID

name: str

status: str

class flip_api.domain.schemas.projects.ProjectDetailResponse

Bases: sqlmodel.SQLModel

id: uuid.UUID

name: str

description: str | None = None

status: str

owner_id: uuid.UUID

created_at: datetime.datetime

updated_at: datetime.datetime

query_id: uuid.UUID | None = None

owner_email: str | None = None

query_details: ProjectQueryInfo | None = None

approved_trusts: list[ApprovedTrustInfo] = []

users_with_access: list[UserAccessInfo] = []

class flip_api.domain.schemas.projects.ProjectListItemSchema

Bases: pydantic.BaseModel

id: uuid.UUID

name: str

description: str | None = None

owner_id: uuid.UUID

created_at: datetime.datetime

status: str

model_config

flip_api.domain.schemas.projects.T

class flip_api.domain.schemas.projects.PagedResponse

Bases: pydantic.BaseModel, Generic[T]

Abstract base class for generic types.

A generic type is typically declared by inheriting from this class parameterized with one or more type variables. For example, a generic mapping type might be defined as:

class Mapping(Generic[KT, VT]):
    def __getitem__(self, key: KT) -> VT:
        ...
    # Etc.

This class can then be used as follows:

def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT:
    try:
        return mapping[key]
    except KeyError:
        return default

page_number: int

page_size: int

total_pages: int

total_records: int

data: list[T]

model_config

class flip_api.domain.schemas.projects.ImagingProject

Bases: pydantic.BaseModel

id: uuid.UUID | None = None

xnat_project_id: uuid.UUID | None = None

trust_id: uuid.UUID

retrieve_image_status: flip_api.domain.schemas.status.XNATImageStatus | None = None

name: str

reimport_count: int = 0

class flip_api.domain.schemas.projects.XnatProjectStatusInfo

Bases: pydantic.BaseModel

retrieve_image_status: flip_api.domain.schemas.status.XNATImageStatus

reimport_count: int

class flip_api.domain.schemas.projects.ApproveProjectBodyPayload

Bases: pydantic.BaseModel

trusts: list[uuid.UUID]

class flip_api.domain.schemas.projects.ProjectDetails

Bases: pydantic.BaseModel

name: str

description: str | None

users: list[uuid.UUID]

dicom_to_nifti: bool

classmethod strip_whitespace(value: str) → str

model_config

class flip_api.domain.schemas.projects.StageProjectRequest

Bases: pydantic.BaseModel

trusts: flip_api.domain.schemas.types.NonEmptyUUIDList

model_config