feat(runner): add 'servers' to OpenAPI spec (#64)

This commit adds the servers field to the OpenAPI spec and makes the resulting JSON file human readable.
livepeer · Apr 20, 2024 · 217c1a5 · 217c1a5
1 parent 7e85929
commit 217c1a5
Show file tree

Hide file tree

Showing 2 changed files with 500 additions and 486 deletions.
diff --git a/runner/gen_openapi.py b/runner/gen_openapi.py
@@ -5,6 +5,11 @@
 import yaml
 import argparse
 
+# Specify Endpoints for OpenAPI schema generation.
+SERVERS = [
+    {"url": "http://gateway-endpoint.ai/", "description": "Example Gateway"},
+]
+
 
 def write_openapi(fname):
     """Write OpenAPI schema to file.
@@ -31,6 +36,7 @@ def write_openapi(fname):
                     openapi_version=app.openapi_version,
                     description="An application to run AI pipelines",
                     routes=app.routes,
+                    servers=SERVERS,
                 ),
                 f,
                 sort_keys=False,
@@ -43,8 +49,10 @@ def write_openapi(fname):
                     openapi_version=app.openapi_version,
                     description="An application to run AI pipelines",
                     routes=app.routes,
+                    servers=SERVERS,
                 ),
                 f,
+                indent=4,  # Make human readable.
             )
         print("OpenAPI schema generated and saved.")