Server and Client Go code is generated from the OpenAPI definition by oapi-codegen.

Run the following command to generate the code, from the root folder:

oapi-codegen --config=spec/api/schemas.cfg.yaml spec/api/schemas.yaml
oapi-codegen --config=spec/api/harvester.cfg.yaml spec/api/harvester.yaml
oapi-codegen --config=spec/api/management.cfg.yaml spec/api/management.yaml

Run the following command to have a live view of the API documentation:

make api-doc

This will grab the OpenAPI api.yaml file and generate a website for exploring and testing the API. Further changes in your API definition file can be reloaded by refreshing the website (it may require you to hard-refresh to avoid caching issues). The REST API documentation will be available in your browser at http:https://localhost:8000.

There are a few make targets available to test the code:

• make test: Runs all tests.
• make coverage: Runs all unit tests and reports back test coverage. More details can be found in the file ./out/coverage/index.html.