search

containers / podman

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

[CI:DOCS] Adds all PushImage supported paramters to openapi docs #23060

Closed AlexanderNull closed 3 months ago

AlexanderNull commented 3 months ago

Closes #23040

Looks like these parameters have been implemented for some time on the api handler functions, just missed documentation originally. I mostly erred towards copying existing documentation for these properties with some minor edits to work better in API docs specifically. I also modified the description format for some of the existing parameters on the two endpoints I updated so that the formats would match.

Does this PR introduce a user-facing change?

Updated docs

Updates OpenAPI list of parameters accepted to Push Image endpoints to match full list accepted by the API.
rhatdan commented 3 months ago

LGTM Thanks @AlexanderNull @Luap99 @mheon @baude @ashley-cui @giuseppe @TomSweeneyRedHat PTAL

openshift-ci[bot] commented 3 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: AlexanderNull, Luap99

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/containers/podman/blob/main/OWNERS)~~ [Luap99] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment