Update api.py

api.py

@@ -117,15 +117,15 @@ summ_tokenizer, summ_model = load_summarizer_models()
 
 
 class URLList(BaseModel):
-    urls: List[str]
-    key: str
+    urls: List[str] = Field(..., description="List of URLs of news articles")
+    key: str = Field(..., description="Authentication Key")
 
 class Summary(BaseModel):
-    urls: List[str]
-    scraped_texts: List[str]
-    scrape_errors: List[str]
-    summaries: List[str]
-    summarizer_error: str
+    urls: List[str] = Field(..., description="List of URLs of news articles")
+    scraped_texts: List[str] = Field(..., description="List of scraped text from input URLs")
+    scrape_errors: List[str] = Field("", description="List of errors raised during scraping. One item for corresponding URL")
+    summaries: List[str] = Field(..., description="List of generated summaries of news articles")
+    summarizer_error: str = Field("", description="String specifying error raised during summary.")
     
 
 class NewsSummarizerAPIAuthenticationError(Exception):
@@ -137,7 +137,26 @@ def authenticate_key(api_key: str):
         raise NewsSummarizerAPIAuthenticationError("Authentication error: Invalid API key.")
 
 
-@app.post("/generate_summary/", response_model=List[Summary])
+@app.post("/generate_summary/", response_model=List[Summary], 
+         responses={
+             200: {
+                 "description": "List of summaries for each URL",
+                 "content": {
+                     "application/json": {
+                         "schema": List[Summary]
+                     }
+                 }
+             },
+             
+             401: {
+                 "description": "Authentication Error: Wrong key",
+                 "content": {
+                     "application/json": {
+                         "schema": List[Summary]
+                     }
+                 }
+             }
+         })
 async def read_items(q: URLList):
     try:
         logging.warning("Entering read_items()")