This commit is contained in:
@@ -770,9 +770,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>OpenAPI specification loading and validation utilities.</p>
|
||||
<hr />
|
||||
<h4 id="openapi_first.loader--summary">Summary</h4>
|
||||
<h3 id="openapi_first.loader--summary">Summary</h3>
|
||||
<p>OpenAPI specification loading and validation utilities.</p>
|
||||
<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
|
||||
@@ -785,13 +784,21 @@ must never reach the routing or runtime layers.</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
|
||||
<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.
|
||||
<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>
|
||||
<span class="normal">5</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.
|
||||
- Perform request/response validation at runtime.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -818,7 +825,7 @@ must never reach the routing or runtime layers.</p>
|
||||
|
||||
<div class="doc doc-contents ">
|
||||
<p class="doc doc-class-bases">
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.errors.OpenAPIFirstError" href="../openapi_first/errors/#openapi_first.errors.OpenAPIFirstError">OpenAPIFirstError</a></code></p>
|
||||
Bases: <code><a class="autorefs autorefs-internal" title="openapi_first.errors.OpenAPIFirstError" href="../errors/#openapi_first.errors.OpenAPIFirstError">OpenAPIFirstError</a></code></p>
|
||||
|
||||
|
||||
<p>Raised when an OpenAPI specification cannot be loaded or validated.</p>
|
||||
@@ -827,7 +834,9 @@ must never reach the routing or runtime layers.</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
|
||||
<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>- 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>
|
||||
|
||||
@@ -870,7 +879,8 @@ must never reach the routing or runtime layers.</p>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
<p>Filesystem path to an OpenAPI specification file. Supported extensions: .json, .yaml, .yml.</p>
|
||||
<p>Filesystem path to an OpenAPI specification file. Supported
|
||||
extensions: <code>.json</code>, <code>.yaml</code>, <code>.yml</code>.</p>
|
||||
</div>
|
||||
</td>
|
||||
<td>
|
||||
@@ -916,11 +926,12 @@ Parsed and validated OpenAPI specification.</p>
|
||||
<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>
|
||||
<code><a class="autorefs autorefs-internal" title="openapi_first.loader.OpenAPISpecLoadError" href="#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>
|
||||
<p>If the file does not exist, cannot be parsed, or fails OpenAPI
|
||||
schema validation.</p>
|
||||
</div>
|
||||
</td>
|
||||
</tr>
|
||||
@@ -932,8 +943,12 @@ Parsed and validated OpenAPI specification.</p>
|
||||
<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
|
||||
<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>- 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>
|
||||
|
||||
Reference in New Issue
Block a user