Proposal to implement #1083

[rocketstack-matt]

Note: This schema change is following the proposal for #893

If accepted, the following changes will likely be needed:

1. Update Validation Logic

The validation process in shared/src/commands/validate/validate.ts needs to be enhanced to:

• Implement multi-level validation for interface-definition structs
• First validate document structure including interface-definition format
• For each interface-definition, validate its configuration against the schema at interface-definition-url
• Maintain compatibility with legacy interface types

2. Update Spectral Rules

Modify Spectral validation functions in shared/src/spectral/functions/architecture/:

• Update interface-id-exists.ts to extract unique-ids from both interface formats
• Update interface-id-exists-on-node.ts to check references with both formats
• Add new rules to validate interface-definition structure

3. Testing Implementation

• Create test cases for both legacy and new interface formats
• Test interface validation with local and remote schema references
• Ensure validation errors are correctly reported for both formats
• Test backward compatibility with existing CALM models

4. Documentation Updates

• Update CLI documentation to explain the new interface format
• Provide examples of both formats
• Document validation behavior and error reporting
• Create migration guide for users moving to the new format

[jpgough-ms]

More a comment on creating schema proposals, it would be helpful to create the current structure in a first PR - so that the diffs of the change can be viewed more precisely.

[jpgough-ms]

Overall, think this looks good. I've asked a few questions that would be good to clarify before approving

[rocketstack-matt]

More a comment on creating schema proposals, it would be helpful to create the current structure in a first PR - so that the diffs of the change can be viewed more precisely.

Agreed, I realised this when trying to review it myself.