Literature schema

TCKDB backend app schemas literature module

class tckdb.backend.app.schemas.literature.Literature(*, type: tckdb.backend.app.schemas.literature.LiteratureTypeEnum, authors: str, title: str, year: int, journal: str = None, publisher: str = None, volume: int = None, issue: int = None, page_start: int = None, page_end: int = None, editors: str = None, edition: str = None, chapter_title: str = None, publication_place: str = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: str = None, isbn: str = None, url: str = None, reviewer_flags: Dict[str, str] = None, id: int)

Properties to return to client

class tckdb.backend.app.schemas.literature.LiteratureBase(*, type: tckdb.backend.app.schemas.literature.LiteratureTypeEnum, authors: tckdb.backend.app.schemas.literature.ConstrainedStrValue, title: tckdb.backend.app.schemas.literature.ConstrainedStrValue, year: tckdb.backend.app.schemas.literature.ConstrainedIntValue, journal: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, publisher: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, volume: tckdb.backend.app.schemas.literature.ConstrainedIntValue = None, issue: tckdb.backend.app.schemas.literature.ConstrainedIntValue = None, page_start: tckdb.backend.app.schemas.literature.ConstrainedIntValue = None, page_end: tckdb.backend.app.schemas.literature.ConstrainedIntValue = None, editors: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, edition: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, chapter_title: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, publication_place: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, isbn: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, url: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, reviewer_flags: Dict[str, str] = None)

A LiteratureBase class (shared properties)

classmethod check_advisor(value, values)

Literature.advisor validator

classmethod check_authors(value, values)

Literature.authors validator

classmethod check_doi(value, values)

Literature.doi validator

classmethod check_editors(value, values)

Literature.editors validator

classmethod check_isbn(value, values)

Literature.isbn validator

classmethod check_journal(value, values)

Literature.journal validator

classmethod check_page_end(value, values)

Literature.page_end validator

classmethod check_page_start(value, values)

Literature.page_start validator

classmethod check_publication_place(value, values)

Literature.publication_place validator

classmethod check_publisher(value, values)

Literature.publisher validator

classmethod check_reviewer_flags(value)

Literature.reviewer_flags validator

classmethod check_title(value, values)

Literature.title validator

classmethod check_volume(value, values)

Literature.volume validator

classmethod validate_url(value, values)

Literature.url validator

class tckdb.backend.app.schemas.literature.LiteratureCreate(*, type: str, authors: str, title: str, year: int, journal: str = None, publisher: str = None, volume: int = None, issue: int = None, page_start: int = None, page_end: int = None, editors: str = None, edition: str = None, chapter_title: str = None, publication_place: str = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: str = None, isbn: str = None, url: str = None, reviewer_flags: Dict[str, str] = None)

Create a Literature item: Properties to receive on item creation

class tckdb.backend.app.schemas.literature.LiteratureInDB(*, type: tckdb.backend.app.schemas.literature.LiteratureTypeEnum, authors: str, title: str, year: int, journal: str = None, publisher: str = None, volume: int = None, issue: int = None, page_start: int = None, page_end: int = None, editors: str = None, edition: str = None, chapter_title: str = None, publication_place: str = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: str = None, isbn: str = None, url: str = None, reviewer_flags: Dict[str, str] = None, id: int)

Properties stored in DB

class tckdb.backend.app.schemas.literature.LiteratureInDBBase(*, type: tckdb.backend.app.schemas.literature.LiteratureTypeEnum, authors: str, title: str, year: int, journal: str = None, publisher: str = None, volume: int = None, issue: int = None, page_start: int = None, page_end: int = None, editors: str = None, edition: str = None, chapter_title: str = None, publication_place: str = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: str = None, isbn: str = None, url: str = None, reviewer_flags: Dict[str, str] = None, id: int)

Properties shared by models stored in DB

class tckdb.backend.app.schemas.literature.LiteratureTypeEnum(value)

The supported literature reference types

class tckdb.backend.app.schemas.literature.LiteratureUpdate(*, type: tckdb.backend.app.schemas.literature.LiteratureTypeEnum, authors: str, title: str, year: int, journal: str = None, publisher: str = None, volume: int = None, issue: int = None, page_start: int = None, page_end: int = None, editors: str = None, edition: str = None, chapter_title: str = None, publication_place: str = None, advisor: tckdb.backend.app.schemas.literature.ConstrainedStrValue = None, doi: str = None, isbn: str = None, url: str = None, reviewer_flags: Dict[str, str] = None)

Update a Literature item: Properties to receive on item update