Skip to content

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

Open
aimensahnoun wants to merge 1 commit into03-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_whfrom
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
Open

docs(query-requests): simplify and refactor query requests documentation for practical implementation#65
aimensahnoun wants to merge 1 commit into03-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_whfrom
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

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 2, 2026

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.

…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
Copy link
Member Author

aimensahnoun commented Mar 2, 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.

@aimensahnoun aimensahnoun self-assigned this Mar 2, 2026
@aimensahnoun aimensahnoun 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 stat docs(query-requests): simplify and refactor query requests documentation for practical implementation Mar 2, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 2, 2026 12:11
@greptile-apps
Copy link

greptile-apps bot commented Mar 2, 2026

Greptile Summary

Successfully refactors Query Requests documentation from AI-generated placeholder content to practical, endpoint-driven guidance. Removes theoretical status lifecycle diagrams and replaces them with concrete API endpoint references and step-by-step reconciliation patterns. Reduces page length by 20% while adding more actionable information. OpenAPI links and internal page references are all valid.

Key improvements:

  • Removed AI-generated content warning
  • Added Core Endpoints section with direct OpenAPI links
  • Replaced mermaid diagram with practical Steps component
  • Added Reconciliation Pattern section explaining webhook-first approach
  • Updated related pages to focus on implementation guides

Check needed:

  • Verify hasBeenPaid and isListening field names match actual API response schema (not found in other docs)

Confidence Score: 4/5

  • Safe to merge after verifying field names against actual API response
  • Documentation-only PR with clear improvements to structure and content. Only concern is two field names (hasBeenPaid, isListening) that couldn't be verified in codebase or webhook examples. All links are valid and content aligns with technical writing guidelines.
  • Verify that api-features/query-requests.mdx uses correct API field names by checking against actual API response schema

Important Files Changed

Filename Overview
api-features/query-requests.mdx Refactored from AI-generated content to practical endpoint-driven documentation with clearer reconciliation guidance; field names need verification

Last reviewed commit: 5b84b6a

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.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

Comment on lines +25 to +29
- `hasBeenPaid`
- `paymentReference`
- `txHash`
- `isListening`
- optional metadata such as `customerInfo` and `reference`
Copy link

Choose a reason for hiding this comment

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

Verify field names match actual API schema. hasBeenPaid and isListening not found in webhook docs or other pages - webhooks use totalAmountPaid/expectedAmount instead.

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.

1 participant