Skip to content

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 /health and WebSocket messages for client stability.

Attestation

# Identity
agent_id: audit-api-contracts
agent_version: "1.0"
protocol_version: "2.0"
# Timing
timestamp: 2026-01-31T17:07:11Z
duration_seconds: 180
# Context
git_ref: e4bb0098264f90d3afc7b5d0f3b5e425d1825761
git_branch: main
working_directory: /Users/david/Documents/GitHub/superdash
# Artefact metadata
artefact: API_CONTRACTS.md
phase: 3
status: COMPLETE
# Confidence assessment
confidence: HIGH
confidence_notes: "Contracts derived directly from server implementation."
# Inputs consumed (with integrity hashes)
inputs_consumed:
- path: server/server.js
hash: sha256:4d09f4acde1032a407f67943d0cd93be1fe10b79a9c07aa3b430cf6dd27b31bb
# Commands executed
commands_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 summary
findings:
critical: 0
high: 0
medium: 0
low: 1
info: 1
# Blocking issues
blocking_issues: []
# Handoff
handoff:
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.