Skip to content

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

Open
aimensahnoun wants to merge 1 commit into03-02-docs_api-reference_rewrite_authentication_page_as_canonical_auth_reference_replace_the_previous_ai-generated_authentication_page_with_a_focused_api-accurate_authentication_reference_that_stands_on_its_own_and_avoids_duplicating_from
03-03-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
Open

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
aimensahnoun wants to merge 1 commit into03-02-docs_api-reference_rewrite_authentication_page_as_canonical_auth_reference_replace_the_previous_ai-generated_authentication_page_with_a_focused_api-accurate_authentication_reference_that_stands_on_its_own_and_avoids_duplicating_from
03-03-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

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 3, 2026

No description provided.

…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
@aimensahnoun aimensahnoun self-assigned this Mar 3, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 3, 2026 11:00
Copy link
Member Author

aimensahnoun commented Mar 3, 2026

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@greptile-apps
Copy link

greptile-apps bot commented Mar 3, 2026

Greptile Summary

This PR introduces a dedicated Endpoints Overview page (api-reference/endpoints-overview.mdx) for the v2 API reference and switches the Mintlify OpenAPI rendering to a locally committed api-reference/openapi.v2.json spec. The docs.json navigation is updated to reference the v2-only scope.

Key changes:

  • New api-reference/endpoints-overview.mdx with <CardGroup> cards for v2 endpoint groups and quick-links to frequently used endpoints.
  • docs.json group renamed from "Endpoints" to "Endpoints (V2)", OpenAPI source switched from remote URL to local api-reference/openapi.v2.json.
  • request-network-api/create-and-pay-requests.mdx — formerly the overview page — has been replaced with "Endpoints Overview" content and is now orphaned (not in navigation).

Issues found:

  • Three of the four <Card> links in the overview (Payouts, Payments, Payer / Compliance) point to /api-reference/endpoints, which does not exist and will 404 for users.
  • request-network-api/create-and-pay-requests.mdx is an orphaned file with duplicate content that should be deleted rather than left unmaintained in the repository.

Confidence Score: 2/5

  • Not safe to merge — two critical issues must be resolved: broken card links and an orphaned file.
  • The docs.json and openapi.v2.json changes are clean and well-structured, but the new endpoints overview page has three card links pointing to a non-existent route (/api-reference/endpoints), which will produce 404 errors for users. Additionally, an orphaned file (request-network-api/create-and-pay-requests.mdx) with misleading duplicate content should be deleted. Both issues must be addressed before merge.
    • api-reference/endpoints-overview.mdx (broken card hrefs at lines 17–27)
  • request-network-api/create-and-pay-requests.mdx (orphaned file that should be deleted)

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"]
Loading

Last reviewed commit: 0d66aac

Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

4 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

Comment on lines +17 to +27
<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>
Copy link

Choose a reason for hiding this comment

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

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:

  1. Remove the href attribute from these cards so they don't link anywhere, or
  2. Link to the external OpenAPI docs (e.g., https://api.request.network/open-api/#tag/v2payouts) as done in the list sections below.

@greptile-apps
Copy link

greptile-apps bot commented Mar 3, 2026

Additional Comments (1)

request-network-api/create-and-pay-requests.mdx
This file is orphaned — it is no longer referenced in docs.json navigation and is unreachable to users. It contains a duplicate "Endpoints Overview" that mirrors api-reference/endpoints-overview.mdx.

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 docs.json to reference it again and restore the original content.

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.

Docs - Make the Beta Docs good enough to link from the website instead of Legacy Docs

1 participant