Repository navigation
docs(timeout): accept a percentage of the plan budget - #2415
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 44 minutes. View limit details
No actionable comments were generated in the recent review. Walkthrough
Merge Risk:
|
@microlink/difftool visual comparisonworkflow run · base microlink.io · head 33fa1ur95-hqnlb9v2u-microlink.vercel.app✅ 1/1 routes pass
configuration |
The OpenAPI spec and llms.txt still described timeout as a duration, so the spec check failed against the updated parameter page.
A timeout description edit could update the parameter page and the OpenAPI spec while leaving the published index behind, and nothing failed.
|
React Doctor found no new issues. 🎉 Reviewed by React Doctor for commit |
An empty string is already contained in any index, so the extra guard did not change which pages fail.
pro.microlink.io answers 400 to a bare % before the request reaches the API. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
api.microlink.io accepts a raw % and answers from the API; pro.microlink.io returns 400 before the request arrives. The changelog example is the encoded form that both accept.
Docs for microlink/api!2068 (https://gitlab.com/microlink/api/-/merge_requests/2068):
timeout=80%resolves to 80% of the plan budget.Merge after !2068 is released.
timeout.md: a percentage section with the raw and%25forms; the figcaption computes the seconds fromhelpers/plan-timeouts({PRO_PLAN_REQUEST_TIMEOUT_SECONDS * 0.8}), so it follows any budget changetimeouttakes a duration or a percentage such as'80%'(the SDK sends it as80%25, checked)Both docs compile with the site MDX loader; the
plan-timeoutsguard passes.🤖 Generated with Claude Code
Note
Low Risk
Documentation and a sync test only; no application or API runtime behavior changes in this repo.
Overview
Documents that
timeoutcan be set as a percentage of the plan budget (e.g.80%), alongside existing millisecond and human-readable duration forms.The API parameter page adds examples (
timeout=80%25in URLs), URL-encoding notes, pro’s 400 for bare%, SDK handling ('80%'), and a figcaption tied toplan-timeoutshelpers so seconds stay accurate when limits change. SDK options, OpenAPI, llms.txt, and the November 2026 changelog carry the same wording update.An integration test asserts every parameter’s frontmatter
descriptionappears inllms.txt, keeping agent-facing index text aligned with the docs.Reviewed by Cursor Bugbot for commit 23c4533. Bugbot is set up for automated code reviews on this repo. Configure here.
Summary by CodeRabbit
80%examples and URL-encoding guidance.%values are rejected with a 400 response, SDKs handle encoding, and percentages above 100% represent the full plan budget.