Skip to content

add: redoc script, load it in document viewer #298

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.

Sign up for GitHub

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

Merged
mickenordin merged 4 commits into from
Nov 25, 2025
Merged

add: redoc script, load it in document viewer #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
570fb86
add: redoc script, load it in document viewer
MahdiBaghbani Nov 25, 2025
7f332c9
style: indent
MahdiBaghbani Nov 25, 2025
ce1ec3f
fix: logo path
MahdiBaghbani Nov 25, 2025
5b118a3
add: redoc js to the build artifacts
MahdiBaghbani Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/workflows/github-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
- name: Build site
run: |
rm -rf dist
mkdir -p dist
mkdir -p dist/scripts

pandoc README.md \
--from=gfm \
Expand All @@ -26,9 +26,9 @@ jobs:
--metadata title="README" \
-o dist/index.html

cp ./logo.png ./dist/logo.png
cp -R ./logo ./dist/logo
cp ./docs.html ./dist/docs.html

cp ./scripts/scripts/redoc.standalone-v3.0.0-rc.0.js ./dist/scripts/redoc.standalone-v3.0.0-rc.0.js
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
Expand Down
61 changes: 39 additions & 22 deletions docs.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,46 +3,63 @@
<head>
<title>Open Cloud Mesh API Reference Documentation</title>
<!-- needed for adaptive design -->
<meta charset="utf-8"/>
<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
-->
ReDoc doesn't change outer page styles
-->
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>

<body>
<redoc></redoc>
<script>
const params = new URLSearchParams(window.location.search);
const user = params.get('user');
const repo = params.get('repo');
const branch = params.get('branch');
let changed = false;
if (user === null) {
params.set('user', 'cs3org');
changed = true;
}
if (repo === null) {
params.set('repo', 'OCM-API');
changed = true;
}
if (branch === null) {
params.set('branch', 'develop');
changed = true;

const defaults = {
user: 'cs3org',
repo: 'OCM-API',
branch: 'develop'
};

let mutated = false;
for (const key in defaults) {
if (!params.has(key)) {
params.set(key, defaults[key]);
mutated = true;
}
}
if (changed) {

if (mutated) {
params.sort();
window.location = `?${params.toString()}`;
window.location.replace('?' + params.toString());
}
document.querySelector('redoc').setAttribute('spec-url', `https://raw.githubusercontent.com/${user}/${repo}/${branch}/spec.yaml`);

const user = params.get('user');
const repo = params.get('repo');
const branch = params.get('branch');

const specUrl =
`https://raw.githubusercontent.com/${user}/${repo}/${branch}/spec.yaml`;

const redocScriptUrl =
`https://${user}.github.io/${repo}/scripts/redoc.standalone-v3.0.0-rc.0.js`;

const redocEl = document.querySelector('redoc');
redocEl.setAttribute('spec-url', specUrl);

const script = document.createElement('script');
script.src = redocScriptUrl;
script.async = true;
script.defer = true;
document.body.appendChild(script);
</script>
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
</body>
</html>
Loading
Loading