// Sidebar sync for versioned endpoint pages. // Older endpoint versions are hidden pages (not in docs.json navigation), so // Mintlify renders the sidebar with no active item. The generated version // block carries data-nav-page pointing to the family's sidebar entry (its // latest version); this script highlights that entry (see custom.css). // Tag groups are nested dropdowns inside their context group ("Core" > // "Employee Managers"). They are generated with "expanded": true so their // links are always mounted (Mintlify would otherwise mount a collapsed // dropdown's links lazily, and it never auto-expands the group of a hidden // page). The side effect is that ALL sections start expanded, so // collapseOthers() collapses every section except the one holding the current // page's entry. It runs on every mutation (not once per navigation) because // the sidebar mounts groups progressively — a group that appears after the // first pass must still be collapsed. This never traps the user: collapsing // doesn't navigate, and the only way to open another section is to click it, // which navigates to that section (making it the new current one). // // The same nav-absence also means Mintlify skips the group "eyebrow" label // above the title on hidden pages (it derives it from the sidebar group). // ensureEyebrow() re-adds it from the version block's data-nav-group so every // version page shows the category, not just the latest. (function () { var MARK = "data-endpoint-version-mark"; var EYEBROW_MARK = "data-endpoint-eyebrow"; function versionBlock() { return document.querySelector("div.endpoint-versions[data-nav-page]"); } // Keep only the current page's section expanded. Every nested tag group ships // "expanded": true, so on load they're all open; collapse the ones that don't // hold this family's entry (identified by data-nav-page, which disambiguates // same-named tags across contexts — e.g. Core > Test vs Schedule > Test). // Collapsing never navigates. function collapseOthers() { var block = versionBlock(); if (!block) return; var navPath = block.getAttribute("data-nav-page"); if (!navPath) return; var root = document.getElementById("navigation-items"); if (!root) return; var buttons = root.querySelectorAll("button[aria-expanded]"); if (!buttons.length) return; var current = null; for (var i = 0; i < buttons.length; i++) { var li = buttons[i].parentElement; if (li && li.querySelector('a[href="' + navPath + '"]')) { current = buttons[i]; break; } } if (!current) return; // entry not mounted yet — retry on a later mutation for (var j = 0; j < buttons.length; j++) { if (buttons[j] !== current && buttons[j].getAttribute("aria-expanded") === "true") { buttons[j].click(); } } } // Add the group eyebrow above the title when Mintlify omits it (hidden // older-version pages). Uses the same classes as the native eyebrow so it // inherits Mintlify's styling; idempotent (native or already-injected wins). function ensureEyebrow() { var block = versionBlock(); if (!block) return; var group = block.getAttribute("data-nav-group"); if (!group) return; var header = document.querySelector("#header > div"); if (!header) return; if (header.querySelector(".eyebrow")) return; // native or ours already there var eb = document.createElement("div"); eb.className = "eyebrow h-5 text-primary dark:text-primary-light text-sm font-semibold"; eb.setAttribute(EYEBROW_MARK, "true"); eb.textContent = group; header.insertBefore(eb, header.firstChild); } function escapeHtml(value) { return String(value == null ? "" : value).replace(/[&<>"']/g, function (ch) { return { "&": "&", "<": "<", ">": ">", '"': """, "'": "'", }[ch]; }); } // The replacement endpoints the generator resolved into data-successors // (JSON: label plus href into these docs — href is absent when the successor // has no page here, so the endpoint is named without linking it). Returns // ready-to-insert HTML, or "" when the endpoint declares no replacement. function successorLinks(el) { var raw = el.getAttribute("data-successors"); if (!raw) return ""; var items; try { items = JSON.parse(raw); } catch (e) { return ""; // malformed payload: fall back to the generic copy } if (!items || !items.length) return ""; return items .map(function (item) { var code = "" + escapeHtml(item.label) + ""; if (!item.href) return code; return '' + code + ""; }) .join(" or "); } // Fill in the deprecation callout emitted by the generator // (div.api-deprecation with data-deprecated-at / data-sunset / data-successors). // The severity is decided HERE, against the browser's current date, so a page // flips from "deprecated" to "retired" when its sunset passes — no docs // regeneration needed. custom.css styles the two states (and hides the box // until it has one). Both states link the successor when there is one: a // retired endpoint is exactly where the reader most needs where to go next. function renderDeprecations() { var blocks = document.querySelectorAll("div.api-deprecation"); if (!blocks.length) return; var today = new Date(); today.setHours(0, 0, 0, 0); blocks.forEach(function (el) { var sunset = el.getAttribute("data-sunset"); var since = el.getAttribute("data-deprecated-at"); var expired = false; if (sunset) { var d = new Date(sunset + "T00:00:00"); if (!isNaN(d.getTime())) expired = d <= today; } var state = expired ? "expired" : "deprecated"; if (el.getAttribute("data-state") === state) return; // already rendered el.setAttribute("data-state", state); var replacement = successorLinks(el); var migrate = replacement ? "Use " + replacement + " instead." : "Migrate to a supported version."; if (expired) { el.innerHTML = "This endpoint has been retired" + (sunset ? " as of " + sunset : "") + " and no longer works — requests now return 410 Gone. " + migrate; } else { el.innerHTML = "This endpoint is deprecated" + (since ? " as of " + since : "") + "." + (sunset ? " It will stop responding on " + sunset + "." : "") + " " + migrate; } }); } // The collapsed dropdown holding the family's entry — highlight fallback // when the entry's link isn't in the DOM. Group toggles are plain //

​API Reference

API Reference