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 docs mismatch for /images/{name}/push and libpod endpoint #23040

Closed
AlexanderNull opened this issue Jun 18, 2024 · 2 comments · Fixed by #23060
Closed

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

AlexanderNull opened this issue Jun 18, 2024 · 2 comments · Fixed by #23060
Labels
documentation Issue or fix is in project documentation 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

@AlexanderNull
Copy link
Contributor

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:

  • all
  • compress
  • destination
  • name
  • tag

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

  • destination
  • forceCompressionFormat
  • name
  • quiet
  • tlsVerify

Describe the results you expected

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

  • all
  • compress
  • destination
  • format
  • name
  • tlsVerify
  • tag

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

  • all
  • compressionFormat
  • compressionLevel
  • forceCompressionFormat
  • destination
  • format
  • name
  • quiet
  • removeSignatures
  • retry
  • retryDelay
  • tlsVerify

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

@AlexanderNull AlexanderNull added the kind/bug Categorizes issue or PR as related to a bug. label Jun 18, 2024
@Luap99 Luap99 added the documentation Issue or fix is in project documentation label Jun 19, 2024
@Luap99
Copy link
Member

Luap99 commented Jun 19, 2024

Interested in opening a PR to fix the swagger doc?

@AlexanderNull
Copy link
Contributor Author

@Luap99 : PR submitted

@stale-locking-app stale-locking-app 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 20, 2024
@stale-locking-app stale-locking-app bot locked as resolved and limited conversation to collaborators Sep 20, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Issue or fix is in project documentation 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.

2 participants