[Idea] OpenAPI Generation

[ChuckMoe]

The OpenAPI definition allows to automatically generate clients for different languages. We could publish them with every release. On top of that, we can use these generated clients to test if the OpenAPI definition matches the internal implementation.

Steps

1. Save the OpenAPI definition as a json file
2. Generate clients with the just generated json file
3. Write tests for at least one generated client and run them against the scicat-backend
4. Publish the generated clients

Questions

• Save json file with every startup or only when, for example, an environment variable is set?
• Which clients should we generate?
• Which language to choose for the tests? Typescript, Python, ...?

References

• OpenAPI Generator Action