browser-emulator: add OpenAPI docs

Author: ivchicano

AGENTS.md

@@ -178,6 +178,17 @@ When modifying browser-emulator code:
 - Update `AGENTS.md` if new commands, build steps, or conventions are introduced
 - Document new configuration options in README or docs/
 
+#### API Documentation (browser-emulator)
+
+The browser-emulator exposes a REST and WebSocket API used by:
+- loadtest-controller
+- Client websites in `public/` and `public-lk/`
+
+When adding, removing, or modifying API endpoints:
+
+1. **Update `docs/openapi.yaml`** with the new/changed endpoint and schema
+2. **Regenerate HTML docs**: Run `pnpm run docs` to update `docs/index.html`
+
 ### 5. Pre-commit Checklist
 
 Before finalizing any task:

browser-emulator/README.md

@@ -8,6 +8,21 @@ This app provides a simple **REST API** that will be used by **loadtest-controll
 
 This services also is listening for a **WebSocket communication**. It will send information from the clients to the loadtest-controller.
 
+## API Documentation
+
+The REST and WebSocket APIs are documented in the following files:
+
+- **OpenAPI spec**: [docs/openapi.yaml](docs/openapi.yaml)
+- **HTML documentation**: [docs/index.html](docs/index.html)
+
+You can view the HTML docs directly in a browser or host them statically. For GitHub integration, you can use [raw.githubusercontent.com](https://raw.githubusercontent.com) to serve the HTML file.
+
+To regenerate the docs after changes to the API:
+
+```bash
+pnpm run docs
+```
+
 # Browser Emulator development
 
 ## Development Requirements and Constraints