diff --git a/docs/esak.rst b/docs/esak.rst index 6297450..0ce1422 100644 --- a/docs/esak.rst +++ b/docs/esak.rst @@ -4,46 +4,6 @@ esak package Submodules ---------- -esak.character module ---------------------- - -.. automodule:: esak.character - :members: - :undoc-members: - :show-inheritance: - -esak.comic module ------------------ - -.. automodule:: esak.comic - :members: - :undoc-members: - :show-inheritance: - -esak.creator module -------------------- - -.. automodule:: esak.creator - :members: - :undoc-members: - :show-inheritance: - -esak.dates module ------------------ - -.. automodule:: esak.dates - :members: - :undoc-members: - :show-inheritance: - -esak.event module ------------------ - -.. automodule:: esak.event - :members: - :undoc-members: - :show-inheritance: - esak.exceptions module ---------------------- @@ -52,22 +12,6 @@ esak.exceptions module :undoc-members: :show-inheritance: -esak.prices module ------------------- - -.. automodule:: esak.prices - :members: - :undoc-members: - :show-inheritance: - -esak.series module ------------------- - -.. automodule:: esak.series - :members: - :undoc-members: - :show-inheritance: - esak.session module ------------------- @@ -84,46 +28,6 @@ esak.sqlite\_cache module :undoc-members: :show-inheritance: -esak.stories module -------------------- - -.. automodule:: esak.stories - :members: - :undoc-members: - :show-inheritance: - -esak.summary module -------------------- - -.. automodule:: esak.summary - :members: - :undoc-members: - :show-inheritance: - -esak.text\_object module ------------------------- - -.. automodule:: esak.text_object - :members: - :undoc-members: - :show-inheritance: - -esak.urls module ----------------- - -.. automodule:: esak.urls - :members: - :undoc-members: - :show-inheritance: - -esak.utils module ------------------ - -.. automodule:: esak.utils - :members: - :undoc-members: - :show-inheritance: - Module contents --------------- diff --git a/docs/schemas.rst b/docs/schemas.rst new file mode 100644 index 0000000..a4dfd8e --- /dev/null +++ b/docs/schemas.rst @@ -0,0 +1,77 @@ +schemas package +============ + +Submodules +---------- + +esak.schemas.character module +--------------------- + +.. automodule:: esak.schemas.character + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.comic module +----------------- + +.. automodule:: esak.schemas.comic + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.creator module +------------------- + +.. automodule:: esak.schemas.creator + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.event module +----------------- + +.. automodule:: esak.schemas.event + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.generic module +------------------- + +.. automodule:: esak.schemas.generic + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.series module +------------------ + +.. automodule:: esak.schemas.series + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.story module +------------------- + +.. automodule:: esak.schemas.story + :members: + :undoc-members: + :show-inheritance: + +esak.schemas.urls module +---------------- + +.. automodule:: esak.schemas.urls + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: esak.schemas + :members: + :undoc-members: + :show-inheritance: diff --git a/esak/schemas/__init__.py b/esak/schemas/__init__.py index d1df56a..a3110c6 100644 --- a/esak/schemas/__init__.py +++ b/esak/schemas/__init__.py @@ -22,7 +22,6 @@ class BaseModel( str_strip_whitespace=True, validate_assignment=True, revalidate_instances="always", - # extra="ignore", - extra="forbid", + extra="ignore", ): """Base model for esak resources.""" diff --git a/esak/schemas/comic.py b/esak/schemas/comic.py index 3258ec3..ba7e2dc 100644 --- a/esak/schemas/comic.py +++ b/esak/schemas/comic.py @@ -176,7 +176,7 @@ class Comic(BaseResource): @field_validator("diamond_code", "isbn", mode="before") def enforce_str(cls, value: str | int | None) -> str | None: - """Enforce an int to be a str + """Enforce an int to be a str. Parameters ---------- diff --git a/esak/schemas/generic.py b/esak/schemas/generic.py index 5abad0c..a5685fc 100644 --- a/esak/schemas/generic.py +++ b/esak/schemas/generic.py @@ -22,7 +22,7 @@ class GenericItem(BaseModel): Attributes ---------- id: int - The unique ID of the Generic resource. + name: str The name of the Generic Item. resource_uri: HttpUrl @@ -34,6 +34,12 @@ class GenericItem(BaseModel): @property def id(self) -> int: + """Pull the id number from the resource_uri. + + Returns + ------- + The unique ID of the Generic resource. + """ return int(self.resource_uri.__str__().split("/")[-1])