# API Wrapper Documentation

Start here when working on this service.

## Reading Order

1. `overview.md` for the service summary.
2. `architecture.md` for the request lifecycle and component responsibilities.
3. `setup.md` for local/container runtime requirements.
4. `schemas.md` for S3 schema structure and review rules.
5. `operations.md` and `key-resolution.md` for schema authoring details.
6. `database.md` for persistence behavior.
7. `integrations/` for external services.
8. `runbook.md` for debugging and release checks.
9. `maintenance.md` for how to keep documentation updated.

## Important Point

This repository does not contain the full endpoint contract. Endpoint behavior depends on S3 schemas. Endpoint-specific docs should be created under `documentation/endpoints/` using `endpoints/template.md`.

## Files

| File | Purpose |
| --- | --- |
| `overview.md` | High-level service overview |
| `architecture.md` | Runtime flow and component map |
| `setup.md` | Environment variables, local run, Docker run |
| `schemas.md` | Route/auth/endpoint schema guide |
| `operations.md` | Supported schema operations |
| `key-resolution.md` | `$request`, `$env`, `$auth`, `$token`, state, and components |
| `database.md` | MySQL query and persistence behavior |
| `runbook.md` | Debugging, common failures, release checklist |
| `maintenance.md` | Documentation update rules |
| `endpoints/template.md` | Template for documenting each API endpoint |
| `integrations/s3.md` | S3 schema and upload behavior |
| `integrations/karza.md` | Karza bill verification and Aadhaar masking |
| `integrations/pirimid.md` | Pirimid document upload |
| `integrations/encryption.md` | PHP-backed encryption/decryption |