Creating services using the rest api always fails with "service name required"
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- api, documentation
Research direction
Review the service-creation REST API examples in the documentation, starting with the curl requests shown in this issue. Compare the documented URL and request fields with the API's required service name, then update the example so it no longer returns “service name required.” Re-run both shown requests to confirm the corrected examples.
Written by the indexing model from the issue text.
Description
Steps to reproduce.
Create a new sprite $SPRITE_NAME
Run the example from the docs:
curl -X PUT
-H "Authorization: Bearer $SPRITE_TOKEN"
-H "Content-Type: application/json"
-d '{"args":["-m","http.server","8000"],"cmd":"python","http_port":8000,"needs":["postgres"]}'
"https://api.sprites.dev/v1/sprites/$SPRITE_NAME/services/$SERVICE_NAME"
Returns "service name required".
Same with basic services
curl -X PUT
-H "Authorization: Bearer $SPRITE_TOKEN"
-H "Content-Type: application/json"
-d '{"name":"testservice","cmd":"/bin/sh","args":["-c","echo hello"],"needs":[]}'
"https://api.sprites.dev/v1/sprites/$SPRITE_NAME/services/$SERVICE_NAME"
Returns "service name required"
- Dominant language
- TypeScript
- Stars
- 51
- Forks
- 4
- Avg merge
- 23h 57m
- 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/sprites-docs
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
superfly/sprites-docs#226 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
superfly/sprites-docs#220 ·
-
superfly/sprites-docs#237 · 1 assignee ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
superfly/sprites-docs#231 ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
superfly/sprites-docs#230 · 2 comments ·
All issues in superfly/sprites-docs
Similar issues
-
clawsweeper:fix-shape-clear clawsweeper:queueable-fix clawsweeper:source-repro impact:ux-friction issue-rating: 🦞 diamond lobster no-stale P3
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
community first-timers-only good first issue hacktoberfest help wanted low hanging fruit up-for-grabs
Difficulty 1/5 Under an hour Newbie friendliness 76/100
-
code-quality refactoring
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
github/gh-aw-firewall#8816 ·
-
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 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
vercel/react-tweet#225 ·