docs: adding CRUD api documentation

Author: freemindcore

easy/controller/base.py

@@ -1,16 +1,26 @@
 import logging
-from typing import Optional
 
 from ninja_extra import ControllerBase
 
 from easy.controller.meta import CrudAPI, CrudApiMetaclass
-from easy.services import BaseService
 
 logger = logging.getLogger(__name__)
 
 
 class CrudAPIController(ControllerBase, CrudAPI, metaclass=CrudApiMetaclass):
-    """For Client facing APIs"""
+    """
+    Base APIController for auto creating CRUD APIs
 
-    def __init__(self, service: Optional["BaseService"] = None):
-        super().__init__(service=service)  # type: ignore
+    GET /{id}       - Retrieve a single Object
+    PUT /           -  Create a single Object
+    PATCH /?id={id} - Update a single field for a Object
+    DELETE /{id}    - Delete a single Object
+    GET /get_all    - Retrieve multiple Object
+    GET /filter/?filters={filters_dict}
+                    - Filter Objects with django-orm filter dict
+    GET /filter_exclude/?filters={filters_dict}
+                    - Filter exclude Objects with Django-ORM filter dict
+
+    """
+
+    ...

easy/controller/meta.py

@@ -36,7 +36,7 @@ async def get_obj(self, request: HttpRequest, id: int) -> Any:
 
     async def del_obj(self, request: HttpRequest, id: int) -> Any:
         """
-        DELETE /objects/{id}
+        DELETE /{id}
         Delete a single Object
         """
         return await self.service.del_obj(id)
@@ -59,15 +59,15 @@ async def filter_objs(
     ) -> Any:
         """
         GET /filter/?filters={filters_dict}
-        Filter Objects
+        Filter Objects with Django-ORM filter dict
         """
         return await self.service.filter_objs(**json.loads(filters))
 
     @paginate
     async def filter_exclude_objs(self, filters: Union[str, bytes]) -> Any:
         """
         GET /filter_exclude/?filters={filters_dict}
-        Filter exclude Objects
+        Filter exclude Objects with Django-ORM filter dict
         """
         return await self.service.filter_exclude_objs(**json.loads(filters))