Skip to content

docs(api): add time-cutoff examples and Request URL copy button #5086

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

Draft
aseckin wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs(api): add time-cutoff examples and Request URL copy button #5086

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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 docs/openapi.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1313,21 +1313,21 @@ paths:
type: string
format: date-time
example: '2024-01-01'
description: "Post open timestamp filter: `open_time__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`."
description: "Post open timestamp filter: `open_time__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`. For example, to query everything opened after 2024-01-01, use `open_time__gt=2024-01-01`. For everything opened on or before that date, use `open_time__lte=2024-01-01`."
- in: query
name: published_at__gt
schema:
type: string
format: date-time
example: '2024-01-01'
description: "Post publication timestamp filter: `published_at__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`."
description: "Post publication timestamp filter: `published_at__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`. For example, to query everything published after 2024-01-01, use `published_at__gt=2024-01-01`. For everything published on or before that date, use `published_at__lte=2024-01-01`."
- in: query
name: scheduled_resolve_time__gt
schema:
type: string
format: date-time
example: '2024-01-01'
description: "Scheduled resolution timestamp filter: `scheduled_resolve_time__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`."
description: "Scheduled resolution timestamp filter: `scheduled_resolve_time__<operator>`. Supported operators: `gt`, `gte`, `lt`, `lte`. For example, to query everything scheduled to resolve after 2024-01-01, use `scheduled_resolve_time__gt=2024-01-01`. For everything scheduled to resolve on or before that date, use `scheduled_resolve_time__lte=2024-01-01`."
- in: query
name: forecast_type
schema:
Expand Down
87 changes: 86 additions & 1 deletion templates/swagger-ui.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,28 @@
<meta charset="utf-8"/>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css"/>
<style>
.metac-copy-request-url-btn {
margin-left: 8px;
padding: 4px 10px;
font-size: 12px;
font-family: inherit;
font-weight: 600;
color: #3b4151;
background: #fff;
border: 1px solid #d9d9d9;
border-radius: 4px;
cursor: pointer;
vertical-align: middle;
}
.metac-copy-request-url-btn:hover {
background: #f5f5f5;
}
.metac-copy-request-url-btn.copied {
color: #49cc90;
border-color: #49cc90;
}
</style>
</head>
<body>
<div id="swagger-ui"></div>
Expand Down Expand Up @@ -46,6 +68,69 @@
],
plugins: [InjectServerPlugin]
})

// Add a copy-to-clipboard button next to each "Request URL" heading rendered
// by Swagger UI after "Try it out". Swagger UI v3 does not ship one.
function addCopyButtonToRequestUrl(heading) {
if (heading.dataset.metacCopyButtonAdded === "true") return;
heading.dataset.metacCopyButtonAdded = "true";

const urlEl = heading.nextElementSibling;
if (!urlEl) return;

const button = document.createElement("button");
button.type = "button";
button.className = "metac-copy-request-url-btn";
button.textContent = "Copy";
button.addEventListener("click", async () => {
const text = (urlEl.textContent || "").trim();
try {
if (navigator.clipboard && navigator.clipboard.writeText) {
await navigator.clipboard.writeText(text);
} else {
const ta = document.createElement("textarea");
ta.value = text;
ta.style.position = "fixed";
ta.style.opacity = "0";
document.body.appendChild(ta);
ta.select();
document.execCommand("copy");
document.body.removeChild(ta);
}
button.textContent = "Copied!";
button.classList.add("copied");
setTimeout(() => {
button.textContent = "Copy";
button.classList.remove("copied");
}, 1500);
} catch (e) {
button.textContent = "Failed";
setTimeout(() => {
button.textContent = "Copy";
}, 1500);
}
});
heading.appendChild(button);
}

function scanForRequestUrls(root) {
const headings = (root || document).querySelectorAll(".request-url h4");
headings.forEach(addCopyButtonToRequestUrl);
}

const observer = new MutationObserver((mutations) => {
for (const m of mutations) {
for (const node of m.addedNodes) {
if (node.nodeType !== 1) continue;
if (node.matches && node.matches(".request-url")) {
scanForRequestUrls(node.parentNode);
} else {
scanForRequestUrls(node);
}
}
}
});
observer.observe(document.body, { childList: true, subtree: true });
</script>
</body>
</html>
</html>
Loading