mirror of
https://github.com/containers/podman.git
synced 2025-11-28 17:18:58 +08:00
e93040e1e3
Currently our API docs are not working as it fails to fetch the js file with the redoc code which renders the swagger. The reason this fails is because we have been tracking the "next" version and that was recently bumped to v3.0.0-rc.0 which also seem to have moved the location to use "bundle" (no s). As such we now get a 404 as the CDN doesn't find the file. [1] I don't get why we have been tracking next to begin with, using latest would still work as it points but that could be moved anytime as well so switch the URL to pull in the lastest v2 version which should be safer against unexpected changes like that. While it could of course also break in a minor v2 release hard coding an exact version would mean a fair amount of churn updating this (which I guess would not happen) so this looks like the best compromise to me. [1] https://www.npmjs.com/package/redoc/v/3.0.0-rc.0 Fixes: #27505 Signed-off-by: Paul Holzinger <pholzing@redhat.com>
82 lines
2.9 KiB
HTML
82 lines
2.9 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<title>Reference</title>
|
|
<!-- needed for adaptive design -->
|
|
<meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
|
|
<!--
|
|
ReDoc doesn't change outer page styles
|
|
-->
|
|
<style>
|
|
body {
|
|
margin: 0;
|
|
padding: 0;
|
|
}
|
|
/*
|
|
* ReadTheDocs injects its version selector which is confusing on
|
|
* this page since it doesn't affect the API version. So we hide it.
|
|
*/
|
|
readthedocs-flyout {
|
|
display: none;
|
|
}
|
|
/* Our own version selector. */
|
|
#versionSelect {
|
|
position: fixed;
|
|
/*
|
|
* Like the ReadTheDocs selector we put it in the bottom-right corner.
|
|
* When the browser is narrow ReDoc puts its menu button in the same corner,
|
|
* the position here is chosen not to overlap with that.
|
|
*/
|
|
bottom: 14px;
|
|
right: 14px;
|
|
z-index: 99;
|
|
}
|
|
</style>
|
|
</head>
|
|
<body>
|
|
<script src="https://cdn.jsdelivr.net/npm/redoc@v2/bundles/redoc.standalone.js"> </script>
|
|
<select id="versionSelect" aria-label="Version">
|
|
<option>latest</option>
|
|
</select>
|
|
<div id="redoc-container"></div>
|
|
<script type="module">
|
|
const versionSelect = document.getElementById("versionSelect");
|
|
const resp = await fetch("versions.json");
|
|
const versions = await resp.json();
|
|
for (const version of versions) {
|
|
const opt = document.createElement("option");
|
|
opt.textContent = "v" + version;
|
|
versionSelect.append(opt);
|
|
}
|
|
// get version from query (default to latest)
|
|
var queryString = window.location.search;
|
|
var query = new URLSearchParams(queryString);
|
|
var version = "latest";
|
|
if (query.has("version")) {
|
|
versionSelect.value = query.get("version");
|
|
}
|
|
|
|
function load() {
|
|
// Note: We replace the whole container element because otherwise Redoc.init calls
|
|
// after the initial Redoc.init call take a second rather than just a few ms.
|
|
let redocContainer = document.createElement('div');
|
|
redocContainer.id = 'redoc-container';
|
|
let oldContainer = document.getElementById("redoc-container");
|
|
oldContainer.parentNode.replaceChild(redocContainer, oldContainer);
|
|
|
|
Redoc.init("https://storage.googleapis.com/libpod-master-releases/swagger-" + versionSelect.value + ".yaml", {
|
|
sortPropsAlphabetically: true,
|
|
sortOperationsAlphabetically: true,
|
|
}, redocContainer);
|
|
history.pushState(null, '', '?version=' + versionSelect.value);
|
|
document.title = 'Reference ' + versionSelect.value;
|
|
}
|
|
load();
|
|
versionSelect.addEventListener('change', load);
|
|
</script>
|
|
</body>
|
|
</html>
|