containers/podman

Mismatch between documentation and REST API

Open

#15,376 opened on 2022年8月18日

GitHub で見る
 (9 comments) (0 reactions) (0 assignees)Go (3,107 forks)batch import
ContribfestGood First IssueHTTP APIdocumentationkind/bugvolunteers-wanted

Repository metrics

Stars
 (31,686 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

Is this a BUG REPORT or FEATURE REQUEST? (leave only one on its own line)

/kind feature

Description

When looking at the REST API documentation https://docs.podman.io/en/latest/_static/api.html#tag/system-(compat)/operation/SystemInfo

In top right corner I see GET /info and I can do a curl request like

curl --unix-socket /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock 'http:///d/info'

it works

now if I go to the 'libpod info' page https://docs.podman.io/en/latest/_static/api.html#tag/system/operation/SystemInfoLibpod

in top right corner it says GET /libpod/info

but if I do a curl on /libpod/info as written it fails

curl --unix-socket /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock 'http:///d/libpod/info'

I have Not found error

using v4.2.0 prefix it works

curl --unix-socket /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock 'http:///d/v4.2.0/libpod/info'

Funny thing, I can use random numbers like v5.0.0 and it's still working but without prefix it doesn't work

curl --unix-socket /Users/benoitf/.local/share/containers/podman/machine/podman-machine-default/podman.sock 'http:///d/v5.0.0/libpod/info'

Describe the results you received:

not working without prefixing /libpod/ with a version scheme

Describe the results you expected:

working without prefixing with a version (expect to have alias to the latest API)

Additional information you deem important (e.g. issue happens only occasionally):

Output of podman version:

macOS with brew 4.2.0 

Output of podman info:

(paste your output here)

Package info (e.g. output of rpm -q podman or apt list podman):

(paste your output here)

Have you tested with the latest version of Podman and have you checked the Podman Troubleshooting Guide? (https://github.com/containers/podman/blob/main/troubleshooting.md)

Yes/No

Additional environment details (AWS, VirtualBox, physical, etc.):

コントリビューターガイド