Skip to content

chore(ui): regenerate schema.d.ts after soft_budget left the user endpoint docstrings - #40987

Closed
devin-ai-integration[bot] wants to merge 1 commit into
litellm_internal_stagingfrom
litellm_ui_schema_sync_soft_budget
Closed

devin-ai-integration[bot] wants to merge 1 commit into
litellm_internal_stagingfrom
litellm_ui_schema_sync_soft_budget

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Sep 13, 2026 •

Copy link
Copy Markdown
Contributor

TLDR

Problem this solves:

  • b9ba808 dropped soft_budget from the /user/new and /user/update docstrings
  • The generated schema.d.ts still has those two lines
  • Every PR that touches litellm/proxy/ now fails "Verify schema.d.ts matches the proxy OpenAPI spec"

How it solves it:

  • npm run gen:api in ui/litellm-dashboard, commit the result
  • Two doc-comment lines removed, no type changes

User Flow

Before: a contributor opens a PR that touches any proxy file and the schema sync check fails on lines they never touched

  1. They push a branch that changes a file under litellm/proxy/
  2. The check "Verify schema.d.ts matches the proxy OpenAPI spec" fails with a two line diff removing soft_budget from the user endpoint descriptions
  3. They run npm run gen:api locally and get the same two line diff, unrelated to their change

After: the same PR passes the schema sync check

  1. They push a branch that changes a file under litellm/proxy/
  2. The check "Verify schema.d.ts matches the proxy OpenAPI spec" passes
  3. npm run gen:api locally produces no diff

Relevant issues

Unblocks the CI on #40922

Affected release

Linear ticket

Pre-Submission checklist

Please complete all items before asking a LiteLLM maintainer to review your PR

  • I have added meaningful tests (not applicable: generated file only, the CI check is the test)
  • The handful of test files covering my change pass locally, e.g. uv run pytest tests/test_litellm/<your_test_file>.py -v. Leave the suites (make test-unit-*, make test-unit) to CI: it finishes in ~15 minutes where a laptop takes an hour or more
  • My PR passes all required CI/CD checks (e.g., lint, schema.d.ts sync check, etc.)
  • My PR's scope is as isolated as possible; it only solves 1 specific problem
  • I have received a Greptile Confidence Score of at least 4/5 before requesting a maintainer review (Greptile reviews automatically once the PR is opened; only comment @greptileai to re-request a review after pushing changes)

Delays in PR merge?

If you're seeing a delay in your PR being merged, ping the LiteLLM Team on Slack (#pr-review).

Screenshots / Proof of Fix

Before (c2c2a62, current litellm_internal_staging)

  1. cd ui/litellm-dashboard && npm run gen:api -> git diff --stat shows ui/litellm-dashboard/src/lib/http/schema.d.ts | 2 --
  2. The two removed lines are - soft_budget: Optional[float] - Get alerts when user crosses given budget, doesn't block requests. under /user/new and /user/update
  3. The same two line diff is what the check prints on fix(proxy): resolve team callbacks when key logging is empty and report GCS flush failures #40922 at d45f42f (job 103699964299)

After (842864f)

  1. cd ui/litellm-dashboard && npm run gen:api -> git diff --stat prints nothing
  2. The Verify schema.d.ts matches the proxy OpenAPI spec check on this PR passes (job 103701407579), which is the live proof

No UI change: the two lines are doc comments inside schema.d.ts, nothing the dashboard renders

Type

🧹 Refactoring

Caveats (if any)

Low

  • Generated with the same interpreter path the workflow uses (inspect.cleandoc normalization), so the output matches CI byte for byte

Review and CI status (at 842864f)

  • CI: 51 passed, 0 failed, 27 skipped (Codecov uploads and the stage-mirror e2e job)
  • Greptile: 5/5, no comments
  • Cursor Bugbot: not triggered, doc comment change in a generated file
  • Veria: none
  • Devin Review: none

Final Attestation

  • The tests check the right things, including the edge cases, and regressions in the respective real-world customer use-cases are not possible after this PR

/live-pr-risk not run: the diff is two doc comment lines in a generated TypeScript file, there is no runtime behavior to A/B

  • 842864f passes /live-pr-risk (not applicable, see above)

Link to Devin session: https://app.devin.ai/sessions/42a8e9b831c141108fd010826df31fe7
Open in Devin Desktop: https://app.devin.ai/desktop/session/42a8e9b831c141108fd010826df31fe7?variant=devin
Requested by: @yucheng-berri

…point docstrings

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@greptile-apps

greptile-apps Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR synchronizes the generated TypeScript OpenAPI declarations with the proxy endpoint documentation

  • Removes two stale soft_budget documentation lines
  • Makes no type or runtime behavior changes
  • Restores consistency with the current user endpoint request models and docstrings

Confidence Score: 5/5

The PR appears safe to merge because it only corrects stale generated comments to match the authoritative endpoint documentation

The removed comments describe a field that is absent from the current user request models and endpoint docstrings, so no behavioral or contract regression remains

Important Files Changed

Filename Overview
ui/litellm-dashboard/src/lib/http/schema.d.ts Removes two stale generated documentation lines without changing the API types

Reviews (1): Last reviewed commit: "chore(ui): regenerate schema.d.ts after ..." | Re-trigger Greptile

meryemsakin added a commit to meryemsakin/litellm that referenced this pull request Sep 13, 2026
…point docstrings

Keeps the UI API types sync check green on this branch. Identical to the regeneration in BerriAI#40987.
crognlie added a commit to crognlie/litellm that referenced this pull request Sep 13, 2026
…ires

Both checks are red on main. The schema.d.ts change matches BerriAI#40987 and the test reorder matches BerriAI#41011
@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

Closing: main already has schema.d.ts in sync (gen:api on cab1e11 yields no diff), only litellm_internal_staging was stale

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant