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

Missing entry for the API "shouldrestart" in the swagger file. #24986

Closed
CheyenneWills opened this issue Jan 9, 2025 · 1 comment
Closed
Labels
kind/bug Categorizes issue or PR as related to a bug.

Comments

@CheyenneWills
Copy link

CheyenneWills commented Jan 9, 2025

Issue Description

The swagger file (https://docs.podman.io/en/latest/_static/api.html) doesn't contain information for the "shouldrestart" API call.

I have a process that is a socket proxy that audits and logs podman api calls. My process reads the swagger file so it can obtain some information about the apis (e.g. the summary, operationID and the "url")

When running a simple podman container:

podman -r -ti --rm debian ls -al

my code reports

   => POST HTTP/1.1 /v5.2.5/libpod/containers/_{container id}_/shouldrestart
   *** Was unable to find information for the api  POST /v5.2.5/libpod/containers/_{container id}_/shouldrestart

where {container id} is the actual container id

Grep doesn't find the string "shouldrestart" in the swagger-latest.yaml file (or earlier ones)

Looking at the source code for podman shows that "shouldrestart" has been around for at least 5 years.
dc8996e

Steps to reproduce the issue

Steps to reproduce the issue

  1. grep -i shouldrestart swagger-latest.yaml

Describe the results you received

String not found

Describe the results you expected

Description of shouldrestart within the swagger yaml file

podman info output

N/A

Podman in a container

No

Privileged Or Rootless

None

Upstream Latest Release

Yes

Additional environment details

N/A

Additional information

N/A

EDITED to add the -r option to the sample command

@CheyenneWills CheyenneWills added the kind/bug Categorizes issue or PR as related to a bug. label Jan 9, 2025
@CheyenneWills
Copy link
Author

Sorry about the duplicated issue. It appeared that the first time the issue wasn't recorded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

No branches or pull requests

1 participant