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://finos.github.io/architecture-as-code/
Apache License 2.0
54 stars 25 forks source link

Publish CALM to SchemaStore #5

Open rocketstack-matt opened 9 months ago

rocketstack-matt commented 9 months ago

Feature Request

Description of Problem:

We want to make it as easy as possible for people to use the CALM manifest, ideally developers IDEs would automatically recognise Architecture as Code manifests and apply autocomplete and validation.

Potential Solutions:

SchemaStore is a commonly adopted mechanism for publishing schemas, being well integrated to many common tools like IntelliJ and VS Code. Propose we start publishing our manifest via SchemaStore (details here).

Other potential options would be to simply self host (currently doing this and versioning via tags) but this provides less integration.

Budlee commented 7 months ago

I like the ideal of *.calm.(json/yaml/yml) as our format.

Budlee commented 6 months ago

We can submit a copy, however, I would have thought that we keep self hosting until we are ready with V1 that is agreed upon and then we submit it to the JSON Schema Store. Therefore I would think we close this and comeback to this question later down the line

rocketstack-matt commented 6 months ago

There is a remote hosting option, tbh I think that may be best even long term, it can even support multiple versions so would just mean an update to schemastore each time we add a new draft.

willosborne commented 2 months ago

I think we should consider removing this from the April milestone (which needs closing) as we aren't planning to do this quite yet given that we don't have a v1 yet.