Add UISettings model for /ui-settings endpoint

[tomerqodo]

Benchmark PR from qodo-benchmark#283

[qodo-code-review]

Code Review by Qodo (Alpha)

🐞 Bugs (2) 📘 Rule Violations (0) 📎 Requirement Gaps (0) 💡 Suggestions (0)

1. UI path prefix leaks 🐞 Bug

Description

• The OSS schema generator claims it will remove any UI base-path prefix, but it copies the UI app’s
  OpenAPI path verbatim.
• Since the UI route is registered under PREFECT_UI_SERVE_BASE (via stripped_base_url),
  oss_schema.json can end up with /ui/ui-settings instead of /ui-settings, making client
  generation/configuration inconsistent.
• The substring filter ("ui-settings" in path) is also fragile and can unintentionally merge other
  future endpoints containing that substring.

correctness

Code

scripts/generate_oss_openapi_schema.py[R13-17]

+# 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

Evidence

The generator copies any UI OpenAPI path containing ui-settings without stripping a base URL, but
the UI app defines the route using stripped_base_url derived from PREFECT_UI_SERVE_BASE, so the
UI schema path can be prefixed. Meanwhile, the generated UI client types expect a stable
/ui-settings path.

scripts/generate_oss_openapi_schema.py[13-17]
src/prefect/server/api/server.py[456-484]
ui-v2/src/api/prefect.ts[2985-2994]

Agent Prompt

## Issue description
`scripts/generate_oss_openapi_schema.py` intends to merge `/ui-settings` without any UI base-path prefix, but it currently copies the UI app OpenAPI path verbatim and selects by substring match.

This makes `oss_schema.json` (and any generated clients) dependent on `PREFECT_UI_SERVE_BASE` and fragile if new routes contain `ui-settings` in their path.

## Issue Context
The UI app registers the endpoint at `f"{stripped_base_url}/ui-settings"`, where `stripped_base_url` comes from `PREFECT_UI_SERVE_BASE`.

## Fix Focus Areas
- scripts/generate_oss_openapi_schema.py[13-17]
- src/prefect/server/api/server.py[456-484]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

2. Overbroad schema merge 🐞 Bug

Description

• The generator comment says it is merging the UISettings schema component, but it actually copies
  *all* schemas from the UI app into the API schema.
• It overwrites existing component schemas unconditionally, so shared schema names (e.g., FastAPI’s
  common validation schemas) can be silently replaced, changing generated client types unexpectedly.
• This makes the OSS schema sensitive to unrelated UI schema changes and can introduce hard-to-debug
  diffs in downstream generated code.

reliability

Code

scripts/generate_oss_openapi_schema.py[R19-23]

+# 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

Evidence

The generator iterates over every UI schema and assigns into the main schema’s components.schemas
without checking for collisions or limiting to UISettings. The repo’s generated types already
contain shared/common schema names (e.g. HTTPValidationError), illustrating that collisions are
plausible and that overwriting would affect widely-used types.

scripts/generate_oss_openapi_schema.py[19-23]
ui-v2/src/api/prefect.ts[8010-8014]

Agent Prompt

## Issue description
`scripts/generate_oss_openapi_schema.py` currently merges *all* UI OpenAPI component schemas into the API schema and overwrites any existing schema with the same name.

This can silently change widely-used schemas and destabilize generated clients.

## Issue Context
The script comment indicates only `UISettings` should be merged, but the implementation copies every schema from the UI app.

## Fix Focus Areas
- scripts/generate_oss_openapi_schema.py[19-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

[qodo-code-review]

1. Ui path prefix leaks 🐞 Bug

• The OSS schema generator claims it will remove any UI base-path prefix, but it copies the UI app’s
  OpenAPI path verbatim.
• Since the UI route is registered under PREFECT_UI_SERVE_BASE (via stripped_base_url),
  oss_schema.json can end up with /ui/ui-settings instead of /ui-settings, making client
  generation/configuration inconsistent.
• The substring filter ("ui-settings" in path) is also fragile and can unintentionally merge other
  future endpoints containing that substring.

Agent Prompt

## Issue description
`scripts/generate_oss_openapi_schema.py` intends to merge `/ui-settings` without any UI base-path prefix, but it currently copies the UI app OpenAPI path verbatim and selects by substring match.

This makes `oss_schema.json` (and any generated clients) dependent on `PREFECT_UI_SERVE_BASE` and fragile if new routes contain `ui-settings` in their path.

## Issue Context
The UI app registers the endpoint at `f"{stripped_base_url}/ui-settings"`, where `stripped_base_url` comes from `PREFECT_UI_SERVE_BASE`.

## Fix Focus Areas
- scripts/generate_oss_openapi_schema.py[13-17]
- src/prefect/server/api/server.py[456-484]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

[qodo-code-review]

2. Overbroad schema merge 🐞 Bug

• The generator comment says it is merging the UISettings schema component, but it actually copies
  *all* schemas from the UI app into the API schema.
• It overwrites existing component schemas unconditionally, so shared schema names (e.g., FastAPI’s
  common validation schemas) can be silently replaced, changing generated client types unexpectedly.
• This makes the OSS schema sensitive to unrelated UI schema changes and can introduce hard-to-debug
  diffs in downstream generated code.

Agent Prompt

## Issue description
`scripts/generate_oss_openapi_schema.py` currently merges *all* UI OpenAPI component schemas into the API schema and overwrites any existing schema with the same name.

This can silently change widely-used schemas and destabilize generated clients.

## Issue Context
The script comment indicates only `UISettings` should be merged, but the implementation copies every schema from the UI app.

## Fix Focus Areas
- scripts/generate_oss_openapi_schema.py[19-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools