Skip to content

docs(timeout): accept a percentage of the plan budget - #2415

Merged
Kikobeats merged 6 commits into
masterfrom
Kikobeats/timeout-percentage
Nov 17, 2026
Merged

Kikobeats merged 6 commits into
masterfrom
Kikobeats/timeout-percentage

Conversation

@Kikobeats

@Kikobeats Kikobeats commented Nov 17, 2026 •

Copy link
Copy Markdown
Member

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 %25 forms; the figcaption computes the seconds from helpers/plan-timeouts ({PRO_PLAN_REQUEST_TIMEOUT_SECONDS * 0.8}), so it follows any budget change
  • SDK options: timeout takes a duration or a percentage such as '80%' (the SDK sends it as 80%25, checked)
  • changelog entry

Both docs compile with the site MDX loader; the plan-timeouts guard 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 timeout can 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%25 in URLs), URL-encoding notes, pro’s 400 for bare %, SDK handling ('80%'), and a figcaption tied to plan-timeouts helpers 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 description appears in llms.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

  • Documentation
    • Clarified that API and SDK timeout values can be provided as durations or as a percentage of the plan budget, with 80% examples and URL-encoding guidance.
    • Documented that bare % values are rejected with a 400 response, SDKs handle encoding, and percentages above 100% represent the full plan budget.
    • Added information about how timeout values are displayed in comparison with the plan budget.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
design Ready Ready Preview Nov 17, 2026 11:13pm UTC
www Ready Ready Preview Nov 17, 2026 11:13pm UTC

Request Review

@coderabbitai

coderabbitai Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

Explain Change →

Warning

Review limit reached

You'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.

Check out review usage here.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

Learn how review limits work.

Review configuration:

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: b6565c1b-8426-49c6-baa5-f081a74381ed
Commits

Reviewing files that changed from the base of the PR and between 287a8dd and 23c4533.

Files selected for processing: 2

  • src/content/docs/api/parameters/timeout.md
  • src/content/fragments/changelog.md

No actionable comments were generated in the recent review.

Walkthrough

The API and SDK documentation, static API descriptions, and November 2026 changelog now describe timeout values as percentages of the plan budget. The API documentation includes an 80% example and explains URL encoding and budget comparisons.

Changes: Timeout percentage documentation

Layer / File(s) Summary
Document percentage-based timeouts
src/content/docs/api/parameters/timeout.md, src/content/docs/sdk/getting-started/options.md
The API and SDK documentation add percentage-based timeout values. The API documentation includes an example and explains URL encoding and budget comparisons.
Publish and check timeout descriptions
src/content/fragments/changelog.md, static/llms.txt, static/openapi.json, test/integration/openapi.js
The changelog and static API descriptions include percentage-based values. An integration test checks that parameter-page descriptions appear in static/llms.txt.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Possibly related PRs

  • microlinkhq/www#2414: Changes the Pro timeout constant used to calculate the Pro-plan duration shown in this PR’s documentation.

Suggested reviewers: josebaseba

Merge Risk: Minimal · previous review 287a8

This updates the timeout docs to describe percentage-of-plan-budget values and adds a consistency check for published descriptions. No merge-blocking issue was found. The author notes it should land after the related API change is released.

Pre-merge checks: Passed 4

Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the docs change for the timeout parameter: it now accepts a percentage of the plan budget. The raw summary shows the timeout docs, SDK options, changelog, llms.txt, and openapi.json al…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the docs change for the timeout parameter: it now accepts a percentage of the plan budget. The raw summary shows the timeout docs, SDK options, changelog, llms.txt, and openapi.json all document percentage values, so the title matches the main change. The title is short, specific, and follows the conventional-commit style.

Finishing Touches

Generate unit tests (beta)

  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c5b34673-eb06-4729-98f9-c4635a448034
Commits

Reviewing files that changed from the base of the PR and between cf9df7a and 287a8dd.

Files selected for processing: 2

  • src/content/docs/api/parameters/timeout.md
  • test/integration/openapi.js

Included review availability: This review used your included allowance. Your plan provides up to 2 included reviews per hour; 0 remain after this review.

@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

@microlink/difftool visual comparison

workflow run · base microlink.io · head 33fa1ur95-hqnlb9v2u-microlink.vercel.app

✅ 1/1 routes pass

Route Changes Production Preview Difference Compare Verdict
/styleguide 0.00% open open open compare ✅
configuration
{
  "base": "https://microlink.io",
  "head": "https://33fa1ur95-hqnlb9v2u-microlink.vercel.app",
  "threshold": 0.005,
  "warningThreshold": 0.05,
  "pixelThreshold": 0.1,
  "verdict": "pass",
  "passed": true,
  "routes": [
    {
      "route": "/styleguide",
      "baseUrl": "https://microlink.io/styleguide",
      "headUrl": "https://33fa1ur95-hqnlb9v2u-microlink.vercel.app/styleguide",
      "diffPixels": 0,
      "totalPixels": 34867200,
      "diffRatio": 0,
      "verdict": "pass",
      "passed": true,
      "outDir": "."
    }
  ]
}

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.
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

React Doctor found no new issues. 🎉

Reviewed by React Doctor for commit 23c4533.

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.
@Kikobeats
Kikobeats merged commit 440696c into master Nov 17, 2026
9 checks passed
@Kikobeats
Kikobeats deleted the Kikobeats/timeout-percentage branch November 17, 2026 23:23

This branch was successfully deployed

2 active deployments
Preview – www — 23c45338 Deployed Nov 17, 2026 by vercel[bot]
Preview – design — 23c45338 Deployed Nov 17, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant