Update docs

Change BaseModel to ignore extras

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
 ---------------
 

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:

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."""

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
         ----------

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])