aetos/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Build: 0.1.8
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-03-08 01:01:39 +05:30
parent 8701bf92ac
commit 9191de9dff
200 changed files with 130793 additions and 18277 deletions
Download Patch File Download Diff File Expand all files Collapse all files

442
libs/openapi-first/site/loader/index.html
View File

@@ -86,7 +86,9 @@
<header class="md-header" data-md-component="header">
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="openapi_first" class="md-header__button md-logo" aria-label="openapi_first" data-md-component="logo">
@@ -151,12 +153,19 @@
</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>
@@ -182,96 +191,6 @@
<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="../app/" class="md-tabs__link">
Application Bootstrap
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Core Utilities
</a>
</li>
<li class="md-tabs__item">
<a href="../client/" class="md-tabs__link">
OpenAPI Client
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
@@ -285,10 +204,8 @@
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="openapi_first" class="md-nav__button md-logo" aria-label="openapi_first" data-md-component="logo">
@@ -331,13 +248,21 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -346,7 +271,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
@@ -429,13 +354,18 @@
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
@@ -532,28 +462,28 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader--openapi_firstloaders" class="md-nav__link">
<a href="#openapi_first.loader--summary" class="md-nav__link">
<span class="md-ellipsis">
openapi_first.loaders
</span>
</a>
<nav class="md-nav" aria-label="openapi_first.loaders">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader--design-principles" class="md-nav__link">
<span class="md-ellipsis">
Design principles
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader--this-module-intentionally-does-not" class="md-nav__link">
<a href="#openapi_first.loader-classes" class="md-nav__link">
<span class="md-ellipsis">
This module intentionally does NOT:
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.OpenAPISpecLoadError" class="md-nav__link">
<span class="md-ellipsis">
OpenAPISpecLoadError
</span>
</a>
@@ -565,13 +495,14 @@
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.OpenAPISpecLoadError" class="md-nav__link">
<a href="#openapi_first.loader-functions" class="md-nav__link">
<span class="md-ellipsis">
OpenAPISpecLoadError
Functions
</span>
</a>
</li>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi" class="md-nav__link">
@@ -580,34 +511,6 @@
</span>
</a>
<nav class="md-nav" aria-label="load_openapi">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
</ul>
@@ -667,13 +570,19 @@
<li class="md-nav__item md-nav__item--nested">
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
@@ -682,7 +591,7 @@
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
@@ -769,28 +678,28 @@
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader--openapi_firstloaders" class="md-nav__link">
<a href="#openapi_first.loader--summary" class="md-nav__link">
<span class="md-ellipsis">
openapi_first.loaders
</span>
</a>
<nav class="md-nav" aria-label="openapi_first.loaders">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader--design-principles" class="md-nav__link">
<span class="md-ellipsis">
Design principles
Summary
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader--this-module-intentionally-does-not" class="md-nav__link">
<a href="#openapi_first.loader-classes" class="md-nav__link">
<span class="md-ellipsis">
This module intentionally does NOT:
Classes
</span>
</a>
<nav class="md-nav" aria-label="Classes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.OpenAPISpecLoadError" class="md-nav__link">
<span class="md-ellipsis">
OpenAPISpecLoadError
</span>
</a>
@@ -802,13 +711,14 @@
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.OpenAPISpecLoadError" class="md-nav__link">
<a href="#openapi_first.loader-functions" class="md-nav__link">
<span class="md-ellipsis">
OpenAPISpecLoadError
Functions
</span>
</a>
</li>
<nav class="md-nav" aria-label="Functions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi" class="md-nav__link">
@@ -817,34 +727,6 @@
</span>
</a>
<nav class="md-nav" aria-label="load_openapi">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--parameters" class="md-nav__link">
<span class="md-ellipsis">
Parameters
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--returns" class="md-nav__link">
<span class="md-ellipsis">
Returns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#openapi_first.loader.load_openapi--raises" class="md-nav__link">
<span class="md-ellipsis">
Raises
</span>
</a>
</li>
</ul>
@@ -881,35 +763,38 @@
<h2 id="openapi_first.loader" class="doc doc-heading">
<span class="doc doc-object-name doc-module-name">openapi_first.loader</span>
<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code> <span class="doc doc-object-name doc-module-name">openapi_first.loader</span>
</h2>
<div class="doc doc-contents first">
<h3 id="openapi_first.loader--openapi_firstloaders">openapi_first.loaders</h3>
<p>OpenAPI specification loading and validation utilities.</p>
<p>OpenAPI specification loading and validation utilities.</p>
<hr />
<h4 id="openapi_first.loader--summary">Summary</h4>
<p>This module is responsible for loading an OpenAPI 3.x specification
from disk and validating it before it is used by the application.</p>
<p>It enforces the principle that an invalid or malformed OpenAPI document
must never reach the routing or runtime layers.</p>
<h4 id="openapi_first.loader--design-principles">Design principles</h4>
<ul>
<li>OpenAPI is treated as an authoritative contract.</li>
<li>Invalid specifications fail fast at application startup.</li>
<li>Supported formats are JSON and YAML.</li>
<li>Validation errors are surfaced clearly and early.</li>
</ul>
<h4 id="openapi_first.loader--this-module-intentionally-does-not">This module intentionally does NOT:</h4>
<ul>
<li>Modify the OpenAPI document</li>
<li>Infer missing fields</li>
<li>Generate models or code</li>
<li>Perform request/response validation at runtime</li>
</ul>
<details class="notes" open>
<summary>Notes</summary>
<p><strong>Design Principles:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span>
<span class="normal">4</span></pre></div></td><td class="code"><div><pre><span></span><code>- OpenAPI is treated as an authoritative contract
- Invalid specifications fail fast at application startup
- Supported formats are JSON and YAML
- Validation errors are surfaced clearly and early
</code></pre></div></td></tr></table></div>
<p><strong>Constraints:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This module intentionally does NOT: Modify the OpenAPI document, infer missing fields, generate models or code, or perform request/response validation at runtime.
</code></pre></div></td></tr></table></div>
</details>
<div class="doc doc-children">
@@ -918,66 +803,139 @@ must never reach the routing or runtime layers.</p>
<h3 id="openapi_first.loader-classes">Classes</h3>
<div class="doc doc-object doc-class">
<h3 id="openapi_first.loader.OpenAPISpecLoadError" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">OpenAPISpecLoadError</span>
<h4 id="openapi_first.loader.OpenAPISpecLoadError" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code> <span class="doc doc-object-name doc-class-name">OpenAPISpecLoadError</span>
</h3>
</h4>
<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.errors.OpenAPIFirstError" href="../errors/#openapi_first.errors.OpenAPIFirstError">OpenAPIFirstError</a></code></p>
Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.errors.OpenAPIFirstError" href="../openapi_first/errors/#openapi_first.errors.OpenAPIFirstError">OpenAPIFirstError</a></code></p>
<p>Raised when an OpenAPI specification cannot be loaded or validated.</p>
<p>This error indicates that the OpenAPI document is unreadable,
malformed, or violates the OpenAPI 3.x specification.</p>
<details class="notes" open>
<summary>Notes</summary>
<p><strong>Guarantees:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span></pre></div></td><td class="code"><div><pre><span></span><code>- This error indicates that the OpenAPI document is unreadable, malformed, or violates the OpenAPI 3.x specification
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
<h3 id="openapi_first.loader-functions">Functions</h3>
<div class="doc doc-object doc-function">
<h3 id="openapi_first.loader.load_openapi" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">load_openapi</span>
<h4 id="openapi_first.loader.load_openapi" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-function"></code> <span class="doc doc-object-name doc-function-name">load_openapi</span>
</h3>
<div class="doc-signature highlight"><pre><span></span><code><span class="nf">load_openapi</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Path</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
</code></pre></div>
</h4>
<div class="language-python doc-signature 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></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="nf">load_openapi</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Path</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span>
</span></code></pre></div></td></tr></table></div>
<div class="doc doc-contents ">
<p>Load and validate an OpenAPI 3.x specification from disk.</p>
<p>The specification is parsed based on file extension and validated
using a strict OpenAPI schema validator. Any error results in an
immediate exception, preventing application startup.</p>
<h5 id="openapi_first.loader.load_openapi--parameters">Parameters</h5>
<p>path : str or pathlib.Path
Filesystem path to an OpenAPI specification file.
Supported extensions:
- <code>.json</code>
- <code>.yaml</code>
- <code>.yml</code></p>
<h5 id="openapi_first.loader.load_openapi--returns">Returns</h5>
<p>dict
Parsed and validated OpenAPI specification.</p>
<h5 id="openapi_first.loader.load_openapi--raises">Raises</h5>
<p>OpenAPISpecLoadError
If the file does not exist, cannot be parsed, or fails
OpenAPI schema validation.</p>
<p><span class="doc-section-title">Parameters:</span></p>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td><code>path</code></td>
<td>
<code>str | <span title="pathlib.Path">Path</span></code>
</td>
<td>
<div class="doc-md-description">
<p>Filesystem path to an OpenAPI specification file. Supported extensions: .json, .yaml, .yml.</p>
</div>
</td>
<td>
<em>required</em>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Returns:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><span title="typing.Dict">Dict</span>[str, <span title="typing.Any">Any</span>]</code>
</td>
<td>
<div class="doc-md-description">
<p>dict[str, Any]:
Parsed and validated OpenAPI specification.</p>
</div>
</td>
</tr>
</tbody>
</table>
<p><span class="doc-section-title">Raises:</span></p>
<table>
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr class="doc-section-item">
<td>
<code><a class="autorefs autorefs-internal" title="openapi_first.loader.OpenAPISpecLoadError" href="../openapi_first/loader/#openapi_first.loader.OpenAPISpecLoadError">OpenAPISpecLoadError</a></code>
</td>
<td>
<div class="doc-md-description">
<p>If the file does not exist, cannot be parsed, or fails OpenAPI schema validation.</p>
</div>
</td>
</tr>
</tbody>
</table>
<details class="notes" open>
<summary>Notes</summary>
<p><strong>Guarantees:</strong></p>
<div class="language-text highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">1</span>
<span class="normal">2</span></pre></div></td><td class="code"><div><pre><span></span><code>- The specification is parsed based on file extension and validated using a strict OpenAPI schema validator
- Any error results in an immediate exception, preventing application startup
</code></pre></div></td></tr></table></div>
</details>
</div>
</div>
@@ -1006,6 +964,8 @@ immediate exception, preventing application startup.</p>
</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>
@@ -1043,7 +1003,7 @@ immediate exception, preventing application startup.</p>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.expand", "navigation.top", "navigation.instant", "content.code.copy", "content.code.annotate"], "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 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"], "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>