Add UISettings model for /ui-settings endpoint

scripts/generate_oss_openapi_schema.py

@@ -1,9 +1,26 @@
 import json
 
-from prefect.server.api.server import create_api_app
+from prefect.server.api.server import create_api_app, create_ui_app
 
-app = create_api_app()
-openapi_schema = app.openapi()
+# Generate schema from main API app
+api_app = create_api_app()
+openapi_schema = api_app.openapi()
+
+# Generate schema from UI app and merge relevant routes
+ui_app = create_ui_app(ephemeral=True)
+ui_schema = ui_app.openapi()
+
+# Merge /ui-settings path from ui_app into main schema
+for path, path_item in ui_schema.get("paths", {}).items():
+    if "ui-settings" in path:
+        # Use the path without any base URL prefix
+        openapi_schema["paths"][path] = path_item
+
+# Merge UISettings schema component
+for schema_name, schema_def in (
+    ui_schema.get("components", {}).get("schemas", {}).items()
+):
+    openapi_schema["components"]["schemas"][schema_name] = schema_def
 
 with open("oss_schema.json", "w") as f:
     json.dump(openapi_schema, f)

src/prefect/server/api/server.py

@@ -52,6 +52,7 @@
 from prefect.server.api.background_workers import background_worker
 from prefect.server.api.dependencies import EnforceMinimumAPIVersion
 from prefect.server.exceptions import ObjectNotFoundError
+from prefect.server.schemas.ui import UISettings
 from prefect.server.services.base import RunInEphemeralServers, RunInWebservers, Service
 from prefect.server.utilities.database import get_dialect
 from prefect.settings import (
@@ -480,15 +481,15 @@ def create_ui_app(ephemeral: bool) -> FastAPI:
         mimetypes.add_type("application/javascript", ".js")
 
     @ui_app.get(f"{stripped_base_url}/ui-settings")
-    def ui_settings() -> dict[str, Any]:  # type: ignore[reportUnusedFunction]
-        return {
-            "api_url": prefect.settings.PREFECT_UI_API_URL.value(),
-            "csrf_enabled": prefect.settings.PREFECT_SERVER_CSRF_PROTECTION_ENABLED.value(),
-            "auth": "BASIC"
+    def ui_settings() -> UISettings:  # type: ignore[reportUnusedFunction]
+        return UISettings(
+            api_url=prefect.settings.PREFECT_UI_API_URL.value(),
+            csrf_enabled=prefect.settings.PREFECT_SERVER_CSRF_PROTECTION_ENABLED.value(),
+            auth="BASIC"
             if prefect.settings.PREFECT_SERVER_API_AUTH_STRING.value()
             else None,
-            "flags": [],
-        }
+            flags=[],
+        )
 
     def reference_file_matches_base_url() -> bool:
         reference_file_path = os.path.join(static_dir, reference_file_name)

src/prefect/server/schemas/ui.py

@@ -2,10 +2,23 @@
 
 from typing import Optional
 
+from pydantic import BaseModel, Field
+
 from prefect.server.schemas.core import TaskRun as CoreTaskRun
 
 
 class UITaskRun(CoreTaskRun):
     """A task run with additional details for display in the UI."""
 
     flow_run_name: Optional[str] = None
+
+
+class UISettings(BaseModel):
+    """Runtime UI configuration returned by /ui-settings endpoint."""
+
+    api_url: str = Field(description="The base URL for API requests.")
+    csrf_enabled: bool = Field(description="Whether CSRF protection is enabled.")
+    auth: Optional[str] = Field(
+        description="Authentication method (e.g., 'BASIC') or null if disabled."
+    )
+    flags: list[str] = Field(description="List of enabled feature flags.")

ui-v2/src/api/prefect.ts

@@ -2982,6 +2982,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/ui-settings": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Ui Settings */
+        get: operations["ui_settings_ui_settings_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
 }
 export type webhooks = Record<string, never>;
 export interface components {
@@ -12057,6 +12074,32 @@ export interface components {
              */
             port: number;
         };
+        /**
+         * UISettings
+         * @description Runtime UI configuration returned by /ui-settings endpoint.
+         */
+        UISettings: {
+            /**
+             * Api Url
+             * @description The base URL for API requests.
+             */
+            api_url: string;
+            /**
+             * Csrf Enabled
+             * @description Whether CSRF protection is enabled.
+             */
+            csrf_enabled: boolean;
+            /**
+             * Auth
+             * @description Authentication method (e.g., 'BASIC') or null if disabled.
+             */
+            auth: string | null;
+            /**
+             * Flags
+             * @description List of enabled feature flags.
+             */
+            flags?: string[];
+        };
     };
     responses: never;
     parameters: never;
@@ -18284,4 +18327,24 @@ export interface operations {
             };
         };
     };
+    ui_settings_ui_settings_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["UISettings"];
+                };
+            };
+        };
+    };
 }