š¦ TEMPLATE/ Folder Structure
TEMPLATE/
āāā README.md
āāā TemplateZoneExtension.schema.json
āāā TemplateFieldSampleExtension.schema.json
āāā TemplateNodeDescriptorExtension.schema.json
āāā TemplateAlertExtension.schema.json
āāā TemplateRouteExtension.schema.json
š TEMPLATE/README.md#
RSADI Domain Extension Template#
How to Create a New RSADI/RTTāInside Domain Module#
This folder provides a boilerplate template for creating new RSADI domain
extensions. Copy this folder, rename it (e.g., rtt-atc/, rtt-deepsea/,
rtt-space/), and update the schema files to match your domain.
All extensions MUST follow these rules:
1. Core Invariants#
- Do not modify RSADI Core schemas.
- All domain fields MUST be added under
extensions.<domain>. - Extensions MUST remain optional so core validators still pass.
- Use JSON Schema Draft 2020ā12.
- Use SI units, ISOā8601 timestamps, and UUIDv4 IDs.
2. Schema Naming Convention#
Each extension schema follows:
<Domain><CoreObject>Extension.schema.json
Examples:
ATCZoneExtension.schema.jsonDeepSeaFieldSampleExtension.schema.jsonSpaceAlertExtension.schema.json
3. How to Use This Template#
- Copy this folder.
- Rename it to your domain:
rtt-atc/ rtt-deepsea/ rtt-space/ rtt-robotics/ - Replace all
"template"identifiers with your domain name. - Add domaināspecific fields inside the
extensions.<domain>object. - Validate using any JSON Schema validator.
- Add a README describing your domain semantics.
4. Files in This Template#
-
TemplateZoneExtension.schema.json
Adds domain metadata toResonanceZoneState. -
TemplateFieldSampleExtension.schema.json
Adds domain sensor data toResonanceFieldSample. -
TemplateNodeDescriptorExtension.schema.json
Adds domain metadata toNodeDescriptor. -
TemplateAlertExtension.schema.json
Adds domaināspecific alert fields. -
TemplateRouteExtension.schema.json
Adds domaināspecific routing metadata.
5. Example Usage#
{
"zone_id": "urn:rtt:zone:example:sector_7",
"clarity_score": 180,
"extensions": {
"example": {
"custom_field": 42
}
}
}6. Notes#
- Keep domain logic out of the core.
- Keep schemas small, focused, and typed.
- Use
additionalProperties: trueonly inside extension blocks. - Document all domain semantics in your domain README.
Happy extending ā and welcome to the RSADI ecosystem.
šÆ What This Gives You#
This TEMPLATE folder:
- standardizes how new domains are added
- prevents contributors from breaking core invariants
- accelerates onboarding
- ensures every domain follows the same structure
- keeps RSADI clean, modular, and futureāproof
If you want, I can also generate a TEMPLATE RFC skeleton so new domains can publish their own RFCs with zero friction.
