Skip to content

docs(api): document GET /currencies/classifications - #499

Open
GiselleNessi wants to merge 3 commits into
mainfrom
giselle/int2-1663-currency-classifications-docs
Open

GiselleNessi wants to merge 3 commits into
mainfrom
giselle/int2-1663-currency-classifications-docs

Conversation

@GiselleNessi

Copy link
Copy Markdown
Collaborator

Summary

Documents GET /currencies/classifications (INT2-1663, requested by Rory via Idan): reference stub rendering the existing OpenAPI operation, nav entry next to Get Currencies, and a cross-link from the fees concept page's stable/major/minor definitions.

Verified

  • Live response and spec schema match: { major: string[], stable: string[] }, no parameters
  • The Note documents what the spec can't: lowercase symbols, no minor list (a token in neither array is minor for fees), symbol-based matching

@ipeleg reviewing as the endpoint owner — the ticket wants the contract and classification semantics confirmed by you before publication, so flag anything the Note gets wrong.

Linear: INT2-1663

Endpoint reference stub for INT2-1663 (Rory/Idan): the live source of
the stable/major fee-category lists. Notes the minor-by-omission
semantics and symbol-based matching; cross-linked from the fees
concept page and added to the API Reference nav.
@mintlify

mintlify Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated
unevenlabs 🟢 Ready View Preview Oct 13, 2026, 2:56 PM

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

@github-actions github-actions Bot added the legal-review-pending Fee Structure doc changed; awaiting Legal approval label Oct 8, 2026
@github-actions

github-actions Bot commented Oct 8, 2026

Copy link
Copy Markdown
Contributor

⏳ Legal review pending

This PR changes the Fee Structure documentation:

  • references/api/api_core_concepts/fees.mdx

Fee terminology here is mirrored in BD proposals and legal agreement templates, so renaming or redefining a fee can break signed agreements. @PeterPython must approve before this can merge.

Merging is blocked by .github/CODEOWNERS until then. If this PR is a draft, GitHub requests the review when you mark it ready.

@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @GiselleNessi's task in 40s —— View job


Code review: PR #499, GET /currencies/classifications

  • Read the diff and the repo style guide (AGENTS.md)
  • Check the stub, nav entry and fees cross-link against the profiles in §3.3 and §3.3a
  • Check the live endpoint and OpenAPI spec. Not done: this run doesn't allow curl, so I relied on the "Verified" section of the PR description.

The stub follows §3.3: it has the right frontmatter, an imperative title and description, a body that only holds a short <Note>, and the nav entry sits next to Get Currencies. There are no blocking problems. Three things to look at:

1. The Note talks about a token being minor, but the fees page classifies pairs of tokens (references/api/get-currency-classifications.mdx:8, references/api/api_core_concepts/fees.mdx:114)

The fees page defines Stablecoin, Major and Minor swaps by the pair being swapped:

  • A Stablecoin swap needs both tokens to be Major Stablecoins.
  • A Major swap is Major Token with Major Token, or Major Token with Major Stablecoin.
  • A Minor swap needs both tokens to be neither.

"Any token in neither array is treated as minor for fees" invites readers to work out a fee from one token. The page doesn't say what happens to a mixed pair such as USDC to LINK, and readers will now guess. I suggest one of these:

  • Word it as "a token in neither list is not a Major Token or Major Stablecoin; see Fees for how a pair of tokens is classified."
  • Or have @ipeleg confirm how mixed pairs are classified, and state it.

This is fee wording, and the PR is labelled legal-review-pending, so it is worth getting right. Fix this →

2. The cross-link on the fees page is in the wrong place (fees.mdx:114)

The sentence sits after the App Fees paragraph, so it reads as if it belongs to App Fees. It describes the stable, major and minor definitions in Relay Fees, so put it right after the Minor swap example (line 106), indented under that list item.

3. Check that the API lists match the fees page (for @ipeleg)

The Note calls the endpoint "the live source of the fee-category lists in Fees". The fees page names specific symbols, such as USDC.e, USDT0, PlumeUSD, mUSD/USDm, BTC and PLUME. If the API returns a different set, the docs now contradict each other. Please compare the two lists, and say which one wins if they drift apart. "The lists can change as Relay adds tokens" suggests the API wins. If that's the intent, consider a short line on the fees page saying the endpoint is authoritative.

Minor

  • references/api/overview.mdx:30: the Utilities list links every endpoint in that nav group but not this one. Consider adding: [Get Currency Classifications](/references/api/get-currency-classifications): Returns the token symbols classified as stable or major.
  • Optional: §4.5 allows an **Added** entry in references/api/changelog.mdx for notable additions. The endpoint already exists, so this is a judgement call.
  • The rest follows the style guide: Title Case title, root-relative links, a Note well under the 15-line limit, and a filename in the get-<noun> pattern.

@greptile-apps

greptile-apps Bot commented Oct 8, 2026 •

Copy link
Copy Markdown

RetriggerConfidence Score: 5/5

[Low impact] The PR appears safe to merge; no actionable issues were found.

Summary

Adds a discoverable reference page for GET /currencies/classifications.

  • The API reference shows how currency symbols map to fee categories.
  • Readers can find the classification reference from the API menu and Fees guide.

Reviews (3) · Last reviewed commit: "Merge branch 'main' into giselle/int2-16..." · Reviewed by Greptile

@GiselleNessi GiselleNessi self-assigned this Oct 13, 2026
@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @GiselleNessi's task in 36s —— View job


Code review: PR #499, GET /currencies/classifications (re-run after sync)

  • Read the diff against origin/main and the style guide (AGENTS.md §3.3, §3.3a, §2)
  • Check what the new push changed
  • Re-check the stub, the nav entry and the fees cross-link
  • Check the live endpoint and spec. Not done: this run can't make network calls, so I'm relying on the "Verified" section of the PR description.

What changed: the new push (01cd600) only merges main into this branch. The three files in the PR are the same as in the last review, so the three open points from that review still apply. I've restated them below, tightened, along with one new point.

The stub itself follows §3.3: the frontmatter is right, the title and description are imperative, the body is a short <Note>, the nav entry sits next to Get Currencies, and the links are root-relative. Nothing blocks merging on style.

Issues

1. The docs say a single token is minor, but the fees page classifies pairs (references/api/get-currency-classifications.mdx:8, references/api/api_core_concepts/fees.mdx:114)

The fees page defines Stablecoin, Major and Minor as types of swap, decided by both tokens (fees.mdx:98-106). It says nothing about a mixed pair such as USDC → LINK. "Any token in neither list is treated as minor" invites readers to fill that gap themselves, and this page carries the legal-review-pending label. Suggested wording: "A token in neither list is not a Major Stablecoin or Major Token. See Fees for how a swap is classified." Or have @ipeleg confirm how a mixed pair is classified, and then state it.
Fix this →

2. The note says classification is by symbol. Please confirm that with @ipeleg before publishing (get-currency-classifications.mdx:8)

"Classification is by symbol, not by contract address" is a claim about how fees behave. Read literally, any token that calls itself usdc would get Stablecoin-swap pricing. If the fee engine actually resolves tokens by address and the endpoint only reports symbols, the note is wrong. If the engine really does match by symbol, it's still worth deciding whether to publish that. Either way, the endpoint owner needs to confirm it.

3. The cross-link on the fees page is in the wrong place (fees.mdx:114)

The sentence comes right after the App Fees paragraph, so it reads as part of App Fees. Move it to just after the Minor swap examples (line 106), indented to match that list, so it sits next to the definitions it refers to.

4. The API lists and the fees page could disagree. Please compare them (for @ipeleg)

The fees page names its symbols by hand: USDC.e, USDT0, pUSD, PlumeUSD, mUSD/USDm, BTC, PLUME, WETH/WSOL and so on. The note calls the endpoint "the live source". If the two sets ever differ, the docs contradict each other. Please confirm they match today, for example that the API returns usdc.e with the dot. If the API is meant to win, add a line on the fees page saying the endpoint is authoritative.

Minor

  • references/api/overview.mdx:30-32: the Utilities list links every other endpoint in the nav group. Consider adding [Get Currency Classifications](/references/api/get-currency-classifications): Returns the token symbols classified as stable or major.
  • Optional: §4.5 allows an **Added** entry in references/api/changelog.mdx. The endpoint already existed, so whether to add one is a judgement call.

@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @pedromcunha's task in 39s —— View job


Code review: PR #499, GET /currencies/classifications (third run, after another sync)

  • Read the diff against origin/main and the style guide (AGENTS.md §2, §3.3, §3.3a)
  • Check what the new push changed
  • Re-check the stub, the nav entry and the fees cross-link against fees.mdx:90-116
  • Check the live endpoint and spec. Not done: this run can't make network calls, so I'm relying on the "Verified" section of the PR description. The /code-review skill also failed to load in this run, so I did the review by hand.

What changed: nothing in the PR's files. The new commit (cf47c13) only merges main into the branch again, and git diff 01cd600 cf47c13 is empty for all three files. Since the last run, @ipeleg (the endpoint owner) and @pedromcunha have approved. The approvals don't comment on the specific points below, so I've kept the ones that still matter for a page labelled legal-review-pending.

The stub meets §3.3: the frontmatter is correct, the title and description are imperative, the body is one short <Note>, the nav entry sits next to Get Currencies, and the links are root-relative. Nothing here blocks merging on style or structure.

Still open

1. The Note and the fees page call a single token "minor", but the fees page classifies swaps by pair (references/api/get-currency-classifications.mdx:8, references/api/api_core_concepts/fees.mdx:114)
fees.mdx:98-106 defines Stablecoin, Major and Minor as types of swap, decided by both tokens. It doesn't cover a mixed pair such as USDC → LINK. "Any token in neither list is treated as minor" invites readers to fill that gap themselves. Suggested wording: "A token in neither list is not a Major Stablecoin or Major Token. See Fees for how a swap is classified."
Fix this →

2. "Classification is by symbol, not by contract address" (get-currency-classifications.mdx:8)
Read literally, this says any token whose symbol is usdc gets Stablecoin-swap pricing. @ipeleg's approval suggests the line is accurate. Even so, it's worth an explicit 👍 that the fee engine matches by symbol rather than resolving by address, and that you want to publish that detail. If you're unsure, drop the sentence. The rest of the Note doesn't need it.

3. The cross-link on the fees page is in the wrong place (fees.mdx:114)
The sentence comes right after the App Fees paragraph (line 112), so it reads as part of App Fees. Move it to just after the Minor swap examples (line 106), indented three spaces to match the list, so it sits under the definitions it refers to.
Fix this →

4. The API lists and the fees page could disagree
fees.mdx:98,101 lists the symbols by hand (USDC.e, USDT0, pUSD, PlumeUSD, mUSD, USDm, PLUME, and so on), and the Note calls the endpoint "the live source". Please check that they match today, for example that the API returns usdc.e with the dot. If the endpoint is meant to win when they drift apart, say so in one line on the fees page.

Minor

  • references/api/overview.mdx:30-32: the Utilities list links every other endpoint in this nav group. Consider adding [Get Currency Classifications](/references/api/get-currency-classifications): Returns the token symbols classified as stable or major.
  • Optional: §4.5 allows an **Added** entry in references/api/changelog.mdx. The endpoint already existed, so this is a judgement call.

@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Claude finished @GiselleNessi's task in 29s —— View job


Code review: PR #499, GET /currencies/classifications (third run, after sync)

  • Read the diff against origin/main and the style guide (AGENTS.md §2, §3.3, §3.3a)
  • Check what the new push changed
  • Re-check the stub, the nav entry and the fees cross-link against fees.mdx:90-116
  • Check the live endpoint and the spec. Not done: this run can't make network calls, so I relied on the "Verified" section of the PR description.

What changed: the new push (cf47c13) only merges main again. The merge touched other files (get-usage.mdx, protocol/guides/withdrawals.mdx, and others) but none of the three files in this PR, so the diff is the same as in the last two reviews. Since then, @ipeleg and @pedromcunha have both approved.

The stub still follows §3.3, and nothing blocks merging on style. The points below are still open. The approvals don't say whether they were addressed, so I'm listing them again briefly.

Still open

1. The docs call a single token "minor", but the fees page classifies swaps by pair (references/api/get-currency-classifications.mdx:8, references/api/api_core_concepts/fees.mdx:114)
In fees.mdx:99-106, Stablecoin, Major and Minor are kinds of swap, and each depends on both tokens. The page doesn't cover a mixed pair such as USDC → LINK. Saying "any token in neither list is treated as minor" leads readers to fill that gap on their own, and this PR is labelled legal-review-pending. A safer wording: "A token in neither list is not a Major Stablecoin or Major Token. See Fees for how a swap is classified."
Fix this →

2. "Classification is by symbol, not by contract address" makes a claim about fee behaviour (get-currency-classifications.mdx:8)
Read literally, any token whose symbol is usdc gets Stablecoin-swap pricing. @ipeleg's approval may already confirm this. If so, a short reply on the PR would put that on record before legal review. If the fee engine actually resolves tokens by address, change the wording to say the endpoint reports symbols.

3. The fees cross-link is in the wrong place (fees.mdx:114)
The sentence comes right after the App Fees paragraph, but it describes the swap types in item 3. Move it to just after the Minor swap examples (line 106) and indent it to match that list.

4. Two lists can drift apart
fees.mdx:99,102 lists the symbols by hand (USDC.e, USDT0, pUSD, PlumeUSD, mUSD/USDm, BTC, PLUME and others), and the Note calls the endpoint "the live source". Please confirm the two sets match today, for example that the API returns usdc.e with the dot. If the endpoint is meant to be authoritative, say so on the fees page.

Minor

  • references/api/overview.mdx:30: the Utilities list links the other endpoints in that nav group but not this one. Consider adding [Get Currency Classifications](/references/api/get-currency-classifications): Returns the token symbols classified as stable or major.
  • Optional: under §4.5 you could add an **Added** entry to references/api/changelog.mdx. The endpoint already existed, so this is your call.

This branch was successfully deployed

1 active deployment
staging — cf47c13a Deployed Oct 13, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

legal-review-pending Fee Structure doc changed; awaiting Legal approval

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants