Skip to content

docs(fee-breakdowns): rewrite to focus on API response locations and reconciliation usage#69

Open
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_add_protocol-fees_page_and_include_it_in_fee_structure_nav_introduce_a_dedicated_protocol_fees_page_using_legacy_fee_documentation_as_the_source_of_truth_and_register_it_in_api_features_navigation._-_add_api-fefrom
03-02-docs_api-features_rebuild_fee-breakdowns_with_api-accurate_fee_models_rewrite_api-features_fee-breakdowns.mdx_into_a_reconciliation-oriented_reference_that_reflects_actual_api_fee_fields_and_response_shapes._-_remove_ai-generate
Open

docs(fee-breakdowns): rewrite to focus on API response locations and reconciliation usage#69
aimensahnoun wants to merge 1 commit into03-02-docs_api-features_add_protocol-fees_page_and_include_it_in_fee_structure_nav_introduce_a_dedicated_protocol_fees_page_using_legacy_fee_documentation_as_the_source_of_truth_and_register_it_in_api_features_navigation._-_add_api-fefrom
03-02-docs_api-features_rebuild_fee-breakdowns_with_api-accurate_fee_models_rewrite_api-features_fee-breakdowns.mdx_into_a_reconciliation-oriented_reference_that_reflects_actual_api_fee_fields_and_response_shapes._-_remove_ai-generate

Conversation

@aimensahnoun
Copy link
Member

@aimensahnoun aimensahnoun commented Mar 2, 2026

TL;DR

Rewrote the fee breakdowns documentation to focus on practical API usage patterns rather than conceptual explanations.

What changed?

  • Removed AI-generated content warning and conceptual diagrams
  • Restructured content around specific API endpoints where fee data appears (routes, payments, request status)
  • Added concrete JSON examples showing actual API response shapes
  • Replaced theoretical fee calculation flows with practical reconciliation steps
  • Updated related pages section to link to platform and protocol fee documentation

How to test?

  • Review the three main endpoints mentioned (GET /v2/request/{requestId}/routes, GET /v2/payments, GET /v2/request/{requestId}) to verify fee data appears as documented
  • Test the reconciliation workflow described in the "How to Use in Reconciliation" section
  • Validate that the JSON examples match actual API response formats

Why make this change?

The previous version was AI-generated conceptual content that didn't provide actionable guidance for developers. This rewrite focuses on where developers can find fee information in API responses and how to process it for accounting and reconciliation purposes.

Rewrite `api-features/fee-breakdowns.mdx` into a reconciliation-oriented reference that reflects actual API fee fields and response shapes.
- remove AI-generated placeholder content
- document where fee data appears:
  - GET /v2/request/{requestId}/routes (`fee`, `feeBreakdown`)
  - GET /v2/payments (`fees`)
  - GET /v2/request/{requestId}` (when enriched fee info is present)
- include supported fee types from current API behavior:
  - protocol, gas, platform, crosschain, crypto-to-fiat, offramp
- include route fee stages (sending, receiving, proxying, refunding, overall)
- add practical reconciliation guidance (raw storage, normalization, idempotency)
- add representative response-shape examples for routes and payments
- add related-page links and canonical OpenAPI reference
This provides a reliable fee-observability guide for ops, finance, and reconciliation workflows.
This was referenced Mar 2, 2026
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): rebuild fee-breakdowns with API-accurate fee models Rewrite api-features/fee-breakdowns.mdx into a reconciliation-oriented reference that reflects actual API fee fields and response shapes. - remove AI-generated placeholder content - docs(fee-breakdowns): rewrite to focus on API response locations and reconciliation usage Mar 2, 2026
@aimensahnoun aimensahnoun marked this pull request as ready for review March 2, 2026 14:35
@greptile-apps
Copy link

greptile-apps bot commented Mar 2, 2026

Greptile Summary

This PR transforms the fee-breakdowns documentation from AI-generated conceptual content into a practical API reference guide. The rewrite focuses on three key improvements:

  • Endpoint-specific documentation: Clearly identifies where fee data appears (GET /v2/request/{requestId}/routes, GET /v2/payments, GET /v2/request/{requestId}) with OpenAPI links
  • Concrete examples: Replaces theoretical diagrams with actual JSON response shapes showing feeBreakdown[] and fees[] structures
  • Reconciliation guidance: Adds practical Steps component with idempotent processing patterns for accounting workflows

The page now follows Mintlify best practices with proper component usage (Steps, CardGroup) and maintains consistency with related platform-fees and protocol-fees documentation. The cross-references are properly linked and the content is structured for developer consumption.

Confidence Score: 4/5

  • This PR is safe to merge with minimal risk - it's a documentation rewrite that improves clarity and accuracy
  • Score reflects high confidence in a well-structured documentation improvement. Minor uncertainty around two specific details: (1) some fee types (crypto-to-fiat, offramp) and (2) route fee stages (sending, receiving, proxying, refunding, overall) are not documented elsewhere in the codebase, so their accuracy cannot be fully verified from available sources. The overall structure, Mintlify component usage, and cross-references are correct.
  • No files require special attention - this is a single-file documentation update

Important Files Changed

Filename Overview
api-features/fee-breakdowns.mdx Rewrote from conceptual AI-generated content to practical API reference focused on endpoint locations and reconciliation workflows

Last reviewed commit: 6e538d9

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, no comments

Edit Code Review Agent Settings | Greptile

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