Uh oh!
There was an error while loading. Please reload this page.
docs(api-reference): add v2 endpoints overview and switch docs OpenAPI to v2-only spec Improve API Reference navigation by introducing a dedicated Endpoints Overview page in docs and wiring Mintlify OpenAPI rendering to a local v2-only spec. - add `api-re - #71
Conversation
Greptile SummaryThis PR adds a dedicated Endpoints Overview page (
Confidence Score: 4/5The docs navigation wiring is correct, but the dual-tag pattern in the bundled OpenAPI spec will produce mismatched or duplicated sidebar groups in the Mintlify-rendered API reference. The dual-tag issue on every endpoint in openapi.v2.json means Mintlify will either render endpoint groups under their generic names (Request, Pay) instead of the versioned names, or create duplicate groups for the same endpoints — both outcomes conflict with the stated goal of a clean v2-only reference. The rest of the changes (navigation rewiring, new overview page) are straightforward. api-reference/openapi.v2.json — the dual-tag pattern on each endpoint path needs review before this renders correctly in Mintlify. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[docs.json Navigation] -->|group Endpoints V2| B[endpoints-overview.mdx]
A -->|openapi source| C[openapi.v2.json]
C -->|auto-generates sidebar| D{Mintlify tag grouping}
D -->|first tag: Request| E[Request group]
D -->|second tag: V2-Request| F[V2-Request group]
D -->|first tag: Pay| G[Pay group]
D -->|second tag: V2-Payouts| H[V2-Payouts group]
D -->|only tag: V2-Payments| I[V2-Payments group - correct]
E & F --> J[Inconsistent or duplicate sidebar entries]
G & H --> J
K[create-and-pay-requests.mdx orphaned] -->|not in docs.json| L[Unreachable via navigation]
K -->|broken Card hrefs| M[api-reference-endpoints page missing]
Reviews (2): Last reviewed commit: "docs(api-reference): add v2 endpoints ov..." | Re-trigger Greptile |
Uh oh!
There was an error while loading. Please reload this page.
Additional Comments (1)
Orphaned files should be deleted rather than left in the repository. If the original "Create and Pay Requests" content is no longer needed, remove this file entirely. If it should be restored, update |
Merge activity
|
…I to v2-only spec Improve API Reference navigation by introducing a dedicated Endpoints Overview page in docs and wiring Mintlify OpenAPI rendering to a local v2-only spec. - add `api-reference/endpoints-overview.mdx` as a docs-native index for endpoint groups - update overview cards to route inside docs (instead of external links), including direct navigation to v2 Request endpoint pages - repurpose `request-network-api/create-and-pay-requests.mdx` into an endpoint-overview style page to avoid legacy overlap and reduce duplicated “how-to” content - update `docs.json` Endpoints group to use a local OpenAPI source: `api-reference/openapi.v2.json` - add `api-reference/openapi.v2.json` (filtered v2-only OpenAPI spec) to improve separation between v1 and v2 endpoint references in Mintlify - keep API Reference section focused on discoverability and endpoint navigation while API Features remains implementation-focused
0d66aac to
48d208cCompareUh oh!
There was an error while loading. Please reload this page.
| "responses": { | ||
| "200": { | ||
| "description": "Conversion routes retrieved successfully", | ||
| "content": { | ||
| "application/json": { | ||
| "examples": { |
There was a problem hiding this comment.
Every endpoint in this spec carries two tags: a generic one ("Currencies", "Request", "Pay", "Payer", "Client IDs") and a versioned one ("V2/Currencies", "V2/Request", "V2/Payouts", "V2/Payer", "V2/Client IDs"). Mintlify groups auto-generated sidebar entries by tag. Depending on whether Mintlify resolves by first tag or creates an entry per tag, rendered docs will either show un-versioned group names ("Request", "Pay", "Currencies") that conflict with the "Endpoints (V2)" parent group label, or create duplicate endpoint sections under both the generic and versioned tag names. The only exception is V2/Payments (which has a single tag), so it would render correctly while all other endpoint groups would not. Removing the generic first tag from each endpoint and keeping only the V2/… tag would give consistent labelling throughout the sidebar.
No description provided.