k6 REST API enhancement

[deeboh]

Feature Description

Hello. Currently the REST API supports the /v1/status uri it returns data json object with runtime parameters for/from the script under execution. the attributes returns contain among other items, vus and vus-max are returned.

I'm looking for a simple way to view other script options such as thresholds, exec, executor, tags, env etc... ultimately my goal will be to provide a poor man's runtime verifications (lint, unit test etc) to enforce use of certain attributes. It would be nice to use the rest api rather than standing up a framework like JEST or others of this type.

for reference here are a couple of community posts - rest api use question, k6 Unit Testing

best

Suggested Solution (optional)

No response

Already existing or connected issues / PRs (optional)

No response

[olegbespalov]

Hi @deeboh !

Sorry for the late response 😢

Honestly, we have no plans to extend the existing Rest API v1. and there are some plans for its deprecation #995. Moreover, we see some task on our plate (like distributed execution #3218) that also requires API changes, and that will probably be the best time to do that.

However, if you want to contribute and open a PR that won't be big enough, we could consider it. The other possible way is to create the xk6 extension that could start another HTTP server and provide the details you need.

Hope that somehow answers and maybe even helps 🤞