containers/podman

ImageSearch and ImageSearchLibPod are specified incorrectly in swagger docs

blazzy opened this issue · 3 comments

blazzy commented

Issue Description

The docs suggest that the image search endpoints return an object like this:

{
  "Automated": "string",
  "Description": "string",
  "Index": "quay.io",
  "Name": "docker.io/library/alpine\"",
  "Official": "string",
  "Stars": 0,
  "Tag": "string"
}

But they actually return an array of such objects.

Steps to reproduce the issue

Query the endpoint and see an array rather than a single object.

Describe the results you received

I see incorrect docs online and an incorrect swagger yaml specification.

Describe the results you expected

I expected the docs to match the spec and describe an array of such objects.

I'm attempting to generate a client based on the spec and it fails to make these queries because of this spec issue.

podman info output

Deleted as not relevant

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

Yes

Additional environment details

Additional environment details

Additional information

Additional information like issue happens only occasionally or issue happens with a particular architecture or on a particular setting

blazzy commented

I deleted my podman info output hoping it would remove the remote label. This doesn't actually have anything to do with remote.

Luap99 commented

Interested in opening a PR to fix this?

I'm attempting to generate a client based on the spec and it fails to make these queries because of this spec issue.

Note there are much more swagger issues (i.e. search for open "swagger" issue here), so this will not be perfect.

github-actions commented

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