Update Documentation (both in swagger and RST) to make it really clear how to use the query parameter based id for blobs.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
I also mentioned to @MikeNeilson that i'm not sure why we have to use
/blobs/ignored?blob-idinstead of just/blobs?blob-idand catch when blob-id is provided to the getAll method? Might be a limitation of Javalin?Ok I totally missed this. It does work if you have
/blobs/ignored?blob-id. Someone can close this, but I would argue it's not the most intuitive for a user.
Originally posted by @msweier in #1545
Instructions for blobs with / in the name require additional clarity.
Contributor guide
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.
Research direction
Locate the blob endpoint documentation in the Swagger definition and RST files, then read the surrounding instructions for query-parameter IDs. Clarify how to request blobs whose names contain /, including the /blobs/ignored?blob-id form, and update both documentation sources so the usage is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100