API Reference

API references are automatically generated from OpenAPI specifications using the docusaurus-openapi-docs plugin. We override most of the default styling in src/theme to ensure a cleaner and more consistent look across the documentation.

OpenAPI Spec Hosting

We use S3 to host OpenAPI specs for various projects. To keep these specs up to date, the publish-swagger step in our Argo Workflows pipeline is used. This step can be added to any (golang) project that has a swagger.yaml file in its root directory. Once added, the API reference will be available at one of the following URLs:

• https://eventix-docs.s3.eu-west-1.amazonaws.com/internal/<name>
• https://eventix-docs.s3.eu-west-1.amazonaws.com/<name>