Source code for galaxy.schema._common

"""Package-root API request and response schema implementations."""

from datetime import datetime
from enum import Enum
from typing import Any

from pydantic import (
    BaseModel,
    Field,
)



[docs]
class BootstrapAdminUser(BaseModel):
    id: int = 0
    email: str | None = None
    username: str | None = None
    preferences: dict[str, str] = {}
    bootstrap_admin_user: bool = True


[docs]
    def all_roles(*args) -> list[Any]:
        return []





[docs]
class ValueFilterQueryParams(BaseModel):
    """Allows filtering/querying elements by value like `q=<property>-<operator>&qv=<value>`

    Multiple `q/qv` queries can be concatenated.
    """

    q: list[str] | str | None = Field(
        default=None,
        title="Filter Query",
        description="Generally a property name to filter by followed by an (often optional) hyphen and operator string.",
        examples=["create_time-gt"],
    )
    qv: list[str] | str | None = Field(
        default=None,
        title="Filter Value",
        description="The value to filter by.",
        examples=["2015-01-29"],
    )




[docs]
class PaginationQueryParams(BaseModel):
    """Used to paginate a the request results by limiting and offsetting."""

    offset: int | None = Field(
        default=0,
        ge=0,
        title="Offset",
        description="Starts at the beginning skip the first ( offset - 1 ) items and begin returning at the Nth item",
    )
    limit: int | None = Field(
        default=None,
        ge=1,
        title="Limit",
        description="The maximum number of items to return.",
    )




[docs]
class FilterQueryParams(ValueFilterQueryParams, PaginationQueryParams):
    """Contains full filtering options to query elements, paginate and order them."""

    order: str | None = Field(
        default=None,
        title="Order",
        description=(
            "String containing one of the valid ordering attributes followed (optionally) "
            "by '-asc' or '-dsc' for ascending and descending order respectively. "
            "Orders can be stacked as a comma-separated list of values."
        ),
        examples=["name-dsc,create_time"],
    )




[docs]
class SerializationParams(BaseModel):
    """Contains common parameters for customizing model serialization."""

    view: str | None = Field(
        default=None,
        title="View",
        description=(
            "The name of the view used to serialize this item. "
            "This will return a predefined set of attributes of the item."
        ),
        examples=["summary"],
    )
    keys: list[str] | None = Field(
        default=None,
        title="Keys",
        description=(
            "List of keys (name of the attributes) that will be returned in addition "
            "to the ones included in the `view`."
        ),
    )
    default_view: str | None = Field(
        default=None,
        title="Default View",
        description="The item view that will be used in case none was specified.",
    )




[docs]
class PdfDocumentType(str, Enum):
    invocation_report = "invocation_report"
    page = "page"




[docs]
class APIKeyModel(BaseModel):
    key: str = Field(..., title="Key", description="API key to interact with the Galaxy API")
    create_time: datetime = Field(..., title="Create Time", description="The time and date this API key was created.")