Skip to content

Commit

Permalink
Deploying to gh-pages from @ litestar-org/litestar@cf25db6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
JacobCoffee committed Dec 20, 2023
1 parent 084da46 commit 4c88772
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion 2919/_sources/topics/sync-vs-async.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ operations, such as calling synchronous functions that are I/O bound.
It might be tempting to look at this and think a function should be async by default,
unless it's performing blocking operations synchronously, but this is not the case.
Async itself has an overhead attached to it which, while very small, can in some
situations become non negligible. An synchronous function performing non-blocking
situations become non negligible. A synchronous function performing non-blocking
operations will outperform an asynchronous function doing the same.


Expand Down
4 changes: 2 additions & 2 deletions 2919/reference/app.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions 2919/reference/testing.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions 2919/release-notes/whats-new-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -2150,7 +2150,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Permalink to this heading">#</
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;f176257a-00bf-4a51-92aa-cd8f685541c6&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;30d20fce-5245-440b-bdb8-5622eedcc021&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -2335,7 +2335,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Permalink to this heading">#</
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;762902b9-853b-41f8-ab6d-8abd289ff5ef&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;12790691-c36e-4aaa-8c20-99c9f2fb9495&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion 2919/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion 2919/topics/sync-vs-async.html
Original file line number Diff line number Diff line change
Expand Up @@ -1582,7 +1582,7 @@ <h2>When to use an asynchronous function<a class="headerlink" href="#when-to-use
<p>It might be tempting to look at this and think a function should be async by default,
unless it’s performing blocking operations synchronously, but this is not the case.
Async itself has an overhead attached to it which, while very small, can in some
situations become non negligible. An synchronous function performing non-blocking
situations become non negligible. A synchronous function performing non-blocking
operations will outperform an asynchronous function doing the same.</p>
</section>
<section id="when-to-use-a-synchronous-function">
Expand Down
10 changes: 5 additions & 5 deletions 2919/usage/dto/1-abstract-dto.html
Original file line number Diff line number Diff line change
Expand Up @@ -1558,7 +1558,7 @@ <h2>Using DTO Factories<a class="headerlink" href="#using-dto-factories" title="
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;c071d1ed-c107-4d72-a71f-70416e630609&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;0dfb58b0-fb79-4041-af40-b21ebfb1eeda&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -1615,7 +1615,7 @@ <h2>Using DTO Factories<a class="headerlink" href="#using-dto-factories" title="
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;4302b798-edd3-470f-9ed3-b78db3bd9182&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;5fdfa527-cabe-43ba-935f-d1c55b2a7f08&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -1878,7 +1878,7 @@ <h2>Renaming fields<a class="headerlink" href="#renaming-fields" title="Permalin
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;d106cb23-eafc-4695-b7df-4e864bd50d36&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;7b38d6ce-5b22-41cb-acbb-36cf9bc965b8&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -1970,7 +1970,7 @@ <h2>Renaming fields<a class="headerlink" href="#renaming-fields" title="Permalin
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;0ab23054-438a-4eb3-8451-a529cc606d8c&quot;</span>,<span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;653a9d13-9a3a-42c3-b77d-54c007e9d135&quot;</span>,<span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down Expand Up @@ -2242,7 +2242,7 @@ <h2>DTO Data<a class="headerlink" href="#dto-data" title="Permalink to this head
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/person<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;age&quot;</span>:41<span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;2b1b54ae-414c-4964-913b-0b0abd83c987&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;age&quot;</span>:41<span class="o">}</span>
<span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;6d0449d5-012c-47ad-83de-3bba8b1eb593&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;age&quot;</span>:41<span class="o">}</span>
</pre></div>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion 2919/usage/exceptions.html
Original file line number Diff line number Diff line change
Expand Up @@ -1681,7 +1681,7 @@ <h2>Exception handling<a class="headerlink" href="#exception-handling" title="Pe
<div class="admonition">
<p class="admonition-title">Run it</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/validation-error
validation<span class="w"> </span>error:<span class="w"> </span>Missing<span class="w"> </span>required<span class="w"> </span>query<span class="w"> </span>parameter<span class="w"> </span><span class="s1">&#39;some_query_param&#39;</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>url<span class="w"> </span>http://127.0.0.1:9016/validation-error
validation<span class="w"> </span>error:<span class="w"> </span>Missing<span class="w"> </span>required<span class="w"> </span>query<span class="w"> </span>parameter<span class="w"> </span><span class="s1">&#39;some_query_param&#39;</span><span class="w"> </span><span class="k">for</span><span class="w"> </span>url<span class="w"> </span>http://127.0.0.1:9018/validation-error
&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/server-error
server<span class="w"> </span>error:<span class="w"> </span><span class="m">500</span>:<span class="w"> </span>Internal<span class="w"> </span>Server<span class="w"> </span>Error
&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/value-error
Expand Down

0 comments on commit 4c88772

Please sign in to comment.