generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 1
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
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
aimensahnoun
wants to merge
1
commit into
03-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_
Choose a base branch
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
base: 03-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_
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+5,956
−32
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| --- | ||
| title: "Endpoints Overview" | ||
| description: "Quick index of v2 endpoint groups" | ||
| --- | ||
|
|
||
| ## Overview | ||
|
|
||
| Use this page as the index for v2 endpoints in the docs-integrated OpenAPI reference. | ||
|
|
||
| ## v2 Endpoint Groups | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Requests" href="/api-reference/request/create-a-new-request-1" icon="file-invoice"> | ||
| v2 request endpoints for create, status, pay calldata, and routes. | ||
| </Card> | ||
|
|
||
| <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> | ||
| </CardGroup> | ||
|
|
||
| ## Requests (v2) | ||
|
|
||
| - [v2 Request endpoints](https://api.request.network/open-api/#tag/v2request) | ||
| - [POST /v2/request](https://api.request.network/open-api/#tag/v2request/POST/v2/request) | ||
| - [GET /v2/request/{requestId}](https://api.request.network/open-api/#tag/v2request/GET/v2/request/%7BrequestId%7D) | ||
| - [GET /v2/request/{requestId}/pay](https://api.request.network/open-api/#tag/v2request/GET/v2/request/%7BrequestId%7D/pay) | ||
| - [GET /v2/request/{requestId}/routes](https://api.request.network/open-api/#tag/v2request/GET/v2/request/%7BrequestId%7D/routes) | ||
|
|
||
| ## Payouts (v2) | ||
|
|
||
| - [v2 Payout endpoints](https://api.request.network/open-api/#tag/v2payouts) | ||
| - [POST /v2/payouts](https://api.request.network/open-api/#tag/v2payouts/POST/v2/payouts) | ||
| - [POST /v2/payouts/batch](https://api.request.network/open-api/#tag/v2payouts/POST/v2/payouts/batch) | ||
| - [POST /v2/payouts/recurring/{id}](https://api.request.network/open-api/#tag/v2payouts/POST/v2/payouts/recurring/%7Bid%7D) | ||
|
|
||
| ## Payments (v2) | ||
|
|
||
| - [GET /v2/payments](https://api.request.network/open-api/#tag/v2payments/GET/v2/payments) | ||
|
|
||
| ## Payer / Compliance (v2) | ||
|
|
||
| - [v2 Payer endpoints](https://api.request.network/open-api/#tag/v2payer) | ||
| - [POST /v2/payer](https://api.request.network/open-api/#tag/v2payer/POST/v2/payer) | ||
| - [GET /v2/payer/{clientUserId}](https://api.request.network/open-api/#tag/v2payer/GET/v2/payer/%7BclientUserId%7D) | ||
| - [PATCH /v2/payer/{clientUserId}](https://api.request.network/open-api/#tag/v2payer/PATCH/v2/payer/%7BclientUserId%7D) | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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:
hrefattribute from these cards so they don't link anywhere, orhttps://api.request.network/open-api/#tag/v2payouts) as done in the list sections below.