Skip to content

feat(docs): link the api_refs#260

Merged
prajjwalkumar17 merged 7 commits intomainfrom
feat/debit-routing
Apr 25, 2026
Merged

feat(docs): link the api_refs#260
prajjwalkumar17 merged 7 commits intomainfrom
feat/debit-routing

Conversation

@prajjwalkumar17
Copy link
Copy Markdown
Member

@prajjwalkumar17 prajjwalkumar17 commented Apr 25, 2026

This pull request updates documentation to clarify the product positioning and improve API reference usability. The main focus is on making the README more precise about the Decision Engine's capabilities and updating API documentation links for better navigation.

README improvements:

  • Refined the product description and tagline to emphasize rule-based, Rust implementation, and success-rate-based routing. Also clarified the routing control plane concept and operational surfaces. [1] [2] [3] [4]
  • Replaced the "Performance at a Glance" section with a more detailed breakdown of operational surfaces, such as dashboard, API reference, analytics storage, and deployment options.

API documentation enhancements:

  • Updated all API endpoint links in docs/api-reference.md to use relative .mdx paths instead of absolute URLs. This improves compatibility with the documentation site and ensures correct navigation.
  • Fixed the API Examples link to point to the correct relative path.

@prajjwalkumar17 prajjwalkumar17 self-assigned this Apr 25, 2026
Copilot AI review requested due to automatic review settings April 25, 2026 22:34
Comment thread website/src/components/pages/OverviewPage.tsx Fixed
Comment thread website/src/components/pages/OverviewPage.tsx Fixed
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR expands the Decision Engine documentation by adding a structured “API Examples” section and aligning docs/navigation to new endpoint families, while also updating the dashboard + backend to support merchant debit-routing flag management, richer analytics/audit filtering, and improved auth/onboarding flows.

Changes:

  • Add Mintlify “API Examples” (/api-refs/*) pages and update docs navigation/routes to link them alongside the OpenAPI “API Overview”.
  • Add merchant debit-routing feature-flag API + dashboard surfaces, plus analytics/audit support for routing_approach filtering.
  • Rework dashboard auth/onboarding, API base-path handling, and UI layout/analytics UX; update Cypress coverage accordingly.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

Show a summary per file
File Description
website/vite.config.ts Changes Vite base path and adds /decision-engine-api proxy rewrite support.
website/src/vite-env.d.ts Adds typed Vite env vars for API base path / tenant / feature header.
website/src/types/api.ts Updates API typings (nullable fields, debit routing output, audit routing_approach).
website/src/store/authStore.ts Adds hydration flag and merchant list persistence updates.
website/src/pages/AuthPage.tsx Revamps login/signup UX + onboarding flow integration.
website/src/main.tsx Adds dev redirect for 127.0.0.1 → localhost; wraps app boot.
website/src/lib/api.ts Introduces API base-path prefixing, feature header, richer error messages.
website/src/hooks/useDebitRoutingFlag.ts New SWR hook for merchant debit-routing flag read/update.
website/src/components/pages/RoutingHubPage.tsx New “Routing Hub” posture UI + debit flag integration.
website/src/components/pages/OverviewPage.tsx Adds debit routing readiness + route-hit driven “Primary traffic path”.
website/src/components/pages/DebitRoutingPage.tsx Switches to flag-toggle UI (removes unsupported config editing).
website/src/components/pages/AnalyticsPage.tsx Updates analytics UI/refresh behavior, filters UI, and labeling.
website/src/components/layout/TopBar.tsx Adds merchant switcher dropdown and switch-merchant call.
website/src/components/layout/Sidebar.tsx Moves theme toggle into sidebar footer.
website/src/components/layout/AuthGuard.tsx Adds hydration gating + avoids logout on non-auth transient errors.
website/src/components/layout/AppShell.tsx Adjusts app shell padding/max-width layout.
website/src/App.tsx Adds /signup route and onboarding route.
website/dist/index.html Updates built asset paths for new base URL.
src/routes/merchant_account_config.rs Adds GET debit-routing flag endpoint + shared config-name helper.
src/routes/decide_gateway.rs Records routing_approach more consistently for analytics on errors.
src/routes/analytics.rs Adds routing_approach and exclusion query params for audit endpoints.
src/decider/gatewaydecider/types.rs Adds Display impl for RankingAlgorithm string values.
src/config.rs Derives Default for AnalyticsConfig and removes manual impl.
src/app.rs Wires new GET /merchant-account/:id/debit-routing route.
src/analytics/models.rs Extends audit query/response with routing_approach filters/field.
src/analytics/clickhouse/metrics/audit_summaries.rs Adds raw summary fragment path for routing_approach filtering + exact lookup improvements.
src/analytics/clickhouse/filters.rs Adds ClickHouse filters for routing_approach and debit-routing fallback matching in details.
src/analytics/clickhouse/endpoints/payment_audit.rs Returns routing_approach in response and tweaks selected lookup behavior.
nginx/nginx.conf Updates docs route matching for Mintlify + keeps /dashboard/ SPA serving.
helm-charts/README.md Documents analytics (Kafka/ClickHouse) Helm values and example config.
docs/setup-guide-postgres.md Updates Postgres compose instructions.
docs/mint.json Adds “API Examples” group, operations pages, and expands OpenAPI endpoint grouping.
docs/local-setup.md Updates local dashboard URL and documents /api-refs/api-ref.
docs/introduction.mdx Updates endpoint list + dashboard route list + doc links.
docs/dual-protocol-layer.md Fixes links to API overview/examples.
docs/dashboard-guide.mdx Updates dashboard guide route list + hosting notes + links.
docs/configuration.md Fixes API reference links and adds API examples link.
docs/clickhouse-analytics.mdx Adds local compose version notes.
docs/api-refs/update-score-legacy.mdx Adds legacy /update-score curl example page.
docs/api-refs/update-gateway-score.mdx Improves example and notes; adds AUTH_HEADER.
docs/api-refs/success-rate-config-update.mdx Updates curl example and response shape.
docs/api-refs/success-rate-config-get.mdx Updates curl example and response shape.
docs/api-refs/success-rate-config-delete.mdx Updates curl example and response shape.
docs/api-refs/success-rate-config-create.mdx Updates curl example and response shape.
docs/api-refs/routing-volume-split-example.mdx Updates volume split example payload shape + AUTH_HEADER.
docs/api-refs/routing-single-connector-example.mdx Updates single connector example + AUTH_HEADER + algorithm_for.
docs/api-refs/routing-priority-example.mdx Updates priority-list example + AUTH_HEADER + algorithm_for.
docs/api-refs/routing-hybrid.mdx Adds /routing/hybrid curl example page.
docs/api-refs/routing-algorithm-list.mdx Updates list example + adds response snippet.
docs/api-refs/routing-algorithm-list-active.mdx Updates list-active example + adds response snippet.
docs/api-refs/routing-algorithm-evaluate.mdx Updates evaluate example to current request/response shape + AUTH_HEADER.
docs/api-refs/routing-algorithm-create.mdx Replaces long advanced example with clearer priority example + response.
docs/api-refs/routing-algorithm-activate.mdx Adds AUTH_HEADER and response snippet.
docs/api-refs/routing-advanced-example.mdx Adds advanced rule tree curl example page.
docs/api-refs/merchant-debit-routing.mdx Adds debit-routing flag curl examples.
docs/api-refs/merchant-account-get.mdx Updates example and adds AUTH_HEADER.
docs/api-refs/merchant-account-delete.mdx Updates example and response shape + AUTH_HEADER.
docs/api-refs/merchant-account-create.mdx Updates example to include admin secret + richer response shape.
docs/api-refs/health-check.mdx Expands to liveness/readiness/diagnostics examples.
docs/api-refs/elimination-config-update.mdx Updates elimination config example + AUTH_HEADER + response.
docs/api-refs/elimination-config-get.mdx Updates elimination config example + AUTH_HEADER + response.
docs/api-refs/elimination-config-delete.mdx Updates elimination delete example + AUTH_HEADER + response.
docs/api-refs/elimination-config-create.mdx Updates elimination create example + AUTH_HEADER + response.
docs/api-refs/decision-gateway-legacy.mdx Adds legacy /decision_gateway curl example page.
docs/api-refs/decide-gateway-sr-based.mdx Updates SR decide-gateway example and response fields.
docs/api-refs/decide-gateway-pl-based.mdx Adds PL routing decide-gateway example page.
docs/api-refs/decide-gateway-hybrid-routing.mdx Adds hybrid routing decide-gateway example page.
docs/api-refs/decide-gateway-debit-routing.mdx Updates debit routing decide-gateway example and response fields.
docs/api-refs/config-endpoints.mdx Adds curl examples for routing keys + SR dimension config.
docs/api-refs/auth-and-onboarding.mdx Adds auth/onboarding/switch-merchant curl examples.
docs/api-refs/api-ref.mdx Replaces “Curl API References” with an “API Examples” route map.
docs/api-refs/api-keys.mdx Adds API key create/list/revoke curl examples.
docs/api-refs/analytics-endpoints.mdx Adds analytics endpoint curl examples and filter notes.
docs/api-reference1.md Deprecates old page and points to new API overview/examples.
docs/api-reference/endpoint/updateMerchantDebitRouting.mdx Adds OpenAPI endpoint page for POST debit-routing flag.
docs/api-reference/endpoint/switchMerchant.mdx Adds OpenAPI endpoint page for switch-merchant.
docs/api-reference/endpoint/signup.mdx Adds OpenAPI endpoint page for signup.
docs/api-reference/endpoint/revokeApiKey.mdx Adds OpenAPI endpoint page for revoke API key.
docs/api-reference/endpoint/onboardMerchant.mdx Adds OpenAPI endpoint page for onboarding merchant.
docs/api-reference/endpoint/me.mdx Adds OpenAPI endpoint page for auth/me.
docs/api-reference/endpoint/logout.mdx Adds OpenAPI endpoint page for logout.
docs/api-reference/endpoint/login.mdx Adds OpenAPI endpoint page for login.
docs/api-reference/endpoint/listUserMerchants.mdx Adds OpenAPI endpoint page for listing user merchants.
docs/api-reference/endpoint/listRoutingRules.mdx Fixes OpenAPI param name from {merchantId}{created_by}.
docs/api-reference/endpoint/listApiKeys.mdx Adds OpenAPI endpoint page for listing API keys.
docs/api-reference/endpoint/legacyUpdateScore.mdx Adds OpenAPI endpoint page for legacy update-score.
docs/api-reference/endpoint/legacyDecisionGateway.mdx Adds OpenAPI endpoint page for legacy decision endpoint.
docs/api-reference/endpoint/hybridRouting.mdx Adds OpenAPI endpoint page for routing/hybrid.
docs/api-reference/endpoint/healthReady.mdx Adds OpenAPI endpoint page for readiness.
docs/api-reference/endpoint/healthDiagnostics.mdx Adds OpenAPI endpoint page for diagnostics.
docs/api-reference/endpoint/getRoutingConfig.mdx Adds OpenAPI endpoint page for config/routing-keys.
docs/api-reference/endpoint/getMerchantDebitRouting.mdx Adds OpenAPI endpoint page for GET debit-routing flag.
docs/api-reference/endpoint/createApiKey.mdx Adds OpenAPI endpoint page for create API key.
docs/api-reference/endpoint/configSrDimension.mdx Adds OpenAPI endpoint page for config-sr-dimension.
docs/api-reference/endpoint/analyticsRoutingStats.mdx Adds OpenAPI endpoint page for analytics routing stats.
docs/api-reference/endpoint/analyticsPreviewTrace.mdx Adds OpenAPI endpoint page for preview trace.
docs/api-reference/endpoint/analyticsPaymentAudit.mdx Adds OpenAPI endpoint page for payment audit.
docs/api-reference/endpoint/analyticsOverview.mdx Adds OpenAPI endpoint page for analytics overview.
docs/api-reference/endpoint/analyticsLogSummaries.mdx Adds OpenAPI endpoint page for log summaries.
docs/api-reference/endpoint/analyticsGatewayScores.mdx Adds OpenAPI endpoint page for gateway scores.
docs/api-reference/endpoint/analyticsDecisions.mdx Adds OpenAPI endpoint page for analytics decisions.
docs/api-reference.md Expands API overview to include new endpoint families and correct links.
cypress/support/commands.js Adds Cypress helpers for debit-routing flag GET/POST.
cypress/e2e/ui/decision-explorer.cy.js Adds decision explorer debit routing UI coverage.
cypress/e2e/ui/debit-routing-page.cy.js Adds UI test for toggling debit routing flag.
cypress/e2e/ui/auth-page.cy.js Adds signup persistence and duplicate-email flow tests.
cypress/e2e/ui/analytics-page.cy.js Updates analytics UI assertions (but needs further updates for new controls).
cypress/e2e/api/merchant-crud.cy.js Adds API coverage for debit-routing flag read/update + 404 case.
README.md Updates compose profile instructions and links to new API docs pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@prajjwalkumar17 prajjwalkumar17 merged commit b317698 into main Apr 25, 2026
14 checks passed
@prajjwalkumar17 prajjwalkumar17 deleted the feat/debit-routing branch April 25, 2026 22:40
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.

3 participants