diff options
| author | Paul Holzinger <pholzing@redhat.com> | 2022-02-09 15:04:10 +0100 |
|---|---|---|
| committer | Paul Holzinger <pholzing@redhat.com> | 2022-02-09 18:17:52 +0100 |
| commit | 829f88d74d6eda471ea3fd4c83857d899a7e452c (patch) | |
| tree | 064408d690613132d8067a409b026fdd187078ad | |
| parent | eb0a0db318a988af9ed70f3cc3a68f3b2bf2aa93 (diff) | |
| download | podman-829f88d74d6eda471ea3fd4c83857d899a7e452c.tar.gz podman-829f88d74d6eda471ea3fd4c83857d899a7e452c.tar.bz2 podman-829f88d74d6eda471ea3fd4c83857d899a7e452c.zip | |
Show API doc for several versions
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 #12796
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
| -rw-r--r-- | RELEASE_PROCESS.md | 2 | ||||
| -rw-r--r-- | docs/source/Reference.rst | 14 | ||||
| -rw-r--r-- | docs/source/_static/api.html | 17 |
3 files changed, 29 insertions, 4 deletions
diff --git a/RELEASE_PROCESS.md b/RELEASE_PROCESS.md index d6414de73..e893d9e2e 100644 --- a/RELEASE_PROCESS.md +++ b/RELEASE_PROCESS.md @@ -166,6 +166,8 @@ spelled with complete minutiae. `git log -1 $(git tag | sort -V | tail -1)`. 1. Edit `version/version.go` and bump the `Version` value to the new release version. If there were API changes, also bump `APIVersion` value. + Make sure to also bump the version in the swagger.yaml `pkg/api/server/docs.go` + and to add a new entry in `docs/source/Reference.rst` for major and minor releases. 1. Commit this and sign the commit (`git commit -a -s -S`). The commit message should be `Bump to vX.Y.Z` (using the actual version numbers). 1. Push this single change to your github fork, and make a new PR, diff --git a/docs/source/Reference.rst b/docs/source/Reference.rst index d194c55a3..dca49a559 100644 --- a/docs/source/Reference.rst +++ b/docs/source/Reference.rst @@ -3,8 +3,16 @@ Reference ========= -To see full screen version please visit: `API documentation <https://docs.podman.io/en/latest/_static/api.html>`_ +Show the API documentation for version: -.. raw:: html +* `latest (main branch) <_static/api.html>`_ - <iframe src="_static/api.html" allowfullscreen="true" height="600px" width="120%"></iframe> +* `version 4.0 <_static/api.html?version=v4.0>`_ + +* `version 3.4 <_static/api.html?version=v3.4>`_ + +* `version 3.3 <_static/api.html?version=v3.3>`_ + +* `version 3.2 <_static/api.html?version=v3.2>`_ + +* `version 3.1 <_static/api.html?version=v3.1>`_ diff --git a/docs/source/_static/api.html b/docs/source/_static/api.html index 6d467d099..0d2d2a8a1 100644 --- a/docs/source/_static/api.html +++ b/docs/source/_static/api.html @@ -18,7 +18,22 @@ </style> </head> <body> - <redoc spec-url='https://storage.googleapis.com/libpod-master-releases/swagger-latest.yaml' sort-props-alphabetically sort-operations-alphabetically></redoc> + <script> + // get version from query (default to latest) + var queryString = window.location.search; + var query = new URLSearchParams(queryString); + var version = "latest"; + if (query.has("version")) { + version = query.get("version"); + } + + var redoc = document.createElement("redoc"); + redoc.setAttribute("sort-props-alphabetically",""); + redoc.setAttribute("sort-operations-alphabetically",""); + redoc.setAttribute("spec-url","https://storage.googleapis.com/libpod-master-releases/swagger-" + version + ".yaml"); + + document.body.appendChild(redoc); + </script> <script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script> </body> </html> |