adds basic metadata and example barcode

aim/digifeeds/database/main.py

@@ -11,7 +11,12 @@
     engine = create_engine(S.mysql_database)
 
 SessionLocal = sessionmaker(autocommit=False, autoflush=False, bind=engine)
-app = FastAPI()
+
+description = """
+The Digifeeds API enables tracking of images sent to HathiTrust and Google
+through the digifeeds workflow
+"""
+app = FastAPI(title="Digifeeds", description=description)
 
 
 # Dependency

aim/digifeeds/database/schemas.py

@@ -1,30 +1,50 @@
 from pydantic import BaseModel, Field, ConfigDict
 from datetime import datetime
 
+
 class ItemStatus(BaseModel):
     name: str = Field(alias="status_name")
     description: str = Field(alias="status_description")
     created_at: datetime
 
     model_config = ConfigDict(populate_by_name=True, from_attributes=True)
 
+
 class ItemBase(BaseModel):
     model_config = ConfigDict(populate_by_name=True, from_attributes=True)
 
     barcode: str = Field(alias="item_barcode")
 
+
 class Item(ItemBase):
     created_at: datetime
     statuses: list[ItemStatus] = []
+    model_config = ConfigDict(
+        json_schema_extra={
+            "examples": [
+                {
+                    "barcode": "39015040218748",
+                    "created_at": "2024-09-25T17:12:39",
+                    "statuses": [
+                        {
+                            "name": "in_zephir",
+                            "description": "Item is in zephir",
+                            "created_at": "2024-09-25T17:13:28",
+                        }
+                    ],
+                }
+            ]
+        }
+    )
+
 
 class ItemCreate(ItemBase):
     pass
 
+
 class StatusBase(BaseModel):
     name: str
 
 
 class Status(StatusBase):
     description: str
-
-