Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Does Having a Valid JSON Schema mean that something is valid CALM? #818

Closed
jpgough-ms opened this issue Jan 23, 2025 · 1 comment
Closed

Comments

@jpgough-ms
Copy link
Member

Support Question

Does Having a Valid JSON Schema mean that something is valid CALM?

A discussion for our office hours as we start to look at some changes that will challenge this question.

@jpgough-ms
Copy link
Member Author

After discussion at #832 and in #848 we have agreed the following:

  • JSON Schema ensures that CALM is structurally correct by enforcing the appropriate schema, however it does not necessarily meant that it is valid calm. Examples of this in calm include naming nodes in relationships is incorrect if the node is not in the architecture.
  • calm validate ensures that the appropriate business logic for CALM is enforced. Where the solution for ensuring valid JSON schema results in a more complex user experience, validating using calm validate is required.

In summary, a document is only valid CALM if it passes both JSON Schema validation and CALM validation via the CLI.

cc/ @finos/architecture-as-code-maintainers

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant