OpenAPI adoption for toolkit's major components

[luismojena]

I would like to propose the adoption of OpenAPI standards for the major components in the toolkit. Aside from the fact that this is an industry-standard, this will also:

• Serve as documentation (can be automatically generated)
• Allow automatic generation of clients and server stubs in different languages
• Change the current specification pages (if you'll want that 😉 )
• Allow the community to better contribute
• Allow the community to grow the ecosystem of libraries and applications

Let me know what you think!

[stefanprodan]

The GitOps Toolkit APIs are an extension to Kubernetes API expressed as Custom Resource Definitions.

We use Kubernetes code generation tools for:

• OpenAPI v3 schemas (example)
• API docs (example)
• Go API client (example)

While we don't intend to provide any clients besides Golang, there are other projects in the Cloud-Native space like Pulumi and AWS CDK8s that allows you to interact with the toolkit API from various languages.