docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

docs: remove max_budget_usd references from standalone docs (managed-only field) - #296

Merged
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references
May 18, 2026
Merged

docs: remove max_budget_usd references from standalone docs (managed-only field)#296
moonming merged 4 commits into
mainfrom
docs/issue-295-remove-max-budget-usd-references

Conversation

@janiussyafiq

@janiussyafiqjaniussyafiq commented May 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Remove all 12 customer-facing references to max_budget_usd from the docs. The field name does not exist as an OSS standalone ApiKey schema field (PR #259 removed it; StandaloneApiKeyBody rejects unknown fields). Pass-1.5 verification (see Revision notes) confirmed it also does not exist on AISIX-Cloud's admin API surface — Cloud uses limit_cents int64 internally. Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. See Revision notes below for the multi-pivot history.

Changes

FileChange
docs/integration/errors-and-retries.md429 row rationale: Budget rejection from the ApiKey's max_budget_usdBudget rejection from the managed budget controller
docs/reference/resource-schemas.mdRemove the Runtime Versus Schema Boundary example bullet about the typed model / OpenAPI / write validator inconsistency
docs/configuration/api-keys.mdDrop the Budget Boundary bullet about the write validator rejecting the field + the trailing "Do not treat ... as part of the verified standalone admin write contract" advisory
docs/configuration/budgets.mdRemove the intro line; drop the Managed Versus Standalone "Because of that boundary..." sentence and the typed/OpenAPI + write validator bullets; remove the A standalone deployment ignores max_budget_usd troubleshooting subsection (no replacement). Final state: no max_budget_usd mentions on this page. See Revision notes for pivot history.
docs/overview/core-concepts.mdRemove the trailing sentence "Managed budget paths may also reference per-key budget state, but max_budget_usd is not part of the current verified standalone admin write contract"
docs/overview/feature-matrix.md"Per-key budgets" row rationale: replace mention of the rejected field with "standalone deployments do not enforce per-key budgets; managed deployments enforce via the budget controller"

Net diff: 6 files, +4 / -21, no .rs / schema / config / test files touched.

Test plan

  • grep -rn 'max_budget_usd' docs/ --include='*.md' after the edits returns 0 hits — confirms the field name does not appear anywhere in OSS docs.
  • grep -rn 'max_budget_usd' crates/aisix-core/src/models/apikey.rs returns zero matches — confirms the field is genuinely absent from the OSS schema (this PR documents that absence; no code change required).
  • cargo fmt --check — PASS (exit 0).
  • cargo clippy --workspace --all-targets -- -D warnings — PASS (exit 0, no warnings, Finished dev profile [unoptimized + debuginfo] target(s) in 41.91s).
  • cargo test --workspace — PASS (exit 0, all crate test suites green; no failures, 2 ignored).
  • E2E: grep -rln <each affected page> tests/e2e/ returns empty for all 6 pages — no e2e fixture references them, pnpm test not applicable.

References

Revision notes

  • Revision 1 → 2 (2ed56fb1822515): original R3 approach removed all 12 max_budget_usd references and rewrote budgets.md abstractly. Per operator review, restored one canonical Troubleshooting subsection on docs/configuration/budgets.md naming the field in the rejection context. Rationale: preserves discoverability for the 400-rejection error users hit when migrating Cloud-style configs to standalone. Other 5 files's R3 removals remain.
  • Revision 3 → 4 (a8cb07e7aa99ce): Pass-1.5 verification surfaced that max_budget_usd doesn't exist as a field name on AISIX-Cloud's admin API surface either (Cloud uses limit_cents int64; verified no max_budget_usd in Go source, OpenAPI, or YAML/JSON specs). The canonical Troubleshooting subsection added in revision 2 (1822515) asserted "managed-mode field implemented in AISIX Cloud's control plane" — that assertion is empirically false. Operator pivoted from Option δ → pure R1 (full removal). The Troubleshooting subsection deleted entirely.
  • Final state: grep -rn 'max_budget_usd' docs/ returns 0 hits. The field name does not appear anywhere in OSS docs.

Summary by CodeRabbit

  • Documentation
    • Clarified that standalone deployments do not enforce per-key budgets by default (budget client disabled/allow-all) and removed prior contradictory validation notes.
    • Added guidance to drop per-key budget fields from standalone admin write payloads.
    • Updated errors to include HTTP 429 billing_error for budget-exceeded responses.
    • Clarified model access control: empty list denies; wildcard "*" allows.

Review Change Stack

CopilotAI review requested due to automatic review settings May 15, 2026 23:06
@janiussyafiqjaniussyafiq added documentation Improvements or additions to documentation priority-normal labels May 15, 2026
@coderabbitai

coderabbitaiBot commented May 15, 2026

Copy link
Copy Markdown
ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Free

Run ID: d1a7b917-704c-4c46-ba5e-9fd0fa88e87d

📥 Commits

Reviewing files that changed from the base of the PR and between a8cb07e and 7aa99ce.

📒 Files selected for processing (1)
  • docs/configuration/budgets.md
💤 Files with no reviewable changes (1)
  • docs/configuration/budgets.md

📝 Walkthrough

Walkthrough

This PR updates documentation to clarify that standalone deployments default to a disabled, allow-all budget client (removing prior max_budget_usd caveats), documents that managed deployments enforce per-key budgets via a budget controller (with 429 budget_exceeded), and adds allowed_models access semantics.

Changes

Budget enforcement and access control documentation clarification

Layer / File(s)Summary
Standalone budget behavior clarification
docs/configuration/api-keys.md, docs/configuration/budgets.md, docs/reference/resource-schemas.md
Removes the misleading caveat that max_budget_usd appears in the ApiKey schema/OpenAPI but is rejected by the standalone admin write validator. Replaces with statements that standalone deployments default to a disabled budget client with allow-all behavior and updates troubleshooting/migration guidance.
Managed budget enforcement documentation
docs/integration/errors-and-retries.md, docs/overview/feature-matrix.md
Clarifies that per-key budget enforcement is performed by the managed data-plane budget controller. Updates error docs to attribute 429 billing_error with code: "budget_exceeded" to the managed budget controller and notes enforcement differences in the feature matrix.
API Key allowed_models access control
docs/overview/core-concepts.md
Adds explicit access-control contract: empty allowed_models denies all models; wildcard "*" allows all models within the applicable scope. Replaces prior budget-path phrasing with model-access semantics.

🎯 1 (Trivial) | ⏱️ ~3 minutes


Note

🎁 Summarized by CodeRabbit Free

Your organization has reached its limit of developer seats under the Pro Plan. For new users, CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please add seats to your subscription by visiting https://app.coderabbit.ai/login.If you believe this is a mistake and have available seats, please assign one to the pull request author through the subscription management page using the link above.

Comment @coderabbitai help to get the list of available commands and usage tips.

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR removes standalone documentation references to max_budget_usd, aligning the docs with the current standalone admin contract where that managed-only field is not exposed.

Changes:

  • Removes stale max_budget_usd references from API key, schema, budget, feature-matrix, and error docs.
  • Reframes budget enforcement as managed-control-plane driven, with standalone defaulting to allow-all budget behavior.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
FileDescription
docs/reference/resource-schemas.mdRemoves the stale schema-boundary example for max_budget_usd.
docs/overview/feature-matrix.mdUpdates per-key budget limitations to describe standalone vs managed behavior.
docs/overview/core-concepts.mdRemoves managed budget field caveat from API key concepts.
docs/integration/errors-and-retries.mdRewords budget-related 429 trigger text.
docs/configuration/budgets.mdRemoves field-specific guidance and rewrites standalone budget troubleshooting.
docs/configuration/api-keys.mdRemoves standalone write-contract warning for the removed field.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment threaddocs/overview/feature-matrix.md Outdated
CopilotAI review requested due to automatic review settings May 16, 2026 02:45

CopilotAI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated no new comments.

@moonming
moonming merged commit fd24ce0 into mainMay 18, 2026
6 checks passed
@jarvis9443
jarvis9443 deleted the docs/issue-295-remove-max-budget-usd-references branch June 25, 2026 06:25
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentationImprovements or additions to documentationpriority-normal

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: remove max_budget_usd references from standalone docs (managed-only field)

3 participants

@janiussyafiq@moonming