k6 icon indicating copy to clipboard operation
k6 copied to clipboard

k6 REST API v2

Open olegbespalov opened this issue 1 year ago • 1 comments

What?

Our current version of the REST API hasn't been touched for a long time. At some point we'd like to improve it (a better API design, remove unnecessary dependencies, etc) and took into account the latest state like distributed execution.

For now this is blocked by the #140

### Tasks
- [ ] Suggest a API proposal (design doc) for the v2
- [ ] https://github.com/grafana/k6/issues/995
- [ ] https://github.com/grafana/k6/issues/3239

Why?

We believe that the current API could be better.

olegbespalov avatar Dec 11 '23 08:12 olegbespalov

In https://github.com/grafana/k6/issues/3583 discussion, we set the hypothesis that k6 doesn't need a real HTTP API v2 after we have implemented native distributed execution. Most of the current endpoints cover use cases useful before #1007 or the absence of the native distribution execution.

So, potentially, v2 means only to drop the endpoints from v1 that could be useless after we have introduced native distributed execution. As we don't have specific endpoints that we are considering to add. At least at the time I'm writing.

Still, it remains all the work required in terms of refactoring. But it may not strictly require the bump of the version.

codebien avatar Feb 15 '24 13:02 codebien