containers/podman

ImageSearch and ImageSearchLibPod are specified incorrectly in swagger docs

Chiusa

#23.741 aperta il 25 ago 2024

 (3 commenti) (0 reazioni) (0 assegnatari)Go (3107 fork)batch import
ContribfestGood First Issuedocumentationkind/bugvolunteers-wanted

Metriche repository

Star
 (31.686 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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

Guida contributor