Add curl examples for EVENTCOUNTLIMIT and AIAPIQUOTALIMIT subscription throttle policies#11350
Add curl examples for EVENTCOUNTLIMIT and AIAPIQUOTALIMIT subscription throttle policies#11350Tharsanan1 wants to merge 1 commit into
Conversation
…n throttle policies
📝 WalkthroughSummaryThis PR extends the Admin v4 API specification documentation by adding two inline curl examples to the Changes MadeFile Modified: Two new code samples were added to the
Both examples provide complete, inline JSON payloads showing the proper structure for their respective quota types, including fields like Impact: Documentation-only change. No modifications to API schemas, operation signatures, or functional behavior. Lines Changed: +43 lines added WalkthroughThis pull request extends the OpenAPI documentation for the subscription throttling policy creation endpoint by adding two new Curl code sample requests. The examples demonstrate how to configure subscription throttling policies using 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml`:
- Around line 530-531: Replace the hard-coded bearer token in the curl examples
with a placeholder (e.g., <ACCESS_TOKEN>) so the Authorization header reads
Authorization: Bearer <ACCESS_TOKEN>; update both instances mentioned in the
file (the curl sample around the current diff and the other sample at the
indicated second occurrence) to avoid exposing real tokens and satisfy the
security guideline.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 51514070-44a1-4c51-97aa-0c18ecbb2888
📒 Files selected for processing (1)
en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml
| curl -k -X POST -H "Authorization: Bearer ae4eae22-3f65-387b-a171-d37eaa366fa8" \ | ||
| -H "Content-Type: application/json" \ |
There was a problem hiding this comment.
Use an access-token placeholder in new curl examples.
Replace the inline bearer value with a placeholder (for example, <ACCESS_TOKEN>) in both new samples to avoid security-scan noise and keep examples clearly non-sensitive.
As per coding guidelines, "Provide concise, actionable feedback focused on correctness and best practices."
Also applies to: 550-551
🧰 Tools
🪛 Betterleaks (1.2.0)
[high] 530-530: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@en/docs/reference/product-apis/admin-apis/admin-v4/admin-v4.yaml` around
lines 530 - 531, Replace the hard-coded bearer token in the curl examples with a
placeholder (e.g., <ACCESS_TOKEN>) so the Authorization header reads
Authorization: Bearer <ACCESS_TOKEN>; update both instances mentioned in the
file (the curl sample around the current diff and the other sample at the
indicated second occurrence) to avoid exposing real tokens and satisfy the
security guideline.
Summary
Adds inline curl examples for creating streaming (EVENTCOUNTLIMIT) and AI (AIAPIQUOTALIMIT) subscription throttling policies to the admin v4 API spec.
Previously the POST /throttling/policies/subscription endpoint only had a generic curl example referencing a @data.json file with no inline payload. Developers had to dig through the schema to construct the correct payload for non-REQUESTCOUNTLIMIT quota types.
Changes