CALM Schema 1.2 - make protocol extensible and optional #1814

rocketstack-matt · 2025-11-18T16:06:21Z

Addresses #1437

Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
📚 Documentation update
🎨 Code style/formatting changes
♻️ Refactoring (no functional changes)
⚡ Performance improvements
✅ Test additions or updates
🔧 Chore (maintenance, dependencies, CI, etc.)

Affected Components

Commit Message Format ✅

Testing

I have tested my changes locally
I have added/updated unit tests
All existing tests pass

Checklist

My commits follow the conventional commit format
I have updated documentation if necessary
I have added tests for my changes (if applicable)
My changes follow the project's coding standards

Copilot

Pull Request Overview

This PR introduces Draft 1437, which makes the CALM protocol field extensible and optional in relationship definitions. The change enables support for emerging protocols (like GraphQL, gRPC) without requiring schema updates, while maintaining backward compatibility with existing CALM models.

Key Changes:

Protocol definition changed from strict enum to anyOf pattern (enum values OR any string)
Protocol property removed from relationship schema (remains optional via additionalProperties: true)
Three example files demonstrating enum protocol, custom string protocol, and no protocol

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
calm/draft/1437/core.json	New draft schema implementing extensible protocol definition and optional protocol property
calm/draft/1437/README.md	Documentation explaining the proposal, rationale, and compatibility impact
calm/draft/1437/prototype/relationship-example-enum.json	Example using predefined enum protocol value (HTTPS)
calm/draft/1437/prototype/relationship-example-with-string.json	Example using custom string protocol value (GraphQL)
calm/draft/1437/prototype/relationship-example-no-protocol.json	Example with no protocol field present

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

calm/draft/1437/core.json

markscott-ms · 2025-11-18T22:39:32Z

calm/draft/1437/core.json

+      ],
+      "additionalProperties": true
+    },
+    "protocol": {


What is the benefit of making this a enum or string, rather than just a string?

Is it to encourage standard capitalization of some common values, and give examples of those common values?

Otherwise it might be an unnecessary complication of the schema definition.

Following the same convention we adopted when we made the same change for node-type

markscott-ms · 2025-11-20T15:44:29Z

Discussed in #1798 .

This PR makes protocol more extensible. It is a non-breaking change.

Change protocol to be just a 'string', but agreed to include in release 1.1.

Add comprehensive documentation for CALM Copilot Chatmode and Voice Mode features to address GitHub issue finos#1755. Changes: - Add copilot-chatmode.md: Complete guide for setting up AI-powered development assistance with GitHub Copilot Chat, including setup, usage, specialized tools, and troubleshooting - Add voice-mode.md: Comprehensive guide for hands-free interaction using VS Code Speech extension, covering installation, microphone setup, usage, best practices, accessibility, and platform-specific instructions for Windows/macOS/Linux - Update index.md: Add links to new Copilot Chatmode and Voice Mode docs - Update using-the-cli.md: Add copilot-chatmode command reference and AI-Powered Development section Resolves: finos#1755

…x sidebar_position Resolves: finos#1755

Resolves: finos#1755

Bumps the npm_and_yarn group with 1 update in the /calm-models directory: [glob](https://github.com/isaacs/node-glob). Updates `glob` from 10.4.5 to 10.5.0 - [Changelog](https://github.com/isaacs/node-glob/blob/main/changelog.md) - [Commits](isaacs/node-glob@v10.4.5...v10.5.0) --- updated-dependencies: - dependency-name: glob dependency-version: 10.5.0 dependency-type: indirect dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <[email protected]>

* fix(deps): update minor updates * chore(deps): update JaCoCo version and enhance dependency grouping in Renovate config --------- Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Matthew Bain <[email protected]> Co-authored-by: rocketstack-matt <[email protected]>

Add experimental CALM Explorer tool for interactive visualization and exploration of FINOS CALM (Common Architecture Language Model) architecture diagrams. Key features: - Interactive graph visualization with ReactFlow - JSON editor with Monaco - GitHub integration for loading CALM files - Support for CALM patterns and nested containers - Dagre-based automatic layout Configuration changes: - Add package-lock.json for CI compatibility - Update workspace configuration for experimental/calm-explorer - Add GitHub Actions workflow for building and testing - Configure proper package naming (@finos/calm-explorer)

…nd add related tests

Co-authored-by: Copilot <[email protected]>

…erience

Co-authored-by: Copilot <[email protected]>

…er CP feedback

The semantic release notes step is failing. Updating to a method that will import the module correctly.

Bumps the npm_and_yarn group with 1 update in the / directory: [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite). Updates `vite` from 5.4.20 to 5.4.21 - [Release notes](https://github.com/vitejs/vite/releases) - [Changelog](https://github.com/vitejs/vite/blob/v5.4.21/packages/vite/CHANGELOG.md) - [Commits](https://github.com/vitejs/vite/commits/v5.4.21/packages/vite) --- updated-dependencies: - dependency-name: vite dependency-version: 5.4.21 dependency-type: direct:development dependency-group: npm_and_yarn ... Signed-off-by: dependabot[bot] <[email protected]>

…rsion

… directly

linux-foundation-easycla · 2025-11-24T16:48:13Z

✅ login: Copilot / name: Copilot (c78d300, da465d8, f7ad8e2, fa9e450)
✅ login: dependabot[bot] / name: dependabot[bot] (9948746, c0f0721)
✅ login: github-actions[bot] / name: github-actions[bot] (ace3140)
✅ login: gkaria / name: Gaurang Karia (263a1f4, 5f5bf0c, 9d28b7a)
✅ login: markscott-ms / name: Mark Scott (672427a, 76e89df, 7c24b23, 9faf3d0, c398f41)
✅ login: pmerrison / name: Paul Merrison (9cde1bb)
✅ login: renovate[bot] / name: renovate[bot] (0c53b44, 0d58d5b, 0e68cb7, 16cdd8d, 1c370b9, 2a4bcaa, 6087536)
✅ login: rocketstack-matt / name: Matthew Bain (0d58d5b, 1fcdf4d, c78d300, da465d8, f7ad8e2, fa9e450, 41a7560, 5cec105, 7d4a6c6, 812ad96, 8311a47, a2e3797, d25841c, d96d224, e882f73)
✅ login: rocketstack-matt / name: rocketstack-matt (0d58d5b)
✅ login: willosborne / name: Will Osborne (2352086, 89b7ecc, a2c74c9)
❌ The email address for the commit (0d58d5b) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

Anything <[email protected]> - it will locate your GitHub user by id part.
Anything <[email protected]> - it will locate your GitHub user by login part.
Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

linux-foundation-easycla · 2025-11-24T16:48:13Z

✅ login: Copilot / name: Copilot (c78d300, da465d8, f7ad8e2, fa9e450)
✅ login: dependabot[bot] / name: dependabot[bot] (9948746, c0f0721)
✅ login: github-actions[bot] / name: github-actions[bot] (ace3140)
✅ login: gkaria / name: Gaurang Karia (263a1f4, 5f5bf0c, 9d28b7a)
✅ login: markscott-ms / name: Mark Scott (672427a, 76e89df, 7c24b23, 9faf3d0, c398f41)
✅ login: pmerrison / name: Paul Merrison (9cde1bb)
✅ login: renovate[bot] / name: renovate[bot] (0c53b44, 0d58d5b, 0e68cb7, 16cdd8d, 1c370b9, 2a4bcaa, 6087536)
✅ login: rocketstack-matt / name: Matthew Bain (0d58d5b, 1fcdf4d, c78d300, da465d8, f7ad8e2, fa9e450, 0d58d5b, 41a7560, 5cec105, 7d4a6c6, 812ad96, 8311a47, a2e3797, d25841c, d96d224, e882f73)
✅ login: willosborne / name: Will Osborne (2352086, 89b7ecc, a2c74c9)
❌ The email address for the commit (0d58d5b) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

Anything <[email protected]> - it will locate your GitHub user by id part.
Anything <[email protected]> - it will locate your GitHub user by login part.
Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

markscott-ms · 2025-11-27T20:25:54Z

Let's get #1872 into main, then sync main into release-1.2 branch, then get this merged in.

Why are there so many files???

feat(calm): make protocol extensible and optional

fa18a9a

Copilot AI review requested due to automatic review settings November 18, 2025 16:06

rocketstack-matt requested a review from a team as a code owner November 18, 2025 16:06

Copilot started reviewing on behalf of rocketstack-matt November 18, 2025 16:06 View session

github-actions bot added the calm label Nov 18, 2025

rocketstack-matt mentioned this pull request Nov 18, 2025

Office Hours - 20 Nov 2025 #1798

Closed

9 tasks

Merge branch 'release-1.1' into schema-proposal-1437

1fcdf4d

Copilot finished reviewing on behalf of rocketstack-matt November 18, 2025 16:08

Copilot AI reviewed Nov 18, 2025

View reviewed changes

calm/draft/1437/core.json Outdated Show resolved Hide resolved

calm/draft/1437/core.json Outdated Show resolved Hide resolved

markscott-ms reviewed Nov 18, 2025

View reviewed changes

aamanrebello previously approved these changes Nov 24, 2025

View reviewed changes

rocketstack-matt and others added 18 commits November 24, 2025 16:33

ci(cli): fix the automated CLI release - prevent duplicate tag creation

d25841c

docs: refactor Voice Mode documentation to focus on CALM usage and fi…

9d28b7a

…x sidebar_position Resolves: finos#1755

docs: update copilot-chatmode and revert sidebar_position on index.md

5f5bf0c

Resolves: finos#1755

feat(cli): update CALM model version and add CLI instructions

a2e3797

ci(cli): release version 1.16.0

ace3140

chore(ci): run the build workflows to release* branches

7c24b23

chore(deps): update dependency vite to v5.4.21 [security]

2a4bcaa

chore(cli): implement static URL mapping for Getting Started assets a…

e882f73

…nd add related tests

Update cli/src/test_helpers/getting-started-url-mapping.ts

f7ad8e2

Co-authored-by: Copilot <[email protected]>

Update cli/src/test_helpers/getting-started-url-mapping.ts

da465d8

Co-authored-by: Copilot <[email protected]>

chore(devenv): update VS Code extensions for improved development exp…

41a7560

…erience

Update .devcontainer/devcontainer.json

fa9e450

Co-authored-by: Copilot <[email protected]>

Update .devcontainer/devcontainer.json

c78d300

Co-authored-by: Copilot <[email protected]>

chore(devenv): remove unnecessary Java extensions from devcontainer p…

812ad96

…er CP feedback

markscott-ms and others added 10 commits November 24, 2025 16:33

Update automated-release.yml

76e89df

The semantic release notes step is failing. Updating to a method that will import the module correctly.

fix(deps): update patch updates

6087536

chore(deps): update security updates

16cdd8d

chore(deps): update semgrep/semgrep docker digest to 73116c3

1c370b9

chore(deps): update actions/checkout digest to 93cb6ef

0e68cb7

chore: update coverage settings to refine exclude and include patterns

d96d224

chore: revert calm-hub-ui downgrade and upgrade calm-explorer vite ve…

8311a47

…rsion

chore(deps): update dependency @semantic-release/github to v12

0c53b44

refactor(calm): update protocol to just be string, target release-1.1…

5cec105

… directly

rocketstack-matt dismissed aamanrebello’s stale review via 5cec105 November 24, 2025 16:47

rocketstack-matt requested review from a team, LeighFinegold, Thels, aidanm3341, grahampacker-ms, jpgough-ms, lbulanti-ms and willosborne as code owners November 24, 2025 16:47

github-actions bot added cli calm-hub The Calm Hub Product shared config docs calm-hub-ui labels Nov 24, 2025

markscott-ms changed the title ~~feat(calm): make protocol extensible and optional~~ CALM Schema 1.2 - make protocol extensible and optional Nov 27, 2025

markscott-ms changed the base branch from release-1.1 to release-1.2 November 27, 2025 20:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CALM Schema 1.2 - make protocol extensible and optional #1814

CALM Schema 1.2 - make protocol extensible and optional #1814

rocketstack-matt commented Nov 18, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

markscott-ms Nov 18, 2025

Uh oh!

rocketstack-matt Nov 20, 2025

Uh oh!

markscott-ms commented Nov 20, 2025

Uh oh!

linux-foundation-easycla bot commented Nov 24, 2025 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Nov 24, 2025

Uh oh!

markscott-ms commented Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

CALM Schema 1.2 - make protocol extensible and optional #1814

Are you sure you want to change the base?

CALM Schema 1.2 - make protocol extensible and optional #1814

Conversation

rocketstack-matt commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Type of Change

Affected Components

Commit Message Format ✅

Testing

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

markscott-ms Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

rocketstack-matt Nov 20, 2025

Choose a reason for hiding this comment

Uh oh!

markscott-ms commented Nov 20, 2025

Uh oh!

linux-foundation-easycla bot commented Nov 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Nov 24, 2025

Uh oh!

markscott-ms commented Nov 27, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

rocketstack-matt commented Nov 18, 2025 •

edited

Loading

linux-foundation-easycla bot commented Nov 24, 2025 •

edited

Loading