Files

805 lines
25 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="../01_overview/">
<link rel="next" href="../03_admin_ui/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.23">
<title>Spec Extensions - react-openapi</title>
<link rel="stylesheet" href="../assets/stylesheets/main.84d31ad4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="https://unpkg.com/dracula-prism/dist/css/dracula-prism.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="blue-grey" data-md-color-accent="teal">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#spec-extensions" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="react-openapi" class="md-header__button md-logo" aria-label="react-openapi" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
react-openapi
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Spec Extensions
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
</a>
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../01_overview/" class="md-tabs__link">
Overview
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Spec Extensions
</a>
</li>
<li class="md-tabs__item">
<a href="../03_admin_ui/" class="md-tabs__link">
Admin UI
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="react-openapi" class="md-nav__button md-logo" aria-label="react-openapi" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 4v18h16v2H4c-1.1 0-2-.9-2-2V4zm11 3h5.5L15 1.5zM8 0h8l6 6v12c0 1.11-.89 2-2 2H8a2 2 0 0 1-2-2V2c0-1.11.89-2 2-2m9 16v-2H8v2zm3-4v-2H8v2z"/></svg>
</a>
react-openapi
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../01_overview/" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Spec Extensions
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Spec Extensions
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#schema-level" class="md-nav__link">
<span class="md-ellipsis">
📦 Schema level
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#property-level" class="md-nav__link">
<span class="md-ellipsis">
📦 Property level
</span>
</a>
<nav class="md-nav" aria-label="📦 Property level">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#foreign-keys" class="md-nav__link">
<span class="md-ellipsis">
Foreign keys
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#path-level" class="md-nav__link">
<span class="md-ellipsis">
📦 Path level
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#security-auth" class="md-nav__link">
<span class="md-ellipsis">
📦 Security / auth
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#profile-x-profile" class="md-nav__link">
<span class="md-ellipsis">
📦 Profile (x-profile)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validator-rules-summary" class="md-nav__link">
<span class="md-ellipsis">
✅ Validator rules (summary)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#related" class="md-nav__link">
<span class="md-ellipsis">
Related
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../03_admin_ui/" class="md-nav__link">
<span class="md-ellipsis">
Admin UI
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="spec-extensions">Spec Extensions</h1>
<p><code>react-openapi</code> is configured entirely by <code>x-</code> extensions inside the OpenAPI
document. This page is the catalogue; the repository <code>README.md</code> carries the
complete authoring guide with a minimal worked spec.</p>
<p><strong>Validation levels</strong> — <code>error</code> (the admin will not render), <code>warning</code>
(renders, shown in a snackbar), <code>info</code> (informational note).</p>
<hr />
<h2 id="schema-level">📦 Schema level</h2>
<table>
<thead>
<tr>
<th>Extension</th>
<th>Required</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>x-resource</code></td>
<td>✅</td>
<td>Marks the schema as a resource; value must equal the collection path segment (<code>pets</code> → <code>/pets</code>). Schemas without it are skipped entirely (use for <code>ErrorBody</code>, <code>Metadata</code>, …).</td>
</tr>
<tr>
<td><code>x-primary-key</code></td>
<td>✅</td>
<td>Property used as the <code>:id</code> path parameter. Must exist in <code>properties</code>.</td>
</tr>
<tr>
<td><code>x-display-format</code></td>
<td>✅</td>
<td>Template such as <code>"{name} - #{id}"</code>; used for row labels, detail titles and FK options.</td>
</tr>
<tr>
<td><code>x-list-columns</code></td>
<td>✅</td>
<td>Ordered property names for the datatable; every entry must exist.</td>
</tr>
</tbody>
</table>
<hr />
<h2 id="property-level">📦 Property level</h2>
<table>
<thead>
<tr>
<th>Extension</th>
<th>Required</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>x-label</code></td>
<td>✅</td>
<td>Label for form field, table header and detail view.</td>
</tr>
<tr>
<td><code>x-order</code></td>
<td>✅</td>
<td>Field ordering; ties break alphabetically.</td>
</tr>
<tr>
<td><code>x-description</code></td>
<td>—</td>
<td>Helper text / placeholder; falls back to <code>x-label</code>.</td>
</tr>
<tr>
<td><code>x-hidden</code></td>
<td>—</td>
<td><code>{ form, list, detail }</code> visibility; missing keys default to <code>false</code>.</td>
</tr>
<tr>
<td><code>x-filterable</code></td>
<td>—</td>
<td>Marks the field filterable (UI integration reserved).</td>
</tr>
<tr>
<td><code>x-sortable</code></td>
<td>—</td>
<td>Sends <code>?sort=field</code> / <code>?sort=-field</code> on the list endpoint.</td>
</tr>
<tr>
<td><code>x-edit-as</code></td>
<td>—</td>
<td>e.g. <code>date</code> — edit a <code>date-time</code> field with a date input.</td>
</tr>
<tr>
<td><code>x-fk</code></td>
<td>—</td>
<td><code>{ resource, prefetch }</code> — render a dropdown or multi-select for a <code>$ref</code>.</td>
</tr>
<tr>
<td><code>x-ui-type</code></td>
<td>—</td>
<td><code>image</code> — file/image upload control.</td>
</tr>
<tr>
<td><code>x-upload</code> / <code>x-upload-url</code></td>
<td>—</td>
<td>Raw-binary upload (<code>type: image\|pdf\|html\|csv\|file</code>) or an image POST endpoint with <code>{id}</code>.</td>
</tr>
</tbody>
</table>
<h3 id="foreign-keys">Foreign keys</h3>
<div class="language-yaml highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-1">1</a></span>
<span class="normal"><a href="#__codelineno-0-2">2</a></span>
<span class="normal"><a href="#__codelineno-0-3">3</a></span>
<span class="normal"><a href="#__codelineno-0-4">4</a></span>
<span class="normal"><a href="#__codelineno-0-5">5</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1"></a><span class="nt">owner</span><span class="p">:</span>
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2"></a><span class="w"> </span><span class="nt">$ref</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;#/components/schemas/Parent&#39;</span>
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3"></a><span class="w"> </span><span class="nt">x-fk</span><span class="p">:</span>
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4"></a><span class="w"> </span><span class="nt">resource</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">parents</span><span class="w"> </span><span class="c1"># the target&#39;s x-resource value, not the schema name</span>
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5"></a><span class="w"> </span><span class="nt">prefetch</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"> </span><span class="c1"># false -&gt; load options on focus</span>
</span></code></pre></div></td></tr></table></div>
<ul>
<li>Single <code>$ref</code> → <code>FkSelectField</code> dropdown; <code>type: array</code> → <code>FkMultiSelectField</code>.</li>
<li>Options are fetched as <code>GET /{target}?limit=0</code> (paginated) or <code>GET /{target}</code>,
then formatted with the target's <code>x-display-format</code>.</li>
<li>Validator rules: <code>resource</code> must match some <code>x-resource</code>, and that target
must have <code>x-display-format</code> + <code>x-primary-key</code>.</li>
<li>A <code>$ref</code> <strong>without</strong> <code>x-fk</code> renders read-only (<code>InlineRefField</code> chips, or a
disabled JSON text field in forms) and emits an <code>info</code> message.</li>
</ul>
<hr />
<h2 id="path-level">📦 Path level</h2>
<table>
<thead>
<tr>
<th>Extension</th>
<th>Purpose</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>x-sse</code></td>
<td>Marks a path as a Server-Sent Events stream instead of REST CRUD.</td>
</tr>
</tbody>
</table>
<div class="language-yaml highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-1-1"> 1</a></span>
<span class="normal"><a href="#__codelineno-1-2"> 2</a></span>
<span class="normal"><a href="#__codelineno-1-3"> 3</a></span>
<span class="normal"><a href="#__codelineno-1-4"> 4</a></span>
<span class="normal"><a href="#__codelineno-1-5"> 5</a></span>
<span class="normal"><a href="#__codelineno-1-6"> 6</a></span>
<span class="normal"><a href="#__codelineno-1-7"> 7</a></span>
<span class="normal"><a href="#__codelineno-1-8"> 8</a></span>
<span class="normal"><a href="#__codelineno-1-9"> 9</a></span>
<span class="normal"><a href="#__codelineno-1-10">10</a></span></pre></div></td><td class="code"><div><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1"></a><span class="nt">/pets/events</span><span class="p">:</span>
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2"></a><span class="w"> </span><span class="nt">x-sse</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3"></a><span class="w"> </span><span class="nt">get</span><span class="p">:</span>
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4"></a><span class="w"> </span><span class="nt">summary</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Subscribe to Pet events</span>
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5"></a><span class="w"> </span><span class="nt">responses</span><span class="p">:</span>
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6"></a><span class="w"> </span><span class="nt">200</span><span class="p">:</span>
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7"></a><span class="w"> </span><span class="nt">description</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">SSE stream of Pet change events</span>
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8"></a><span class="w"> </span><span class="nt">content</span><span class="p">:</span>
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9"></a><span class="w"> </span><span class="nt">text/event-stream</span><span class="p">:</span>
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10"></a><span class="w"> </span><span class="nt">schema</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">{</span><span class="nt"> type</span><span class="p">:</span><span class="w"> </span><span class="nv">object</span><span class="w"> </span><span class="p p-Indicator">}</span>
</span></code></pre></div></td></tr></table></div>
<p>An <code>x-sse</code> resource is excluded from the sidebar, list/detail routes and CRUD
hooks — it appears only in the streaming collection and is reachable through
<code>useResource(name).stream</code> / <code>SseStreamView</code>.</p>
<hr />
<h2 id="security-auth">📦 Security / auth</h2>
<p>Derived from <code>components.securitySchemes.bearerAuth</code>:</p>
<table>
<thead>
<tr>
<th>Extension</th>
<th>Meaning</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>x-server-url</code></td>
<td>Auth server base URL → <code>AuthConfig.serverUrl</code></td>
</tr>
<tr>
<td><code>x-login-path</code></td>
<td>→ <code>loginPath</code></td>
</tr>
<tr>
<td><code>x-register-path</code></td>
<td>→ <code>registerPath</code></td>
</tr>
<tr>
<td><code>x-logout-path</code></td>
<td>→ <code>logoutPath</code></td>
</tr>
<tr>
<td><code>x-me-path</code></td>
<td>→ <code>mePath</code></td>
</tr>
<tr>
<td><code>x-introspect-path</code></td>
<td>→ <code>introspectPath</code></td>
</tr>
</tbody>
</table>
<p>Requests carry <code>Authorization: Bearer &lt;token&gt;</code> from
<code>SpecConfiguration.getToken</code>. On a <code>401</code> the stored token is cleared so a
refresh flow can take over.</p>
<hr />
<h2 id="profile-x-profile">📦 Profile (<code>x-profile</code>)</h2>
<p><code>x-profile</code> operations describe the current-user view/edit/create screens.
<code>SpecConfiguration.profileComponents</code> supplies React components for them, and
they are mounted through the exported <code>ProfileRoutes</code>.</p>
<hr />
<h2 id="validator-rules-summary">✅ Validator rules (summary)</h2>
<p>For each schema with <code>x-resource</code>:</p>
<ol>
<li><code>x-primary-key</code>, <code>x-display-format</code>, <code>x-list-columns</code> present and valid.</li>
<li>Every property has <code>x-label</code> and <code>x-order</code>.</li>
<li><code>$ref</code> without <code>x-fk</code> → <code>info</code>; <code>x-fk</code> target must exist and be displayable.</li>
<li>The <code>x-resource</code> path exists with <strong>GET</strong> + <strong>POST</strong>.</li>
<li>The item path <code>/{resource}/{id}</code> exists with <strong>GET</strong> + <strong>PUT</strong> + <strong>DELETE</strong>.</li>
<li>If pagination params exist, <code>limit</code> must carry a <code>schema.default</code>.</li>
</ol>
<hr />
<h2 id="related">Related</h2>
<ul>
<li><a href="../01_overview/">01 – Overview</a> · <a href="../03_admin_ui/">03 – Admin UI</a></li>
</ul>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.expand", "navigation.top", "navigation.instant", "navigation.tracking", "navigation.indexes", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.action.edit", "search.highlight", "search.share", "search.suggest", "navigation.tabs", "toc.integrate", "header.autohide", "content.code.select", "content.code.line_numbers", "content.tooltips"], "search": "../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.f55a23d4.min.js"></script>
</body>
</html>