bybrooklyn/openbitdo
1
0
Fork 0
mirror of https://github.com/bybrooklyn/openbitdo.git synced 2026-03-19 04:12:56 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
da09094d3e8d2ac2026827c7a0b24bd1af7864ee
openbitdo/process/dirtyroom_dossier_schema.md

686 B
Raw Blame History

Dirty-Room Dossier Schema

Each dossier is a TOML file that captures sanitized protocol evidence for one PID and one operation group.

Required Fields

  • dossier_id
  • pid_hex
  • operation_group
  • command_id
  • request_shape
  • response_shape
  • validator_rules
  • retry_behavior
  • failure_signatures
  • evidence_source
  • confidence
  • requirement_ids
  • state_machine
  • runtime_placeholder
  • hardware_placeholder

Optional Fields

  • class_family
  • notes

Authoring Rule

Prefer short, structure-level descriptions over long prose. The dossier should be good enough to guide clean implementation and testing without embedding dirty-room source text.