adds docstring to interfaces

Author: GabrielBarberini

src/controllers/interface.py

@@ -37,6 +37,19 @@ async def wrapper(self, *args, **kwargs):
 
 
 class ControllerBase:
+    """
+    ControllerBase is a base class for all controllers. It provides a set of
+    methods to handle the CRUD operations for the models provided in the
+    constructor. CRUD methods are generated dynamically based on the model
+    methods and the model name.
+
+    The methods are named as follows:
+        - post_{model_name} for POST method
+        - get_{model_name}_by_id for GET method
+        - put_{model_name}_by_id for PUT method
+        - delete_{model_name}_by_id for DELETE method
+
+    """
 
     def __init__(self, models: List[ApiBaseModel]):
         self._initialized_models = {}

src/models/interface.py

@@ -8,6 +8,13 @@
 
 
 class ApiBaseModel(BaseModel, ABC):
+    """
+    Base class for all models in the API.
+
+    This class is used to define the common attributes and
+    methods that all models in the API should have.
+    """
+
     _id: Optional[str] = PrivateAttr(default=None)
     model_config = ConfigDict(
         use_enum_values=True,

src/repositories/interface.py

@@ -82,6 +82,15 @@ def get_instance(self):
 class RepositoryInterface:
     """
     Interface class for all repositories (singleton)
+
+    This class is used to define the common attributes and
+    methods that all repositories should have.
+
+    The class is a singleton, meaning that only one instance
+    of the class is created and shared among all instances
+    of the class. This is done to ensure that only one
+    connection per collection in the database is created
+    and shared among all repositories.
     """
 
     _global_instances = {}