Deprecate create_orion_api in favor of create_api_app (PrefectHQ#…

…9745)

src/prefect/server/api/server.py

@@ -31,6 +31,7 @@
 import prefect.server.services as services
 import prefect.settings
 from prefect._internal.compatibility.experimental import enabled_experiments
+from prefect._internal.compatibility.deprecated import deprecated_callable
 from prefect.logging import get_logger
 from prefect.server.api.dependencies import EnforceMinimumAPIVersion
 from prefect.server.exceptions import ObjectNotFoundError
@@ -207,7 +208,12 @@ async def prefect_object_not_found_exception_handler(
     )
 
 
-def create_orion_api(
+@deprecated_callable(start_date="May 2023", help="Use `create_api_app` instead.")
+def create_orion_api(*args, **kwargs) -> FastAPI:
+    return create_orion_api(*args, **kwargs)
+
+
+def create_api_app(
     router_prefix: Optional[str] = "",
     dependencies: Optional[List[Depends]] = None,
     health_check_path: str = "/health",
@@ -527,7 +533,7 @@ def on_service_exit(service, task):
         version=API_VERSION,
         lifespan=lifespan,
     )
-    api_app = create_orion_api(
+    api_app = create_api_app(
         fast_api_app_kwargs={
             "exception_handlers": {
                 # NOTE: FastAPI special cases the generic `Exception` handler and

tests/server/api/test_server.py

@@ -12,7 +12,7 @@
     API_ROUTERS,
     SERVER_API_VERSION,
     _memoize_block_auto_registration,
-    create_orion_api,
+    create_api_app,
     create_app,
     method_paths_from_routes,
 )
@@ -149,7 +149,7 @@ class TestCreateOrionAPI:
     }
 
     def test_includes_all_default_paths(self):
-        app = create_orion_api()
+        app = create_api_app()
 
         expected = self.BUILTIN_ROUTES.copy()
 
@@ -159,7 +159,7 @@ def test_includes_all_default_paths(self):
         assert method_paths_from_routes(app.router.routes) == expected
 
     def test_allows_router_omission_with_null_override(self):
-        app = create_orion_api(router_overrides={"/logs": None})
+        app = create_api_app(router_overrides={"/logs": None})
 
         routes = method_paths_from_routes(app.router.routes)
         assert all("/logs" not in route for route in routes)
@@ -173,7 +173,7 @@ def test_checks_for_router_paths_during_override(self):
             ValueError,
             match="override for '/logs' is missing paths",
         ) as exc:
-            create_orion_api(router_overrides={"/logs": router})
+            create_api_app(router_overrides={"/logs": router})
 
         # These are displayed in a non-deterministic order
         assert exc.match("POST /logs/filter")
@@ -186,7 +186,7 @@ def test_checks_for_changed_prefix_during_override(self):
             ValueError,
             match="Router override for '/logs' defines a different prefix '/foo'",
         ):
-            create_orion_api(router_overrides={"/logs": router})
+            create_api_app(router_overrides={"/logs": router})
 
     def test_checks_for_new_prefix_during_override(self):
         router = APIRouter(prefix="/foo")
@@ -195,7 +195,7 @@ def test_checks_for_new_prefix_during_override(self):
             KeyError,
             match="Router override provided for prefix that does not exist: '/foo'",
         ):
-            create_orion_api(router_overrides={"/foo": router})
+            create_api_app(router_overrides={"/foo": router})
 
     def test_only_includes_missing_paths_in_override_error(self):
         router = APIRouter(prefix="/logs")
@@ -208,7 +208,7 @@ def foo():
             ValueError,
             match="override for '/logs' is missing paths.* {'POST /logs/filter'}",
         ):
-            create_orion_api(router_overrides={"/logs": router})
+            create_api_app(router_overrides={"/logs": router})
 
     def test_override_uses_new_router(self):
         router = APIRouter(prefix="/logs")
@@ -222,7 +222,7 @@ def foo():
         logs_filter = MagicMock()
         router.post("/filter")(logs_filter)
 
-        app = create_orion_api(router_overrides={"/logs": router})
+        app = create_api_app(router_overrides={"/logs": router})
         client = testclient.TestClient(app)
         client.post("/logs")
         logs.assert_called_once()
@@ -248,7 +248,7 @@ def bar():
         def foobar():
             return logs_get()
 
-        app = create_orion_api(router_overrides={"/logs": router})
+        app = create_api_app(router_overrides={"/logs": router})
 
         client = testclient.TestClient(app)
         client.get("/logs/").raise_for_status()