Issue with the "Machines" doc
Nobody has claimed this yet.
Assessment
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Newbie friendliness
- 65/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Update machines/api/machines-resource.html.markerb, which documents the Machines /stop endpoint. Compare the documented optional parameters with the reported 400 response when they are omitted, then revise the endpoint documentation so its required request behavior is accurate. Done means the page no longer implies that an invalid parameter-free request succeeds.
Written by the indexing model from the issue text.
Description
I found an issue with this document.
Title: Machines
Location: https://fly.io/docs/machines/api/machines-resource/
Source: https://github.com/superfly/docs/blob/main/machines/api/machines-resource.html.markerb
Describe the issue
It seems that the /stop endpoint requires the optional parameters listed. If they are omitted you get a parse error returned from the server.
Additional info
Error returned: {"error":"json: cannot unmarshal array into Go value of type main.stopRequest"}
Error returned via CURL: HTTP/1.1 400 Bad Request
content-length: 0
date: Tue, 19 Aug 2025 06:35:20 GMT
- Dominant language
- HTML
- Stars
- 128
- Forks
- 1.1k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 12
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from superfly/docs
-
Difficulty 1/5 Under an hour Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 35/100
-
feature
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 3/5 1-2 days Newbie friendliness 62/100
-
Difficulty 1/5 Under an hour Newbie friendliness 35/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
getgrav/grav-plugin-api#45 ·
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·