grafana / grafana/k6-docs

Update docs for REST API commands

Open
#367 1 comment 0 reactions 0 assignees View on GitHub
Area: OSS Content
Dominant language
Python
Stars
117
Forks
266
Avg merge
4d 11h
Merged PRs (30d)
9

Description

When the new Scenarios API landed in v0.27, the [REST API commands](https://k6.io/docs/misc/k6-rest-api/) were not supported for the different executors, except for `externally-controlled`.

We should document the status of this feature more clearly and update this [outdated blog post](https://k6.io/blog/how-to-control-a-live-k6-test/).

The issue was reported on the [community forum](https://community.k6.io/t/pause-a-ramping-vus-test-execution-then-resume-it-by-terminal-command/2043/2).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the REST API commands page linked in the issue and compare its executor support with the Scenarios API context described here. Update that documentation and the linked blog post so the supported status for different executors is clear; no tests or source files are named.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.