# Endpoint Documentation

This folder should contain one Markdown file per API endpoint.

Use `template.md` when creating a new endpoint doc.

## Why Endpoint Docs Are Separate

The Python code registers dynamic routes and executes generic schema instructions. The exact behavior of an endpoint comes from S3 schemas, so endpoint documentation must be written from the route/auth/endpoint schemas, not just from Python files.

## Suggested Files

Based on route names referenced in `config.py`, useful endpoint docs may include:

| Endpoint | Suggested doc |
| --- | --- |
| `/api/create-customer` | `create-customer.md` |
| `/api/product-list` | `product-list.md` |
| `/api/merchant-location-list` | `merchant-location-list.md` |
| `/api/upload-document` | `upload-document.md` |
| `/api/customer-details` | `customer-details.md` |
| `/api/cancellation-request` | `cancellation-request.md` |
| `/api/get-status` | `get-status.md` |
| `/api/digio_vkyc` | `digio-vkyc.md` |
| `/api/digio_generate_token` | `digio-generate-token.md` |

This is not a complete route list. The actual route list must come from:

```text
api_wrapper/api/routes.json
```

## Minimum Content For Each Endpoint

Each endpoint doc should include:

- route path and method
- auth mode and IP whitelist behavior
- selected S3 schema paths
- request body or query params
- validation rules
- business rules
- function blocks and state keys
- persistence tables and operations
- response codes and HTTP statuses
- external API calls
- S3 uploads or generated files
- test cases