Skip to content

docs(query-requests): simplify and refactor query requests documentation for practical implementation - #65

Merged
rodrigopavezi merged 1 commit into
mainfrom
03-02-docs_api-features_fix_query-requests_openapi_endpoint_links_and_reconciliation_mapping_update_api-features_query-requests.mdx_to_use_the_correct_openapi_deep_links_for_request_status_and_wallet-level_reconciliation._-_replaced_n
May 12, 2026
Merged

docs(query-requests): simplify and refactor query requests documentation for practical implementation#65
rodrigopavezi merged 1 commit into
mainfrom
03-02-docs_api-features_fix_query-requests_openapi_endpoint_links_and_reconciliation_mapping_update_api-features_query-requests.mdx_to_use_the_correct_openapi_deep_links_for_request_status_and_wallet-level_reconciliation._-_replaced_n

Conversation

@aimen74

@aimen74aimen74 commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

TL;DR

Rewrote the Query Requests documentation page to focus on practical usage patterns and core endpoints rather than theoretical concepts.

What changed?

  • Removed AI-generated content warning
  • Replaced abstract lifecycle diagrams and status type definitions with concrete endpoint references and usage steps
  • Shifted focus from comprehensive status monitoring theory to practical reconciliation patterns using specific API endpoints
  • Added step-by-step implementation guide and reconciliation best practices
  • Streamlined content from 103 lines to 83 lines with more actionable information

How to test?

Review the updated documentation page to ensure:

  • Core endpoints (GET /v2/request/{requestId} and GET /v2/payments) are clearly highlighted
  • Step-by-step usage guide is easy to follow
  • Reconciliation patterns make sense for developers implementing payment tracking
  • Related page links are functional

Why make this change?

The original documentation was too theoretical and included AI-generated disclaimers that reduced confidence. The new version provides developers with immediate, actionable guidance on how to actually use query endpoints for request status monitoring and reconciliation workflows.

@aimen74Graphite App

aimen74 commented Mar 2, 2026

Copy link
Copy Markdown
ContributorAuthor

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

@aimen74aimen74 self-assigned this Mar 2, 2026
@aimen74aimen74 changed the title docs(api-features): fix query-requests OpenAPI endpoint links and reconciliation mapping Update api-features/query-requests.mdx to use the correct OpenAPI deep links for request status and wallet-level reconciliation. - replaced non-working request statdocs(query-requests): simplify and refactor query requests documentation for practical implementationMar 2, 2026
@aimen74
aimen74 marked this pull request as ready for review March 2, 2026 12:11
@greptile-apps

greptile-appsBot commented Mar 2, 2026

Copy link
Copy Markdown

Greptile Summary

This PR rewrites api-features/query-requests.mdx to replace abstract lifecycle diagrams and AI-generated disclaimers with a concise, endpoint-focused guide covering GET /v2/request/{requestId} and GET /v2/payments. The new structure uses Steps and CardGroup components and links out to the full API reference for schema details.

  • Removed the AI-generated content warning, lifecycle state diagrams, and status-type glossary in favour of two concrete endpoint references and a step-by-step usage guide.
  • Added a "Reconciliation Pattern" card group and "Practical Notes" section with idempotency guidance, plus a "Related Pages" nav block linking payment-detection, query-payments, and webhooks-events.

Confidence Score: 5/5

Safe to merge — this is a documentation-only rewrite with no functional code changes.

The change is confined to a single MDX documentation file. All internal hrefs resolve to existing pages, the frontmatter structure is valid, and the Mintlify components used are standard. The only gaps are a stale description field and absent runnable code examples — neither affects correctness or site rendering.

No files require special attention beyond the minor frontmatter description mismatch in api-features/query-requests.mdx.

Important Files Changed

FilenameOverview
api-features/query-requests.mdxRewrote query-requests docs to focus on practical endpoints and reconciliation patterns; frontmatter description and missing code examples are minor style issues.

Reviews (2): Last reviewed commit: "docs(api-features): fix query-requests O..." | Re-trigger Greptile

@greptile-appsgreptile-appsBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Comment threadapi-features/query-requests.mdx
@rodrigopaveziGraphite App

rodrigopavezi commented May 12, 2026

Copy link
Copy Markdown
Contributor

Merge activity

  • May 12, 4:02 PM UTC: A user started a stack merge that includes this pull request via Graphite.
  • May 12, 4:31 PM UTC: Graphite rebased this pull request as part of a merge.
  • May 12, 4:31 PM UTC: @rodrigopavezi merged this pull request with Graphite.

@rodrigopavezi
rodrigopavezi changed the base branch from 03-02-docs_api-features_refine_payment-detection_with_legacy-aligned_accurate_guidance_update_api-features_payment-detection.mdx_to_remove_ai-generated_placeholder_framing_and_align_the_page_with_legacy-supported_detection_concepts_wh to graphite-base/65May 12, 2026 16:28
@rodrigopavezi
rodrigopavezi changed the base branch from graphite-base/65 to mainMay 12, 2026 16:29
…onciliation mapping
Update `api-features/query-requests.mdx` to use the correct OpenAPI deep links for request status and wallet-level reconciliation.
- replaced non-working request status endpoint links with:
- https://api.request.network/open-api/#tag/v2request/GET/v2/request/{requestId}
- added wallet-level reconciliation endpoint reference:
- https://api.request.network/open-api/#tag/v2payments/GET/v2/payments
- updated both “Core Endpoints” and “How It Works” sections to keep endpoint guidance consistent
- clarified that request-level and wallet-level querying are complementary in reconciliation workflows
@rodrigopavezi
rodrigopaveziforce-pushed the 03-02-docs_api-features_fix_query-requests_openapi_endpoint_links_and_reconciliation_mapping_update_api-features_query-requests.mdx_to_use_the_correct_openapi_deep_links_for_request_status_and_wallet-level_reconciliation._-_replaced_n branch from 5b84b6a to 5f2feceCompareMay 12, 2026 16:30
@rodrigopavezi
rodrigopavezi merged commit ef0bd58 into mainMay 12, 2026
2 checks passed
@rodrigopavezi
rodrigopavezi deleted the 03-02-docs_api-features_fix_query-requests_openapi_endpoint_links_and_reconciliation_mapping_update_api-features_query-requests.mdx_to_use_the_correct_openapi_deep_links_for_request_status_and_wallet-level_reconciliation._-_replaced_n branch May 12, 2026 16:31
Sign up for freeto 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.

Documentation - Merge Mintlify docs and replace legacy docs

2 participants

@aimen74@rodrigopavezi