This commit is contained in:
@@ -768,9 +768,8 @@
|
||||
|
||||
<div class="doc doc-contents first">
|
||||
|
||||
<p>OpenAPI-first HTTP client for contract-driven services.</p>
|
||||
<hr />
|
||||
<h4 id="openapi_first.client--summary">Summary</h4>
|
||||
<h3 id="openapi_first.client--summary">Summary</h3>
|
||||
<p>OpenAPI-first HTTP client for contract-driven services.</p>
|
||||
<p>This module provides <code>OpenAPIClient</code>, a thin, strict HTTP client that
|
||||
derives all callable operations directly from an OpenAPI 3.x specification.</p>
|
||||
<p>It is the client counterpart to <code>OpenAPIFirstApp</code>.</p>
|
||||
@@ -832,24 +831,28 @@ derives all callable operations directly from an OpenAPI 3.x specification.</p>
|
||||
<div class="doc doc-contents ">
|
||||
|
||||
|
||||
<p>OpenAPI-first HTTP client (httpx-based).</p>
|
||||
<p>OpenAPI-first HTTP client (<code>httpx</code>-based).</p>
|
||||
|
||||
|
||||
<details class="notes" open>
|
||||
<summary>Notes</summary>
|
||||
<p><strong>Responsibilities:</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 client derives all callable methods directly from an OpenAPI 3.x specification. Each operationId becomes a method on the client instance.
|
||||
<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></pre></div></td><td class="code"><div><pre><span></span><code>- This client derives all callable methods directly from an
|
||||
OpenAPI 3.x specification. Each `operationId` becomes a method
|
||||
on the client instance.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
<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>
|
||||
<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>- One callable per operationId
|
||||
- Explicit parameters (path, query, headers, body)
|
||||
- No implicit schema inference or mutation
|
||||
- Returns raw `httpx.Response` objects
|
||||
- No response validation or deserialization
|
||||
<span class="normal">5</span></pre></div></td><td class="code"><div><pre><span></span><code>- One callable per `operationId`.
|
||||
- Explicit parameters (path, query, headers, body).
|
||||
- No implicit schema inference or mutation.
|
||||
- Returns raw `httpx.Response` objects.
|
||||
- No response validation or deserialization.
|
||||
</code></pre></div></td></tr></table></div>
|
||||
</details>
|
||||
|
||||
@@ -959,7 +962,7 @@ derives all callable operations directly from an OpenAPI 3.x specification.</p>
|
||||
<tbody>
|
||||
<tr class="doc-section-item">
|
||||
<td>
|
||||
<code><a class="autorefs autorefs-internal" title="openapi_first.client.OpenAPIClientError" href="../openapi_first/client/#openapi_first.client.OpenAPIClientError">OpenAPIClientError</a></code>
|
||||
<code><a class="autorefs autorefs-internal" title="openapi_first.client.OpenAPIClientError" href="#openapi_first.client.OpenAPIClientError">OpenAPIClientError</a></code>
|
||||
</td>
|
||||
<td>
|
||||
<div class="doc-md-description">
|
||||
@@ -1004,7 +1007,7 @@ derives all callable operations directly from an OpenAPI 3.x specification.</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 client operation fails.</p>
|
||||
|
||||
Reference in New Issue
Block a user