Create an OpenAPI spec for the data Backend is returning

[aliok]

Possible benefits:

• Generate JS interfaces from the schema (means, one source of truth for the structure of the data being transferred)
• Backwards compatibility

Tasks:

• The schema should be defined based on https://github.com/knative-extensions/backstage-plugins/blob/408beed6455b648286e4873647a859fd150cdd94/backends/pkg/reconciler/eventmesh/handler.go#L33-L41
• Golang structs should be generated based on that
• Typescript interfaces should be generated based on that
• (optional) The schema should be served in the Golang server
• Docs (like Swagger) should be generated for the Golang server
• (optional) Define API versions (v1, v2) for different versions of the endpoint

Notes:

• Execution on code generation should be scripted (Shell script) and the script should be placed under /hack directory)
• Generated code should be checked in

Extended tasks:

• CI (GitHub actions) should check if the code generation was run (basically, in a separate action, check out the code, check run the code generation, check if there's any Git diff)
• (optional) Prow needs to do this check too

[aliok]

@pierDipi what did you have in mind about the backwards compatibility here?

[pierDipi]

Generally as the backend needs to be able to work with multiple frontend versions, having a clear "contract" documented and evolving as we make change will make clear if a given change is both backward and forward compatible

[github-actions[bot]]

This issue is stale because it has been open for 90 days with no activity. It will automatically close after 30 more days of inactivity. Reopen the issue with /reopen. Mark the issue as fresh by adding the comment /remove-lifecycle stale.

[aliok]

/remove-lifecycle stale

[ayushrakesh]

@aliok I want to work on this issue, need some help. How to go forward?