feat: roll openapi json into fastapi (#359)

* Bump Pydantic to 2.5.x and remove it from explicit dependencies list (will be managed by fastapi)
* Introduce Form params description in the code, which will form openapi and swagger documentation
* Roll back some openapi customizations
* Keep backward compatibility for passing parameters in form of `list[str]` (will not be shown in the documentation)

Author: pawel-kmiecik

CHANGELOG.md

@@ -1,3 +1,9 @@
+## 0.0.64
+* Bump Pydantic to 2.5.x and remove it from explicit dependencies list (will be managed by fastapi)
+* Introduce Form params description in the code, which will form openapi and swagger documentation
+* Roll back some openapi customizations
+* Keep backward compatibility for passing parameters in form of `list[str]` (will not be shown in the documentation)
+
 ## 0.0.63
 
 * Bump unstructured to 0.12.2

openapi.json

@@ -1,19 +1,33 @@
 from fastapi import FastAPI, Request, status, HTTPException
 from fastapi.responses import JSONResponse
+from fastapi.security import APIKeyHeader
 import logging
 import os
 
 from .general import router as general_router
+from .openapi import set_custom_openapi
 
 logger = logging.getLogger("unstructured_api")
 
-
 app = FastAPI(
     title="Unstructured Pipeline API",
-    description="""""",
-    version="0.0.63",
+    summary="Partition documents with the Unstructured library",
+    version="0.0.64",
     docs_url="/general/docs",
     openapi_url="/general/openapi.json",
+    servers=[
+        {
+            "url": "https://api.unstructured.io",
+            "description": "Hosted API",
+            "x-speakeasy-server-id": "prod",
+        },
+        {
+            "url": "http://localhost:8000",
+            "description": "Development server",
+            "x-speakeasy-server-id": "local",
+        },
+    ],
+    openapi_tags=[{"name": "general"}],
 )
 
 # Note(austin) - This logger just dumps exceptions
@@ -49,6 +63,8 @@ async def error_handler(request: Request, e: Exception):
 
 app.include_router(general_router)
 
+set_custom_openapi(app)
+
 
 # Filter out /healthcheck noise
 class HealthCheckFilter(logging.Filter):