To get started using the tools developed in this repository have a look at the Documentation.
For more in depth knowledge concerning the development of the repository, take a look at
For reporting an issue, use our issue tracker
These notes are intended for people who want to contribute to the development of this repository.
The different clients for the oSPARC public API are generated using the openapi-generator-tool. The generated files should not be changed manually! Instead proposed changes should be implemented directly on the openapi-generator-repository. See also templates and customization.
See the different clients/<language>/README.md for the workflows for generating the different clients. Here is the workflow which all clients have in common:
- To generate a client one needs two "ingredients":
- The openapi specification which is a json file located in
api/openapi.json. This generated in osparc-simcore and then moved here. - The openapi-generator-tool. The exact docker image of this tool to use is specifies in
scripts/common.Makefile.
- The openapi specification which is a json file located in
This link explains the lifecycle of the osparc client(s) (borrowed from https://www.ibm.com/docs/en/acvfc?topic=manager-product-lifecycle)
Each client (corresponding to a directory clients/<language>) should have a make recipy called install-doc which installs packages needed to generate the documentation for that client, as well as a make recipe docs which generates the documentation. All of these recipes are called from the root's docs recipe, which is what is called when the website is published.
Here is an inexhaustive list which have this repo as a dependency. So changing stuff here might break stuff there:
