02. File Format Basics
This chapter defines what makes a file a RUML file: its encoding, the fields every root object carries, and the rules for versioning, integrity, and identifiers. The data model those fields describe follows in Chapter 3.
- 2.1 General Properties — Encoding, JSON well-formedness, file extensions
- 2.2 File Structure Overview — The root object:
$format,$specVersion,metadata,rulemap - 2.3 Versioning — Spec version and document version, and how they differ
- 2.4 Integrity Assurance — Hash algorithms and canonical representation
- 2.5 Identifier System — LexIDs as map keys, UUIDs as global identifiers
- 2.6 File Validation — The checks a validator performs, and in what order