feat: Make OpenAPI spec usable by custom GPTs

Author: marcusschiesser

.changeset/famous-snails-destroy.md

@@ -0,0 +1,5 @@
+---
+"create-llama": patch
+---
+
+Make OpenAPI spec usable by custom GPTs

templates/types/streaming/fastapi/app/api/routers/query.py

@@ -16,7 +16,11 @@ def get_query_engine() -> BaseQueryEngine:
     return index.as_query_engine()
 
 
-@r.get("/")
+@r.get(
+    "/",
+    summary="Call the get information from a knowledge base",
+    description="Get information from the knowledge base using a search query parameter",
+)
 async def query_request(
     query: str,
 ) -> str:

templates/types/streaming/fastapi/main.py

@@ -1,6 +1,7 @@
 # flake8: noqa: E402
 from app.config import DATA_DIR, STATIC_DIR
 from dotenv import load_dotenv
+import toml
 
 load_dotenv()
 
@@ -16,14 +17,24 @@
 from fastapi.responses import RedirectResponse
 from fastapi.staticfiles import StaticFiles
 
-app = FastAPI()
-
 init_settings()
 init_observability()
 
 environment = os.getenv("ENVIRONMENT", "dev")  # Default to 'development' if not set
 logger = logging.getLogger("uvicorn")
 
+servers = []
+# Add the fly.dev URL to the OpenAPI spec
+if os.path.exists("fly.toml"):
+    try:
+        with open("fly.toml") as f:
+            fly_config = toml.load(f)
+        app_name = fly_config["app"]
+        servers = [{"url": f"https://{app_name}.fly.dev"}]
+    except Exception as e:
+        logger.warning(f"Failed to read fly.toml: {e}")
+app = FastAPI(servers=servers)
+
 
 def mount_static_files(directory, path, html=False):
     if os.path.exists(directory):

templates/types/streaming/fastapi/pyproject.toml

@@ -21,6 +21,7 @@ aiostream = "^0.5.2"
 cachetools = "^5.3.3"
 llama-index = "^0.12.1"
 rich = "^13.9.4"
+toml = "^0.10.2"
 
 [tool.poetry.group.dev.dependencies]
 mypy = "^1.8.0"