Docs: Create API Documentation for Control Endpoints #94
Description
Description:
The repository lacks internal documentation for its HTTP API endpoints. New developers or users have to read the source code of apis-web to understand how to interact with the system (e.g., how to create a deal or change log levels). The
README.md only points to external PDF specifications.
Goal:
Create a markdown file (API.md) that documents the available HTTP endpoints exposed by apis-web.
Content Requirements
For each endpoint (e.g., /deal, /log, /ui), document:
- Method: (GET/POST)
- URL: The path
- Parameters: Query parameters or JSON body fields (e.g., dealId, amount, unitId)
- Example Request: A curl command or raw HTTP snippet
- Example Response: What the server returns on success/failure
Acceptance Criteria:
- API.md is created in the root or apis-web directory.
- All apis-web handlers are documented.
- A link to API.md is added to the main README.md