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
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
…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
Greptile SummaryThis PR introduces a dedicated Endpoints Overview page ( Key changes:
Issues found:
Confidence Score: 2/5
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A["docs.json\n(navigation config)"]
A -->|"openapi: api-reference/openapi.v2.json"| B["openapi.v2.json\n(local v2-only spec)"]
A -->|"pages: api-reference/endpoints-overview"| C["endpoints-overview.mdx\n(overview page)"]
C -->|"✅ Requests card"| D["/api-reference/request/create-a-new-request-1"]
C -->|"❌ Payouts card (404)"| E["/api-reference/endpoints\n(does not exist)"]
C -->|"❌ Payments card (404)"| E
C -->|"❌ Payer card (404)"| E
B -->|"Mintlify auto-generates"| F["V2 Endpoint Pages\n(/api-reference/v2request/...\n/api-reference/v2payouts/...\netc.)"]
G["request-network-api/create-and-pay-requests.mdx\n(orphaned — not in docs.json)"]
G -.->|"no longer linked"| X["❌ unreachable in nav"]
Last reviewed commit: 0d66aac |
| <Card title="Payouts" href="/api-reference/endpoints" icon="paper-plane"> | ||
| v2 payout endpoints for direct, batch, and recurring operations. | ||
| </Card> | ||
|
|
||
| <Card title="Payments" href="/api-reference/endpoints" icon="magnifying-glass"> | ||
| v2 payment search endpoint for reconciliation and reporting. | ||
| </Card> | ||
|
|
||
| <Card title="Payer / Compliance" href="/api-reference/endpoints" icon="shield-check"> | ||
| v2 payer endpoints for KYC, agreement, and payment details. | ||
| </Card> |
There was a problem hiding this comment.
Three of the four <Card> components in this CardGroup link to /api-reference/endpoints, which is not a real page in the navigation. Users clicking on "Payouts", "Payments", or "Payer / Compliance" will hit a 404.
These should link to actual pages once the OpenAPI spec is rendered by Mintlify and the endpoint pages are auto-generated. For now, either:
- Remove the
hrefattribute from these cards so they don't link anywhere, or - Link to the external OpenAPI docs (e.g.,
https://api.request.network/open-api/#tag/v2payouts) as done in the list sections below.
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 |

No description provided.