add function descriptions

Author: jonhealy1

stac_fastapi/elasticsearch/stac_fastapi/elasticsearch/database_logic.py

@@ -237,6 +237,7 @@ def execute_search(self, search, limit: int, base_url: str) -> List:
     # Transaction Logic
 
     def prep_create_item(self, item: stac_types.Item, base_url: str):
+        """Database logic for prepping an item for insertion."""
         if not self.client.exists(index=COLLECTIONS_INDEX, id=item["collection"]):
             raise ForeignKeyError(f"Collection {item['collection']} does not exist")
 
@@ -250,6 +251,7 @@ def prep_create_item(self, item: stac_types.Item, base_url: str):
         return self.item_serializer.stac_to_db(item, base_url)
 
     def create_item(self, item: stac_types.Item, base_url: str):
+        """Database logic for creating one item."""
         # todo: check if collection exists, but cache
         es_resp = self.client.index(
             index=ITEMS_INDEX,
@@ -263,10 +265,12 @@ def create_item(self, item: stac_types.Item, base_url: str):
             )
 
     def prep_update_item(self, item: stac_types.Item):
+        """Database logic for prepping an item for updating."""
         if not self.client.exists(index=COLLECTIONS_INDEX, id=item["collection"]):
             raise ForeignKeyError(f"Collection {item['collection']} does not exist")
 
     def delete_item(self, item_id: str, collection_id: str):
+        """Database logic for deleting one item."""
         try:
             self.client.delete(index=ITEMS_INDEX, id=mk_item_id(item_id, collection_id))
         except elasticsearch.exceptions.NotFoundError:
@@ -286,7 +290,7 @@ def create_collection(self, collection: stac_types.Collection):
         )
 
     def prep_update_collection(self, collection_id: str):
-        """Database logic for updating a collection."""
+        """Database logic for prepping a collection for updating."""
         try:
             _ = self.client.get(index=COLLECTIONS_INDEX, id=collection_id)
         except elasticsearch.exceptions.NotFoundError: