Use docstring to describe the api path

mlibrary · Oct 7, 2024 · 4b9e17e · 4b9e17e
1 parent acb676a
commit 4b9e17e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/aim/digifeeds/database/main.py b/aim/digifeeds/database/main.py
@@ -35,6 +35,13 @@ def get_items(
     ),
     db: Session = Depends(get_db),
 ) -> list[schemas.Item]:
+    """
+    Get the digifeeds items.
+
+    These items can be filtered by whether or not their metadata is in Zephir or
+    all of them can be fetched.
+    """
+
     db_items = crud.get_items(in_zephir=in_zephir, db=db)
     return db_items