Skip to content

docs(drift): draft from internal source - #431

Merged
ipeleg merged 1 commit into
mainfrom
docs-drift/src-9c82a64df5-e7342ff
Aug 27, 2026
Merged

docs(drift): draft from internal source#431
ipeleg merged 1 commit into
mainfrom
docs-drift/src-9c82a64df5-e7342ff

Conversation

@pedromcunha

Copy link
Copy Markdown
Member

Drafted from an internal source repo, requested by @ipeleg.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

  • Content matches the behavior shipped in the source PR
  • No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
  • Conforms to CLAUDE.md style rules
  • Cross-references and internal links resolve
  • Any Needs human input items from the source comment are addressed

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

Requested by @ipeleg via /publish-docs-pr
@mintlify

mintlify Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview Aug 27, 2026, 3:56 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ipeleg
ipeleg marked this pull request as ready for review August 27, 2026 16:12
@github-actions

github-actions Bot commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Claude finished @ipeleg's task in 2m 31s —— View job


Review: /authorize per-wallet rate limit docs

  • Gather context (diff, changed files, style guide)
  • Review references/api/api-keys.mdx
  • Review references/api/changelog.mdx
  • Check style-guide conformance (AGENTS.md) and link resolution
  • Post review

The change is accurate and well-scoped — wallet is a real field on the /authorize request body (confirmed against the nonce-mapping payloads in references/api/api_guides/hyperliquid-support.mdx:133 and :611), and the /execute/permits app-fee path doesn't hit /authorize, so the blanket "bucketed by the wallet field" claim holds for every documented caller. Five things to look at, ranked.


1. Self-serve /authorize limit is now undocumented — content gap

references/api/changelog.mdx:8 says "Self-serve /authorize limits are unchanged," which tells a reader that self-serve /authorize has a limit worth mentioning. But the Default Rate Limits table (references/api/api-keys.mdx:36-41) never names /authorize, so a self-serve reader lands on Other endpoints — 200 requests per minute.

One of these is true, and they need different fixes:

  • Self-serve /authorize really is 200/min (the generic bucket) → the changelog sentence is misleading and should be dropped or reworded to "Self-serve keys are unaffected."
  • Self-serve /authorize has its own limit (5/min? something else?) → the default table needs an /authorize row too, otherwise this PR documents the elevated tier's limit while leaving the tier most readers are on pointing at a wrong number.

Worth confirming against the source PR before merge — this is the one item I can't settle from the repo alone.

2. on-chain should be onchainreferences/api/api-keys.mdx:58

AGENTS.md §5: onchain — one word, no hyphen. The rest of the in-scope pages follow it (how-relay-works.mdx:3, input-validation.mdx:3, builder-codes.mdx:6, …). Fix this →

While you're on that line: "bounds total volume of the on-chain authorization path" is vaguer than the surrounding prose. "…and caps total /authorize volume per key" says the same thing concretely.

3. Table cell carries an explanation that belongs in the prose — references/api/api-keys.mdx:53

AGENTS.md §2.7: "Keep cell descriptions concise; move long explanations into prose below the table." This cell packs both limits plus a qualifier into ~105 characters, which forces every other row in the table to re-pad — most of the diff on this file is that reflow, not new content.

The paragraph you added at line 58 already carries the aggregate ceiling, so the cell can just be 5 requests per minute per wallet and the table keeps its original width. Fix this →

4. Units differ between the two files for the same numbers

The table says "requests per minute"; the changelog entry says "requests per 60 seconds" and "5-per-60-second bucket" for the identical limits. The page's phrasing matches its neighbouring rows, so align the changelog to it. Fix this →

5. Nit: separator row is wider than the data rows — references/api/api-keys.mdx:48

The --- row is a couple of characters longer than every padded cell above and below it. Renders fine in Mintlify, but references/** isn't in .prettierignore (only changelog.mdx and references/sdk/getting-started.mdx are), so anyone who runs the formatter will reflow the table again. Folds into the fix for #3.


Checks that passed

  • [Elevated Rate Limits](/references/api/api-keys#elevated-rate-limits) resolves — ## Elevated Rate Limits at references/api/api-keys.mdx:43, root-relative per §2.6. ✅
  • Changelog heading matches the parser in scripts/build-changelog.mjs:181 (/^## (\d{4}-\d{2}-\d{2})\s*—\s*(.+)$/gm), so it won't be silently dropped from the unified changelog. Em dash present, backticks in the title are fine (same shape as the 2026-08-20 entry). ✅
  • **Behavior change** is in CHANGE_TYPE_ORDER (scripts/build-changelog.mjs:47) and matches the established lead used by neighbouring entries. ✅
  • Entry is newest-first at the top, dated 2026-08-26. ✅
  • Generated changelog.mdx correctly left untouched — the hourly sync picks it up after merge per §4.6. ✅
  • No internal-only names, service names, or file paths leaked. ✅

I didn't run node scripts/build-changelog.mjs --check — it needs a full-depth clone of relay-kit, and the heading/type parsing above is what that check would exercise for this diff anyway.

No changes pushed — this is review feedback only.
· branch docs-drift/src-9c82a64df5-e7342ff

@ipeleg
ipeleg merged commit 13da2c2 into main Aug 27, 2026
6 checks passed
@ipeleg
ipeleg deleted the docs-drift/src-9c82a64df5-e7342ff branch August 27, 2026 16:17
@greptile-apps

greptile-apps Bot commented Aug 27, 2026

Copy link
Copy Markdown

Greptile Summary

This update documents wallet-scoped elevated limits for /authorize and adds the corresponding API changelog entry. The API-key reference publishes “on-chain authorization path,” which conflicts with the repository’s required “onchain” spelling and should be normalized before merging.

Confidence Score: 4/5

The documentation change is not ready to merge until the noncanonical terminology in the API-key reference is corrected.

An executable content check confirmed one published terminology inconsistency and confirmed that the proposed one-word spelling resolves it.

Files Needing Attention: references/api/api-keys.mdx line 58 needs “on-chain” changed to “onchain.”

T-Rex T-Rex Logs

What T-Rex did

  • T-Rex produced proof for the posted P2 finding and referenced the corresponding review comment for details.
  • T-Rex produced proof for another posted P2 finding and referenced its review comment for details.
  • T-Rex ran the requested contract verification, but its local artifact references were not uploaded.

T-Rex Ran code and verified through T-Rex

Comments Outside Diff (1)

  1. General comment

    P2 API keys documentation uses non-canonical “on-chain” spelling

    • Bug
      • references/api/api-keys.mdx:58 says “on-chain authorization path,” contrary to the repository-wide style rule requiring “onchain” as one word.
    • Cause
      • The sentence was authored with a hyphenated variant despite AGENTS.md explicitly defining the canonical spelling.
    • Fix
      • Replace on-chain authorization path with onchain authorization path.

    T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "docs(drift): draft from internal source" | Re-trigger Greptile


`/requests` and `/requests/v2` share the 10 rps bucket; `/requests/v3` has its own 20 rps bucket.

`/authorize` is bucketed by the `wallet` field in the request body alongside your API key, so concurrent authorizations from different end-users don't compete for the same bucket. The aggregate per-key ceiling still applies across all wallets and bounds total volume of the on-chain authorization path.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Noncanonical onchain terminology

The sentence uses “on-chain authorization path,” but the repository requires the one-word spelling “onchain.” Replace it with “onchain authorization path” so this API reference uses the project’s published terminology consistently.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

T-Rex Ran code and verified through T-Rex

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.

2 participants