Include k6-api status PATCH with info on how to stop test. Resolve #162. #371
Conversation
|
There's a version of the docs published here: https://mdr-ci.staging.k6.io/docs/refs/pull/371/merge It will be deleted automatically in 30 days. |
There was a problem hiding this comment.
A few things should be changed, but I'm wondering why we have hideFromSidebar: true for this documentation? @ppcano
We don't link it from anywhere else AFAICT, and the only way to get to this page is via the search (or web search), so I think we should link it in the left sidebar.
| ```bash | ||
| curl -X PATCH \ | ||
| http://localhost:6565/v1/status \ | ||
| -H 'Content-Type': application/json' \ | ||
| -d '{ | ||
| "data": { | ||
| "type": "status", | ||
| "id": "default", | ||
| "attributes": { | ||
| "stopped": true | ||
| } | ||
| } | ||
| }' |
There was a problem hiding this comment.
There are some unbalanced quotes here (there shouldn't be an end quote after Content-Type), and the alignment is not quite right. Maybe also use two space indent as in the other examples?
See how it's rendered on https://mdr-ci.staging.k6.io/docs/refs/pull/371/merge/es/misc/k6-rest-api/#modify-setup .
There was a problem hiding this comment.
Thanks! I honestly couldn't find this thing in the generated docs and the staging version doesn't have a search, so I planned to keep searching tomorrow. I agree this must definitely be in the sidebar too.
There was a problem hiding this comment.
There are a few internal links on particular features
https://k6.io/docs/using-k6/scenarios/executors/externally-controlled/
https://k6.io/docs/testing-guides/running-large-tests/
We removed it on purpose because the REST API might be deprecated. I think a k6 core team suggested this.
Related issue #367
src/data/markdown/translated-guides/es/07 Misc/04 k6 REST API.md
Outdated
Show resolved
Hide resolved
src/data/markdown/translated-guides/es/07 Misc/04 k6 REST API.md
Outdated
Show resolved
Hide resolved
| @@ -6,8 +6,8 @@ hideFromSidebar: true | |||
| --- | |||
There was a problem hiding this comment.
Why are these changes in the Spanish translated files? You should also do them in the /en/ version, but shouldn't this file be translated @ppcano?
There was a problem hiding this comment.
That was my original mistake - I can't find any of this 'naturally' in the docs, so I went with the markdown file I first found without noticing that it was under the es/ folder - and since it's not translated I didn't notice that until a while after a I committed. I already copied this to the english version (I'll update both with your suggestions).
|
@imiric I pushed the changes you suggested. Thanks for the review! I don't think the 'preview' is building on updates though. @ppcano The spanish page is untranslated, so I just copied my changes verbatim to it. I also removed the |
* master: Adding Grafana Cloud to the Integration list
Include the k6-api PATCH endpoint, with an example of how to use it to stop the running test via the API. Resolve #162.