finos / architecture-as-code

"Architecture as Code" (AasC) aims to devise and manage software architecture via a machine readable and version-controlled codebase, fostering a robust understanding, efficient development, and seamless maintenance of complex software architectures
https://calm.finos.org
Apache License 2.0
61 stars 38 forks source link

Validate Examples within Codebase #484

Open Thels opened 1 month ago

Thels commented 1 month ago

https://github.com/finos/architecture-as-code/discussions/482

As part of this discussion, it was found that an example within the code-base isn't valid as it doesn't refer to a pattern with a $schema tag. This is required to perform validations on the file without the user having to be contextually aware of what pattern they were attempting to implement.

Example file; https://github.com/finos/architecture-as-code/blob/main/calm/samples/api-gateway-instantiation.json

This issue is to have a review of all of the examples being stored in source control - ensuring to check for instances where the json files are intended to be incorrect such as;

Thels commented 1 week ago

Add into milestone 1.0 along with #499