Skip to content

docs: add netlify/functions API reference + deposit flow Mermaid diagrams#35

Open
zqleslie wants to merge 1 commit into
davz7:mainfrom
zqleslie:fix-stellar-wave-docs-32-33
Open

docs: add netlify/functions API reference + deposit flow Mermaid diagrams#35
zqleslie wants to merge 1 commit into
davz7:mainfrom
zqleslie:fix-stellar-wave-docs-32-33

Conversation

@zqleslie
Copy link
Copy Markdown

Summary

Addresses issue #32 and issue #33 for Stellar Wave 5.

Issue #32 — README for netlify/functions/ ✅

Added netlify/functions/README.md with complete documentation for all 9 Netlify functions:

  • HTTP methods, path mappings (from netlify.toml)
  • Request body / query schema for each endpoint
  • Success response schemas with examples
  • Error codes (4xx / 5xx) with meanings
  • Required environment variables per function
  • Local dev instructions (netlify dev) and .env setup guide
  • Written in English, no live secrets (all placeholders use XXX-REDACTED style)

Issue #33 — SPEI → Stellar deposit flow Mermaid diagram ✅

Added to root README.md:

  1. Mermaid sequenceDiagram — End-to-end deposit flow:
    User → DepositFlow → /api/etherfuse/deposit → Etherfuse API → CLABE → User → SPEI → Etherfuse → Webhook → Supabase → Stellar

  2. Mermaid flowchart — Order state machine:
    createdpending_paymentpayment_receivedcompleted (with failed / cancelled paths)

  3. Bilingual Spanish explanation — Step-by-step paragraph explaining each stage of the deposit flow.

  4. Updated Architecture section — Replaced placeholder tree with full function listing.


Files changed

  • README.md — Added Mermaid diagrams + bilingual explanations
  • netlify/functions/README.md (new) — Complete API reference for all 9 functions

Part of Stellar Wave 5 — May 26 to Jun 2, 2026

@zqleslie zqleslie closed this May 29, 2026
@zqleslie zqleslie force-pushed the fix-stellar-wave-docs-32-33 branch from 0628596 to 1eed26d Compare May 29, 2026 12:11
zqleslie added a commit to zqleslie/MananaSeguro that referenced this pull request May 29, 2026
Merged README.md:
- Combined our enhanced Mermaid diagrams (autonumber, detailed participants)
  with upstream's bilingual intro text
- Updated architecture tree to reflect current netlify/functions (9 functions)
- Maintained consistent style with upstream main

Kept upstream's netlify/functions/README.md (from merged PR davz7#42)

Part of Stellar Wave 5 - issues davz7#32 and davz7#33
@zqleslie zqleslie reopened this May 29, 2026
Merged upstream changes into README.md:
- Kept enhanced Mermaid diagrams (autonumber, detailed participants)
- Incorporated upstream's bilingual intro text
- Updated architecture tree to reflect current netlify/functions (9 functions)
- Maintained consistent style with upstream main

Part of Stellar Wave 5 - issues davz7#32 and davz7#33
@zqleslie zqleslie force-pushed the fix-stellar-wave-docs-32-33 branch from 20c1b87 to 55d2668 Compare May 29, 2026 12:16
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