containers / podman

Podman: A tool for managing OCI containers and pods.
https://podman.io
Apache License 2.0
22.37k stars 2.31k forks source link

Swagger docs mismatch for /images/{name}/push and libpod endpoint #23040

Closed AlexanderNull closed 1 week ago

AlexanderNull commented 2 weeks ago

Issue Description

The current main branch swagger/openapi docs for both the /images/{name}/push and /libpod/images/{name}/push endpoints are both incomplete with regard to the parameters the corresponding handlers will accept. The "format" parameter that's missing from both in particular is one that caused me a bit of a headache on my current project.

Steps to reproduce the issue

Steps to reproduce the issue

  1. read the API docs
    1. compat
    2. libpod
  2. compare to the implemented handler functions
    1. compat
    2. libpod

Describe the results you received

Actual parameter list for /images/{name}/push:

Actual parameter list for /libpod/images/{name}/push:

Describe the results you expected

Expected parameter list for /images/{name}/push:

Expected parameter list for /libpod/images/{name}/push:

podman info output

Just reading the online docs/source control

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

Luap99 commented 1 week ago

Interested in opening a PR to fix the swagger doc?

AlexanderNull commented 1 week ago

@Luap99 : PR submitted