Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

swagger type mismatch for the /libpod/images/{name:.*}/tree endpoint #9578

Closed
TristanCacqueray opened this issue Mar 2, 2021 · 5 comments · Fixed by #10365
Closed

swagger type mismatch for the /libpod/images/{name:.*}/tree endpoint #9578

TristanCacqueray opened this issue Mar 2, 2021 · 5 comments · Fixed by #10365
Assignees
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.

Comments

@TristanCacqueray
Copy link
Contributor

Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)

/kind bug

Description

The documentation https://docs.podman.io/en/latest/_static/api.html#operation/libpodImageTree indicates the /libpod/images/{name:.*}/tree endpoint should return a LibpodImageTreeResponse object, but the actual response is different.

Steps to reproduce the issue:

  1. Query the /libpod/images/fedora/tree endpoint

Describe the results you received:

The endpoint returns:

{
    "Tree": "Image ID: 9f2a56037643\nTags:     [registry.fedoraproject.org/fedora:latest]\nSize:     182.3MB\nImage Layers\n\u2514\u2500\u2500  ID: d9e1d1e08de2 Size: 182.3MB Top Layer of: [registry.fedoraproject.org/fedora:latest]\n"
}

Describe the results you expected:

The endpoint should have returned the documented LibpodImageTreeResponse object, e.g:

{
  "id": "fedora",
  "layers": [{"..."}],
  "..."
}
@openshift-ci-robot openshift-ci-robot added the kind/bug Categorizes issue or PR as related to a bug. label Mar 2, 2021
@github-actions
Copy link

github-actions bot commented Apr 2, 2021

A friendly reminder that this issue had no activity for 30 days.

@rhatdan
Copy link
Member

rhatdan commented Apr 5, 2021

@TristanCacqueray Could you open a PR to fix this?

@TristanCacqueray
Copy link
Contributor Author

Should the documentation be changed to "string" or should the response be adapted to match the existing documentation?

@github-actions
Copy link

github-actions bot commented May 7, 2021

A friendly reminder that this issue had no activity for 30 days.

@rhatdan
Copy link
Member

rhatdan commented May 7, 2021

Let's just fix the documentation

@jwhonce jwhonce self-assigned this May 17, 2021
jwhonce added a commit to jwhonce/podman that referenced this issue May 21, 2021
* Remove all Types no longer referenced, they were never used

A future API breaking version of Podman API, may restore these Types
and push formatting into presentation layer vs. server.

Fixes containers#9578

Signed-off-by: Jhon Honce <[email protected]>
@github-actions github-actions bot added the locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments. label Sep 21, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 21, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
kind/bug Categorizes issue or PR as related to a bug. locked - please file new issue/PR Assist humans wanting to comment on an old issue or PR with locked comments.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants