Use of undocumented query parameters `filter` and `only_ids` in `/images/json` route
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.2k
- Forks
- 1.7k
- Avg merge
- 13d 8h
- Merged PRs (30d)
- 2
Description
The SDK passes the following query parameters to the /images/json route:
https://github.com/docker/docker-py/blob/master/docker/api/image.py#L83
'filter': name,
'only_ids': 1 if quiet else 0,
'all': 1 if all else 0,
The filter parameter has been deprecated since 1.13 and will be removed in v1.41 of the engine API.
The only_ids parameter is not defined at all by the engine API.
I suggest to rename filter to filters and to remove only_ids altogether.
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
Start in docker/api/image.py around the image-list request at line 83 and compare its parameters with the Docker Engine API’s /images/json route. Update the request to use the documented filters parameter and remove only_ids, then verify that image listing still handles the existing name, quiet, and all inputs correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, python
- Domain
- api
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100