From ff911661a491e1fb62803ac4e24eaff722c744cd Mon Sep 17 00:00:00 2001 From: androidlover5842 Date: Wed, 4 Feb 2026 13:11:41 +0530 Subject: [PATCH] docs: enforce manual API_REFERENCE update policy in AGENTS --- AGENTS.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/AGENTS.md b/AGENTS.md index c0107fb..26ec187 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -220,4 +220,8 @@ Access / ops notes (prod) - DB (dev): PostgreSQL `trisolaris` on `192.168.1.53:5432` (see `application-dev.properties` in the repo). - DB access (server): `sudo -u postgres psql -d trisolaris`. - Workflow: Always run build, commit, and push for changes unless explicitly told otherwise. +- API docs policy (mandatory): + - For every API change (`add`, `update`, `delete`, path change, request/response change, role change, validation/error change), update `docs/API_REFERENCE.txt` in the same endpoint-by-endpoint text format already used there. + - Keep each API block in this style: `" API is this one:"` -> `METHOD /path` -> `What it does` -> `Request body` -> `Allowed roles` -> `Error Codes`. + - Script-generated API docs are forbidden. Documentation updates must be manual edits only. - Android workflow note: user always runs Shift+F10 in Android Studio to deploy updates.