When can we expect a stable version of the REST API?

[seeljugh]

Hi!

Devlake comes with a REST API and /api/swagger/index.html provides documentation and a Swagger/OpenAPI 2.0 specification for it. The API itself is currently version 0.1:

I don't see the REST API mentioned on the public roadmap nor have I been able to find any further information about this in other issues, discussions, or in Slack.

This makes it hard to know if it's worth building something (a Terraform provider in my case, since the official provider seems stale) based on the current API or if I should wait if something stable can be expected soon.

[dosubot[bot]]

Hey @seeljugh! I'm here to help you with any bugs, questions, or contributions you have. Let's tackle this together!

I couldn't find any specific information about when a stable version of the REST API will be released. However, there was a related closed issue about API versioning, which might be of interest: API versionize ^[1]. This issue might provide some context or insights into the development and versioning plans for the API.

If you're considering building something like a Terraform provider, it might be worth keeping an eye on updates to the API documentation or any new issues or discussions that might arise regarding API stability and versioning.

To continue talking to Dosu, mention @dosu.

[seeljugh]

The linked issue is a feature request for a stable API for the 1.0 milestone/the 1.0.0 release but it didn't receive any comments and was automatically closed after a bit over two months. So unfortunately it didn't shed much more light on things.

[klesh]

Apologies for the delayed response.

The API itself is quite stable at this point, and I don't anticipate many breaking changes moving forward. However, the Swagger documentation appears to need improvement, but it seems there isn't currently anyone incentivized to work on it.

I suggest proceeding with your implementation and proposing any necessary changes to the Swagger documentation via PRs or Issues. Your contributions would be greatly appreciated!