docs: add per-user access-profile budget override API and docs - #5747
Pratham-Mishra04 merged 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (4)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe change documents per-user budget overrides for access profiles. It adds OpenAPI definitions for PUT and DELETE operations and describes override duration, additive limits, permissions, propagation, persistence, and API usage. ChangesAccess-profile budget overrides
Estimated code review effort: 2 (Simple) | ~15 minutes Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 oasdiff (1.26.0)docs/openapi/openapi.yamlError: failed to load base spec from "/tmp/coderabbit-oasdiff-base.CH2G5e": encountered disallowed external reference: "./paths/inference/async.yaml#/components/parameters/AsyncJobId" Comment |
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Merge activity
|

Summary
Adds a per-user budget override mechanism for access-profile budgets, allowing administrators to temporarily raise a single user's spending limit without modifying the shared profile template or affecting other users.
Changes
PUT /api/users/{target_user_id}/access-profiles/{profile_id}/budgets/{budget_id}/overrideto set or replace a spending override on a user's access-profile budget. The override is additive (effective_max_limit = base_limit + override_amount) and leaves the base limit, current usage, and reset schedule untouched.DELETE /api/users/{target_user_id}/access-profiles/{profile_id}/budgets/{budget_id}/overrideto remove an active override, reverting enforcement to the basemax_limit.cycles(active for a finite number of reset windows, with the current window counting as the first) andforever(active until explicitly deleted). Overrides propagate cluster-wide and survive profile cloning and propagation.AccessProfiles.Updatepermission and reference the budget on the user's own copy of the profile, not the shared template.access-profiles.mdx, including the additive formula, mode options, curl examples, and a cross-reference to the equivalent virtual key override feature.Type of change
Affected areas
How to test
Breaking changes
Security considerations
Both endpoints require the
AccessProfiles.Updatepermission. Thebudget_idmust belong to the target user's own copy of the profile, preventing callers from modifying the shared template or budgets belonging to other users. Overrides are scoped to a single user and do not bleed into the profile template or other assigned users.Checklist
docs/contributing/README.mdand followed the guidelines