architecture-as-code
architecture-as-code copied to clipboard
finos
Publish CALM to SchemaStore
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).
- We should decide whether we will contribute a copy of our schema into the SchemaStore repo or set it up as remotely hosted.
- Suggest we agree a recommended file suffix (e.g. *.calm.json, *.calm.yaml, *.calm.yml) which will provide the simplest integration with the schema without developers needing to configure their IDEs.
Other potential options would be to simply self host (currently doing this and versioning via tags) but this provides less integration.
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
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.
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.
Superseded by publication to our our hosting service - http://calm.finos.org/draft