Deployed 20ff89b with MkDocs version: 1.4.2

404.html

@@ -12,7 +12,7 @@
 
 
       <link rel="icon" href="/django-ninja-extra/assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 

api_controller/api_controller_permission/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/api_controller/api_controller_permission/">
 
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
@@ -778,8 +778,8 @@ <h3 id="limitations-of-object-level-permissions"><strong>Limitations of object l
 But since we don't have the object, we can only invoke <code>has_object_permission</code> if you use <code>get_object_or_exception</code> or <code>get_object_or_none</code> methods which are available to APIController.</p>
 <h2 id="custom-permissions"><strong>Custom permissions</strong></h2>
 <p>To implement a custom permission, override <code>BasePermission</code> and implement either, or both, of the following methods:</p>
-<div class="codehilite"><pre><span></span><code><span class="na">.has_permission</span><span class="p">(</span><span class="no">self</span><span class="p">,</span><span class="w"> </span><span class="no">request</span><span class="p">:</span><span class="w"> </span><span class="no">HttpRequest</span><span class="p">,</span><span class="w"> </span><span class="no">controller</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;APIController&quot;</span><span class="p">)</span>
-<span class="na">.has_object_permission</span><span class="p">(</span><span class="no">self</span><span class="p">,</span><span class="w"> </span><span class="no">request</span><span class="p">:</span><span class="w"> </span><span class="no">HttpRequest</span><span class="p">,</span><span class="w"> </span><span class="no">controller</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;APIController&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">obj</span><span class="p">:</span><span class="w"> </span><span class="no">Any</span><span class="p">)</span>
+<div class="codehilite"><pre><span></span><code><span class="na">.has_permission</span><span class="p">(</span><span class="no">self</span><span class="p">,</span><span class="w"> </span><span class="no">request</span><span class="p">:</span><span class="w"> </span><span class="no">HttpRequest</span><span class="p">,</span><span class="w"> </span><span class="no">controller</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;APIController&quot;</span><span class="p">)</span><span class="w"></span>
+<span class="na">.has_object_permission</span><span class="p">(</span><span class="no">self</span><span class="p">,</span><span class="w"> </span><span class="no">request</span><span class="p">:</span><span class="w"> </span><span class="no">HttpRequest</span><span class="p">,</span><span class="w"> </span><span class="no">controller</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;APIController&quot;</span><span class="p">,</span><span class="w"> </span><span class="no">obj</span><span class="p">:</span><span class="w"> </span><span class="no">Any</span><span class="p">)</span><span class="w"></span>
 </code></pre></div>
 
 <p>Example</p>

api_controller/api_controller_route/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/api_controller/api_controller_route/">
 
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 

api_controller/api_controller_router/index.html

@@ -14,11 +14,11 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/api_controller/api_controller_router/">
 
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
-        <title>APIController Router - Django Ninja Extra</title>
+        <title>**APIController Router** - Django Ninja Extra</title>
 
 
 
@@ -101,7 +101,7 @@
         <div class="md-header__topic" data-md-component="header-topic">
           <span class="md-ellipsis">
 
-              APIController Router
+              **APIController Router**
 
           </span>
         </div>
@@ -775,7 +775,7 @@ <h2 id="quick-usage"><strong>Quick Usage</strong></h2>
 
 <span class="nd">@router</span>
 <span class="k">class</span> <span class="nc">MyRouterController</span><span class="p">(</span><span class="n">APIController</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&#39;&#39;&#39;testing&#39;&#39;&#39;</span>
+    <span class="sd">&#39;&#39;&#39;testing&#39;&#39;&#39;</span>
 
 <span class="n">api</span> <span class="o">=</span> <span class="n">NinjaExtraAPI</span><span class="p">()</span>
 <span class="n">api</span><span class="o">.</span><span class="n">register_controllers</span><span class="p">(</span><span class="n">MyRouterController</span><span class="p">)</span>

api_controller/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/api_controller/">
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
@@ -864,7 +864,7 @@ <h2 id="quick-example">Quick Example</h2>
 
     <span class="nd">@http_generic</span><span class="p">(</span><span class="s1">&#39;/{int:user_id}&#39;</span><span class="p">,</span> <span class="n">methods</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;put&#39;</span><span class="p">,</span> <span class="s1">&#39;patch&#39;</span><span class="p">],</span> <span class="n">response</span><span class="o">=</span><span class="n">UserSchema</span><span class="p">)</span>
     <span class="k">def</span> <span class="nf">update_user</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user_id</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot; Django Ninja will serialize Django ORM model to schema provided as `response`&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot; Django Ninja will serialize Django ORM model to schema provided as `response`&quot;&quot;&quot;</span>
         <span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_object_or_exception</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">user_model</span><span class="p">,</span> <span class="nb">id</span><span class="o">=</span><span class="n">user_id</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">user</span>
 

api_controller/model_controller/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/api_controller/model_controller/">
 
       <link rel="icon" href="../../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
@@ -903,7 +903,7 @@ <h1 id="model-apicontroller"><strong>Model APIController</strong></h1>
 <span class="n">api</span><span class="o">.</span><span class="n">register_controllers</span><span class="p">(</span><span class="n">EventModelController</span><span class="p">)</span>
 </code></pre></div>
 <p>Model Controllers require the <code>ninja-schema</code> package for auto schema generation, which can be installed with:
-<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>ninja-schema
+<div class="highlight"><pre><span></span><code>pip install ninja-schema
 </code></pre></div></p>
 <h2 id="model-configuration"><strong>Model Configuration</strong></h2>
 <p><code>ModelConfig</code> is a Pydantic schema used for validating and configuring Model Controller behaviors. Configuration options include:</p>
@@ -981,15 +981,15 @@ <h2 id="more-on-model-controller-operations"><strong>More on Model Controller Op
 
     <span class="nd">@http_get</span><span class="p">(</span><span class="s1">&#39;/subtract&#39;</span><span class="p">,)</span>
     <span class="k">def</span> <span class="nf">subtract</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Subtracts a from b&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;Subtracts a from b&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="n">a</span> <span class="o">-</span> <span class="n">b</span><span class="p">}</span>
 </code></pre></div>
 <h2 id="model-service"><strong>Model Service</strong></h2>
 <p>Every model controller has a <code>ModelService</code> instance created during runtime to manage model interaction with the controller. 
 Usually, these model service actions would have been part of the model controller, 
 but they are abstracted to a service to allow a more dynamic approach.</p>
 <p><div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">ModelService</span><span class="p">(</span><span class="n">ModelServiceBase</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Model Service for Model Controller model CRUD operations with simple logic for simple models.</span>
 
 <span class="sd">    It&#39;s advised to override this class if you have a complex model.</span>

index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/">
 
       <link rel="icon" href="assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
@@ -863,17 +863,17 @@ <h2 id="usage">Usage</h2>
 
     <span class="nd">@http_get</span><span class="p">(</span><span class="s1">&#39;/subtract&#39;</span><span class="p">,)</span>
     <span class="k">def</span> <span class="nf">subtract</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Subtracts a from b&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;Subtracts a from b&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="n">a</span> <span class="o">-</span> <span class="n">b</span><span class="p">}</span>
 
     <span class="nd">@http_get</span><span class="p">(</span><span class="s1">&#39;/divide&#39;</span><span class="p">,)</span>
     <span class="k">def</span> <span class="nf">divide</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Divides a by b&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;Divides a by b&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="n">a</span> <span class="o">/</span> <span class="n">b</span><span class="p">}</span>
 
     <span class="nd">@http_get</span><span class="p">(</span><span class="s1">&#39;/multiple&#39;</span><span class="p">,)</span>
     <span class="k">def</span> <span class="nf">multiple</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">b</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
-<span class="w">        </span><span class="sd">&quot;&quot;&quot;Multiples a with b&quot;&quot;&quot;</span>
+        <span class="sd">&quot;&quot;&quot;Multiples a with b&quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="p">{</span><span class="s2">&quot;result&quot;</span><span class="p">:</span> <span class="n">a</span> <span class="o">*</span> <span class="n">b</span><span class="p">}</span>
 
 <span class="n">api</span><span class="o">.</span><span class="n">register_controllers</span><span class="p">(</span>

route_context/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/route_context/">
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 
@@ -781,7 +781,7 @@ <h1>RouteContext</h1>
 <div class="highlight"><pre><span></span><code><span class="kn">from</span> <span class="nn">pydantic</span> <span class="kn">import</span> <span class="n">BaseModel</span> <span class="k">as</span> <span class="n">PydanticModel</span><span class="p">,</span> <span class="n">Field</span>
 
 <span class="k">class</span> <span class="nc">RouteContext</span><span class="p">(</span><span class="n">PydanticModel</span><span class="p">):</span>
-<span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+    <span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    APIController Context which will be available to the class instance when handling request</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 

service_module_injector/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/service_module_injector/">
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">
 
 
 

settings/index.html

@@ -14,7 +14,7 @@
         <link rel="canonical" href="https://eadwincode.github.io/django-ninja-extra/settings/">
 
       <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-7.3.6">
+      <meta name="generator" content="mkdocs-1.4.2, mkdocs-material-7.3.6">