Skip to content

project

ProjectCreateV1

Bases: _ProjectBaseV1

Class for Project creation.

Source code in fractal_server/app/schemas/v1/project.py 
30
31
32
33
34
35
36
class ProjectCreateV1(_ProjectBaseV1):
    """
    Class for `Project` creation.
    """

    # Validators
    _name = validator("name", allow_reuse=True)(valstr("name"))

ProjectReadV1

Bases: _ProjectBaseV1

Class for Project read from database.

Attributes:

Name Type Description
id int
name int
read_only int
Source code in fractal_server/app/schemas/v1/project.py 
39
40
41
42
43
44
45
46
47
48
49
50
class ProjectReadV1(_ProjectBaseV1):
    """
    Class for `Project` read from database.

    Attributes:
        id:
        name:
        read_only:
    """

    id: int
    timestamp_created: datetime

ProjectUpdateV1

Bases: _ProjectBaseV1

Class for Project update.

Attributes:

Name Type Description
name Optional[str]
read_only Optional[bool]
Source code in fractal_server/app/schemas/v1/project.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
66
class ProjectUpdateV1(_ProjectBaseV1):
    """
    Class for `Project` update.

    Attributes:
        name:
        read_only:
    """

    name: Optional[str]
    read_only: Optional[bool]

    # Validators
    _name = validator("name", allow_reuse=True)(valstr("name"))

_ProjectBaseV1

Bases: BaseModel

Base class for Project.

Attributes:

Name Type Description
name str
read_only bool
Source code in fractal_server/app/schemas/v1/project.py 
17
18
19
20
21
22
23
24
25
26
27
class _ProjectBaseV1(BaseModel):
    """
    Base class for `Project`.

    Attributes:
        name:
        read_only:
    """

    name: str
    read_only: bool = False