containers/podman

ImageSearch and ImageSearchLibPod are specified incorrectly in swagger docs

Fechada

#23.741 aberto em 25 de ago. de 2024

 (3 comentários) (0 reação) (0 responsável)Go (3.107 forks)batch import
ContribfestGood First Issuedocumentationkind/bugvolunteers-wanted

Métricas do repositório

Stars
 (31.686 estrelas)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

Description

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

Guia do colaborador