OrgTJWater/next-tjwater-server
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
v2026.11.12.1
next-tjwater-server/docs/api-style.md
T
jiang b853b61a0b feat(investigation): preserve cumulative reference graphs 
Accumulate investigation paths and preserve failed attempts across rounds. Keep graph annotations separate from execution state, synchronize the API contract, and consolidate documentation.
2026-11-11 19:10:41 +08:00

987 B
Raw Permalink Blame History

TJWater REST API v1

This contract is the public API contract for coordinated TJWater Server, Agent, and Frontend releases. Legacy CLI material is a historical capability reference, not a current runtime integration.

  • Paths use lowercase kebab-case, have no trailing slash, and identify resources rather than handler actions.
  • JSON fields, query parameters, and path parameter names use snake_case.
  • Project-scoped requests use X-Project-Id; network query parameters are not part of the public contract.
  • GET is read-only. Synchronous analysis and simulation requests use POST and clients must not retry them automatically.
  • JSON errors use application/problem+json.
  • The static OpenAPI file and contracts/manifest.json are release artifacts even when production runtime documentation is disabled.

Generate and validate the contract with:

conda run -n server python scripts/export_openapi.py
conda run -n server python scripts/check_openapi.py
Reference in New Issue View Git Blame Copy Permalink