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

docs: collect openapi-first wiki and refresh openapi-first lib docs; regenerate homepage

Browse Source
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-09-15 22:36:51 +05:30
parent 58544c4524
commit a51082fe77
83 changed files with 20049 additions and 535 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
openapi-first/lib/openapi_first/templates/vet_app/index.html
View File

@@ -671,10 +671,10 @@ library API surface.</p>
<hr />
<h4 id="openapi_first.templates.vet_app--scaffolding-via-cli">Scaffolding via CLI</h4>
<p>Create a new vet clinic service using the bundled template:</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>openapi-first vet_app
<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>openapi-first scaffold vet_app
</code></pre></div></td></tr></table></div>
<p>Create the service in a custom directory:</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>openapi-first vet_app my-vet-clinic
<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>openapi-first scaffold vet_app my-vet-clinic
</code></pre></div></td></tr></table></div>
<hr />
<h4 id="openapi_first.templates.vet_app--client-usage-example">Client Usage Example</h4>
@@ -699,21 +699,21 @@ library API surface.</p>
<span class="normal">19</span></pre></div></td><td class="code"><div><pre><span></span><code>from openapi_first.loader import load_openapi
from openapi_first.client import OpenAPIClient
spec = load_openapi(&quot;openapi.yaml&quot;)
spec = load_openapi("openapi.yaml")
client = OpenAPIClient(spec)
# List pets with pagination
response = client.list_pets(query_params={&quot;limit&quot;: 10, &quot;offset&quot;: 0})
response = client.list_pets(query_params={"limit": 10, "offset": 0})
# Create a pet with FK references
response = client.create_pet(
body={&quot;name&quot;: &quot;Fido&quot;, &quot;species&quot;: &quot;dog&quot;, &quot;parents&quot;: [1, 2]}
body={"name": "Fido", "species": "dog", "parents": [1, 2]}
)
# Upload a pet photo
response = client.upload_pet_photo(
path_params={&quot;id&quot;: 1},
body={&quot;file&quot;: open(&quot;photo.jpg&quot;, &quot;rb&quot;)},
path_params={"id": 1},
body={"file": open("photo.jpg", "rb")},
)
</code></pre></div></td></tr></table></div>
<hr />