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

it's difficult to find API documentation for specific release #12796

Closed
dwmarshall opened this issue Jan 10, 2022 · 1 comment · Fixed by #13182
Closed

it's difficult to find API documentation for specific release #12796

dwmarshall opened this issue Jan 10, 2022 · 1 comment · Fixed by #13182
Assignees
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

@dwmarshall
Copy link
Contributor

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

/kind bug

Description

See #12777 in which it is very difficult to determine the API for the version of podman I am using.

The API links in documentation point to https://docs.podman.io/en/latest/_static/api.html and there's no way to change version as one can ordinarily do on https://docs.podman.io/en/latest/ where there's a dropdown in the lower-right of the page.

You can manually munge the the URL for api.html in an effort to locate the documentation for previous versions, but that's not always effective or accurate. (To wit, I can access much older documentation that shows the request syntax that I was given to resolve #12777, but it's not clear how to see the full API that matches my exact version: APIVersion: 3.3.1

Steps to reproduce the issue:

  1. Try to find the API documentation for the version of podman you are using.

Describe the results you received:

I get the latest API documentation, which is not accurate for the version I am using.

Describe the results you expected:

I would like to see the complete API for the version I am using with confidence that the request parameters and bodies are correct.

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

Output of podman version:

See #12777 for podman version and podman info --debug for this issue.

(paste your output here)

Output of podman info --debug:

(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/master/troubleshooting.md)

Yes

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

@openshift-ci openshift-ci bot added the kind/bug Categorizes issue or PR as related to a bug. label Jan 10, 2022
@Luap99 Luap99 added the documentation Issue or fix is in project documentation label Jan 11, 2022
@mheon
Copy link
Member

mheon commented Jan 12, 2022

@baude was looking into this

@Luap99 Luap99 self-assigned this Feb 9, 2022
Luap99 added a commit to Luap99/libpod that referenced this issue Feb 9, 2022
Right now it is not possible to look at the API version for a specific
version. docs.podman.io always show the latest version from the main
branch. This is not want many users want so they now have the ability to
select a different version.

Fixes containers#12796

Signed-off-by: Paul Holzinger <[email protected]>
mheon pushed a commit to mheon/libpod that referenced this issue Feb 10, 2022
Right now it is not possible to look at the API version for a specific
version. docs.podman.io always show the latest version from the main
branch. This is not want many users want so they now have the ability to
select a different version.

Fixes containers#12796

Signed-off-by: Paul Holzinger <[email protected]>
patrycja-guzik pushed a commit to patrycja-guzik/podman that referenced this issue Feb 15, 2022
Right now it is not possible to look at the API version for a specific
version. docs.podman.io always show the latest version from the main
branch. This is not want many users want so they now have the ability to
select a different version.

Fixes containers#12796

Signed-off-by: Paul Holzinger <[email protected]>
@github-actions github-actions 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 21, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 21, 2023
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.

3 participants