API contracts
Summary
- No formal OpenAPI/Swagger or JSON schema found.
- Contracts inferred from implementation.
Inferred Contracts
HTTP /health
- Response: JSON with
status,uptime,timestamp,version,devices,protocols,memory. - Evidence:
server/server.js:323-366.
WebSocket playoutStates
- Response:
{ type: 'playoutStates', timestamp, data, protocols }. - Evidence:
server/server.js:460-472.
WebSocket getConfig
- Response:
{ type: 'config', data: { settings, servers } }. - Evidence:
server/server.js:415-422.
Recommendations
- Consider publishing a JSON schema for
/healthand WebSocket messages for client stability.
Attestation
# Identityagent_id: audit-api-contractsagent_version: "1.0"protocol_version: "2.0"
# Timingtimestamp: 2026-01-31T17:07:11Zduration_seconds: 180
# Contextgit_ref: e4bb0098264f90d3afc7b5d0f3b5e425d1825761git_branch: mainworking_directory: /Users/david/Documents/GitHub/superdash
# Artefact metadataartefact: API_CONTRACTS.mdphase: 3status: COMPLETE
# Confidence assessmentconfidence: HIGHconfidence_notes: "Contracts derived directly from server implementation."
# Inputs consumed (with integrity hashes)inputs_consumed: - path: server/server.js hash: sha256:4d09f4acde1032a407f67943d0cd93be1fe10b79a9c07aa3b430cf6dd27b31bb
# Commands executedcommands_executed: - seq: 1 cmd: "nl -ba server/server.js | sed -n '320,480p'" exit_code: 0 purpose: "Inspect /health and WebSocket contracts" output_summary: "Inferred response shapes"
# Findings summaryfindings: critical: 0 high: 0 medium: 0 low: 1 info: 1
# Blocking issuesblocking_issues: []
# Handoffhandoff: ready: true next_agents: - report-writer dependencies_satisfied: API_CONTRACTS.md: COMPLETE context_for_next: | No formal API specs; contracts are inferred from server.js.