nautobot 2.3.15b1__py3-none-any.whl → 2.4.0__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/api.html

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.48">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
     
     
       
@@ -2112,6 +2112,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Networks and Controllers
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -3944,6 +3965,27 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/dcim/virtualdevicecontext.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Virtual Device Context
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4556,6 +4598,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_9" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../../user-guide/core-data-model/wireless/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    Wireless
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_2_3_9" id="__nav_2_3_9_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_3_9_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_3_9">
+            <span class="md-nav__icon md-icon"></span>
+            Wireless
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/supporteddatarate.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Supported Data Rate
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/radioprofile.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Radio Profile
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../user-guide/core-data-model/wireless/wirelessnetwork.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Wireless Network
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -4767,6 +4926,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/events.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Event Notifications
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/exporttemplate.html" class="md-nav__link">
         
@@ -4841,7 +5021,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
         
           
           
@@ -4857,14 +5037,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_9" id="__nav_2_4_9_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_10" id="__nav_2_4_10_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_9_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_9">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_10_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_10">
             <span class="md-nav__icon md-icon"></span>
             GraphQL
           </label>
@@ -4937,7 +5117,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_12" >
         
           
           
@@ -4953,14 +5133,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_11" id="__nav_2_4_11_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_12" id="__nav_2_4_12_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_11_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_11">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_12_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_12">
             <span class="md-nav__icon md-icon"></span>
             Jobs
           </label>
@@ -4972,6 +5152,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Kubernetes Job Support
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -5035,6 +5236,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/jobs/jobqueue.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Job Queues
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/jobs/job-scheduling-and-approvals.html" class="md-nav__link">
         
@@ -5148,6 +5370,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/platform-functionality/rendering-jinja-templates.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Rendering Jinja Templates
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     
     
     
@@ -5159,7 +5402,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_16" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_18" >
         
           
           
@@ -5175,14 +5418,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_2_4_16" id="__nav_2_4_16_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_2_4_18" id="__nav_2_4_18_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_16_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_16">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_18_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_18">
             <span class="md-nav__icon md-icon"></span>
             REST API
           </label>
@@ -5402,10 +5645,10 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_23" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_25" >
         
           
-          <label class="md-nav__link" for="__nav_2_4_23" id="__nav_2_4_23_label" tabindex="0">
+          <label class="md-nav__link" for="__nav_2_4_25" id="__nav_2_4_25_label" tabindex="0">
             
   
   <span class="md-ellipsis">
@@ -5416,8 +5659,8 @@
             <span class="md-nav__icon md-icon"></span>
           </label>
         
-        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_23_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_2_4_23">
+        <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_25_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_2_4_25">
             <span class="md-nav__icon md-icon"></span>
             Users
           </label>
@@ -6822,15 +7065,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="md-nav__link">
-    <span class="md-ellipsis">
-      determine_view_options
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6840,15 +7074,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_additional_detail_view_tabs
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6941,15 +7166,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#nautobot.apps.api.GetObjectCountsView" class="md-nav__link">
-    <span class="md-ellipsis">
-      GetObjectCountsView
-    </span>
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -6978,6 +7194,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.api.ModelViewSetMixin.get_queryset" class="md-nav__link">
+    <span class="md-ellipsis">
+      get_queryset
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -7742,11 +7967,11 @@
   
   
     <li class="md-nav__item">
-      <a href="exceptions.html" class="md-nav__link">
+      <a href="events.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    nautobot.apps.exceptions
+    nautobot.apps.events
   </span>
   
 
@@ -7763,11 +7988,11 @@
   
   
     <li class="md-nav__item">
-      <a href="factory.html" class="md-nav__link">
+      <a href="exceptions.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    nautobot.apps.factory
+    nautobot.apps.exceptions
   </span>
   
 
@@ -7784,11 +8009,32 @@
   
   
     <li class="md-nav__item">
-      <a href="filters.html" class="md-nav__link">
+      <a href="factory.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    nautobot.apps.filters
+    nautobot.apps.factory
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="filters.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    nautobot.apps.filters
   </span>
   
 
@@ -8289,6 +8535,123 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    
+    
+    
+      
+      
+    
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+        
+        
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9_5" >
+        
+          
+          
+          <div class="md-nav__link md-nav__container">
+            <a href="../../../development/apps/migration/ui-component-framework/index.html" class="md-nav__link ">
+              
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+            </a>
+            
+              
+              <label class="md-nav__link " for="__nav_3_2_9_5" id="__nav_3_2_9_5_label" tabindex="0">
+                <span class="md-nav__icon md-icon"></span>
+              </label>
+            
+          </div>
+        
+        <nav class="md-nav" data-md-level="4" aria-labelledby="__nav_3_2_9_5_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_3_2_9_5">
+            <span class="md-nav__icon md-icon"></span>
+            UI Component Framework
+          </label>
+          <ul class="md-nav__list" data-md-scrollfix>
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/migration-steps.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Migration steps
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/custom-content.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Custom content
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/best-practices.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Best practices
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+          </ul>
+        </nav>
+      
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -8634,6 +8997,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Minikube Dev Environment for K8s Jobs
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/core/model-checklist.html" class="md-nav__link">
         
@@ -8823,6 +9207,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/core/ui-component-framework.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    UI Component Framework
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/core/release-checklist.html" class="md-nav__link">
         
@@ -8905,6 +9310,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.4.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Version 2.4
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.3.html" class="md-nav__link">
         
@@ -9563,15 +9989,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="md-nav__link">
-    <span class="md-ellipsis">
-      determine_view_options
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -9581,15 +9998,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="md-nav__link">
-    <span class="md-ellipsis">
-      get_additional_detail_view_tabs
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -9682,15 +10090,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#nautobot.apps.api.GetObjectCountsView" class="md-nav__link">
-    <span class="md-ellipsis">
-      GetObjectCountsView
-    </span>
-  </a>
-  
 </li>
       
         <li class="md-nav__item">
@@ -9719,6 +10118,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.api.ModelViewSetMixin.get_queryset" class="md-nav__link">
+    <span class="md-ellipsis">
+      get_queryset
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -10392,7 +10800,12 @@
 
     <div class="doc doc-contents first">
 
-      <p>Helpers for an app to implement a REST API.</p>
+        <p>Helpers for an app to implement a REST API.</p>
+
+
+
+
+
 
 
 
@@ -10418,10 +10831,15 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.NautobotAPIVersionMixin" optional hover>NautobotAPIVersionMixin</autoref></code>, <code><autoref identifier="rest_framework.routers.APIRootView" optional hover>APIRootView</autoref></code></p>
+              Bases: <code><span title="nautobot.core.api.views.NautobotAPIVersionMixin">NautobotAPIVersionMixin</span></code>, <code><span title="rest_framework.routers.APIRootView">APIRootView</span></code></p>
+
+
+        <p>Extends DRF's base APIRootView class to enforce user authentication.</p>
+
+
+
 
 
-      <p>Extends DRF's base APIRootView class to enforce user authentication.</p>
 
 
 
@@ -10457,10 +10875,10 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.OptInFieldsMixin" optional hover>OptInFieldsMixin</autoref></code>, <code><autoref identifier="rest_framework.serializers.HyperlinkedModelSerializer" optional hover>HyperlinkedModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.OptInFieldsMixin" href="#nautobot.apps.api.OptInFieldsMixin">OptInFieldsMixin</a></code>, <code><span title="rest_framework.serializers.HyperlinkedModelSerializer">HyperlinkedModelSerializer</span></code></p>
 
 
-      <p>This base serializer implements common fields and logic for all ModelSerializers.</p>
+        <p>This base serializer implements common fields and logic for all ModelSerializers.</p>
 <p>Namely, it:</p>
 <ul>
 <li>defines the <code>display</code> field which exposes a human friendly value for the given object.</li>
@@ -10477,6 +10895,11 @@
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -10501,7 +10924,7 @@
 
     <div class="doc doc-contents ">
 
-      <p>Return whether this is a nested serializer.</p>
+        <p>Return whether this is a nested serializer.</p>
     </div>
 
 </div>
@@ -10519,7 +10942,7 @@
 
     <div class="doc doc-contents ">
 
-      <p>Instantiate a BaseModelSerializer.</p>
+        <p>Instantiate a BaseModelSerializer.</p>
 <p>The force_csv kwarg allows you to force _is_csv_request() to evaluate True without passing a Request object,
 which is necessary to be able to export appropriately structured CSV from a Job that doesn't have a Request.</p>
 
@@ -10538,7 +10961,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
     <div class="doc doc-contents ">
 
-      <p>Return a two tuple of (cls, kwargs) to build a serializer field with.</p>
+        <p>Return a two tuple of (cls, kwargs) to build a serializer field with.</p>
 
     </div>
 
@@ -10555,7 +10978,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
     <div class="doc doc-contents ">
 
-      <p>Create a property field for model methods and properties.</p>
+        <p>Create a property field for model methods and properties.</p>
 
     </div>
 
@@ -10572,7 +10995,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
     <div class="doc doc-contents ">
 
-      <p>Override DRF's default relational-field construction to be app-aware.</p>
+        <p>Override DRF's default relational-field construction to be app-aware.</p>
 
     </div>
 
@@ -10589,24 +11012,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
     <div class="doc doc-contents ">
 
-      <p>Override DRF's default 'url' field construction to be app-aware.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="nautobot.apps.api.BaseModelSerializer.determine_view_options" class="doc doc-heading">
-            <code class="highlight language-python"><span class="n">determine_view_options</span><span class="p">(</span><span class="n">request</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
-
-<a href="#nautobot.apps.api.BaseModelSerializer.determine_view_options" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-    <div class="doc doc-contents ">
-
-      <p>Determine view options to use for rendering the list and detail views associated with this serializer.</p>
+        <p>Override DRF's default 'url' field construction to be app-aware.</p>
 
     </div>
 
@@ -10623,49 +11029,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
     <div class="doc doc-contents ">
 
-      <p>Prepend or append the given field_name to <code>fields</code> and optionally self.Meta.opt_in_fields as well.</p>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-function">
-
-
-<h3 id="nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="doc doc-heading">
-            <code class="highlight language-python"><span class="n">get_additional_detail_view_tabs</span><span class="p">()</span></code>
-
-<a href="#nautobot.apps.api.BaseModelSerializer.get_additional_detail_view_tabs" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-    <div class="doc doc-contents ">
-
-      <p>Retrieve definitions of non-default detail view tabs.</p>
-<p>By default provides an "Advanced" tab containing <code>self.advanced_tab_fields</code>, but subclasses
-can override this to move additional serializer fields to this or other tabs.</p>
-
-
-    <p><span class="doc-section-title">Returns:</span></p>
-    <table>
-      <thead>
-        <tr>
-          <th>Type</th>
-          <th>Description</th>
-        </tr>
-      </thead>
-      <tbody>
-          <tr class="doc-section-item">
-            <td>
-                  <code><autoref identifier="dict" optional>dict</autoref></code>
-            </td>
-            <td>
-              <div class="doc-md-description">
-                <p><code>{&lt;tab label&gt;: [{&lt;panel label&gt;: {"fields": [&lt;list of fields&gt;]}, ...}, ...], ...}</code></p>
-              </div>
-            </td>
-          </tr>
-      </tbody>
-    </table>
+        <p>Prepend or append the given field_name to <code>fields</code> and optionally self.Meta.opt_in_fields as well.</p>
 
     </div>
 
@@ -10682,7 +11046,7 @@ can override this to move additional serializer fields to this or other tabs.</p
 
     <div class="doc doc-contents ">
 
-      <p>Return either the <code>display</code> property of the instance or <code>str(instance)</code></p>
+        <p>Return either the <code>display</code> property of the instance or <code>str(instance)</code></p>
 
     </div>
 
@@ -10699,7 +11063,7 @@ can override this to move additional serializer fields to this or other tabs.</p
 
     <div class="doc doc-contents ">
 
-      <p>Override get_field_names() to add some custom logic.</p>
+        <p>Override get_field_names() to add some custom logic.</p>
 <p>Assuming that we follow the pattern where <code>fields = "__all__" for the vast majority of serializers in Nautobot,
 we do not strictly need to use this method to protect against inadvertently omitting standard fields
 like</code>display<code>,</code>created<code>, and</code>last_updated`. However, we continue to do as a bit of redundant safety.</p>
@@ -10732,7 +11096,7 @@ way of <em>excluding</em> fields that we <em>don't</em> want to include by defau
     <div class="doc doc-contents ">
 
 
-      <p>Support bulk deletion of objects using the list endpoint for a model. Accepts a DELETE action with a list of one
+        <p>Support bulk deletion of objects using the list endpoint for a model. Accepts a DELETE action with a list of one
 or more JSON objects, each specifying the UUID of an object to be deleted. For example:</p>
 <p>DELETE /api/dcim/locations/
 [
@@ -10743,6 +11107,11 @@ or more JSON objects, each specifying the UUID of an object to be deleted. For e
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -10775,7 +11144,7 @@ or more JSON objects, each specifying the UUID of an object to be deleted. For e
     <div class="doc doc-contents ">
 
 
-      <p>Support bulk modification of objects using the list endpoint for a model. Accepts a PATCH action with a list of one
+        <p>Support bulk modification of objects using the list endpoint for a model. Accepts a PATCH action with a list of one
 or more JSON objects, each specifying the UUID of an object to be updated as well as the attributes to be set.
 For example:</p>
 <p>PATCH /api/dcim/locations/
@@ -10793,6 +11162,11 @@ For example:</p>
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -10824,16 +11198,21 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.serializers.Field" optional hover>Field</autoref></code></p>
+              Bases: <code><span title="rest_framework.serializers.Field">Field</span></code></p>
 
 
-      <p>Represent a ChoiceField as {'value': <DB value>, 'label': <string>}. Accepts a single value on write.</p>
+        <p>Represent a ChoiceField as {'value': <DB value>, 'label': <string>}. Accepts a single value on write.</p>
 <p>:param choices: An iterable of choices in the form (value, key).
 :param allow_blank: Allow blank values in addition to the listed choices.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -10865,10 +11244,15 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.relations.RelatedField" optional hover>RelatedField</autoref></code></p>
+              Bases: <code><span title="rest_framework.relations.RelatedField">RelatedField</span></code></p>
+
+
+        <p>Represent a ContentType as '<app_label>.<model>'</p>
+
+
+
 
 
-      <p>Represent a ContentType as '<app_label>.<model>'</p>
 
 
 
@@ -10904,10 +11288,15 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.ValidatedModelSerializer" optional hover>ValidatedModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.ValidatedModelSerializer" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
+
+
+        <p>Extends ModelSerializer to render any CustomFields and their values associated with an object.</p>
+
+
+
 
 
-      <p>Extends ModelSerializer to render any CustomFields and their values associated with an object.</p>
 
 
 
@@ -10933,7 +11322,7 @@ For example:</p>
 
     <div class="doc doc-contents ">
 
-      <p>Ensure that "custom_fields" and "computed_fields" are included appropriately.</p>
+        <p>Ensure that "custom_fields" and "computed_fields" are included appropriately.</p>
 
     </div>
 
@@ -10960,50 +11349,15 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.ModelViewSet" optional hover>ModelViewSet</autoref></code></p>
-
-
-      <p>Include the applicable set of CustomFields in the ModelViewSet context.</p>
-
-
-
-
-  <div class="doc doc-children">
-
-
-
-
-
-
-
-
-
-
-
-  </div>
-
-    </div>
-
-</div>
-
-<div class="doc doc-object doc-class">
-
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.ModelViewSet" href="#nautobot.apps.api.ModelViewSet">ModelViewSet</a></code></p>
 
 
-<h2 id="nautobot.apps.api.GetObjectCountsView" class="doc doc-heading">
-            <code>nautobot.apps.api.GetObjectCountsView</code>
+        <p>Include the applicable set of CustomFields in the ModelViewSet context.</p>
 
 
-<a href="#nautobot.apps.api.GetObjectCountsView" class="headerlink" title="Permanent link">&para;</a></h2>
 
 
-    <div class="doc doc-contents ">
-            <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.NautobotAPIVersionMixin" optional hover>NautobotAPIVersionMixin</autoref></code>, <code><autoref identifier="rest_framework.views.APIView" optional hover>APIView</autoref></code></p>
-
 
-      <p>Enumerate the models listed on the Nautobot home page and return data structure
-containing verbose_name_plural, url and count.</p>
 
 
 
@@ -11039,10 +11393,15 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.NautobotAPIVersionMixin" optional hover>NautobotAPIVersionMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.views.BulkUpdateModelMixin" optional hover>BulkUpdateModelMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.views.BulkDestroyModelMixin" optional hover>BulkDestroyModelMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.views.ModelViewSetMixin" optional hover>ModelViewSetMixin</autoref></code>, <code><autoref identifier="rest_framework.viewsets.ModelViewSet" optional hover>ModelViewSet</autoref></code></p>
+              Bases: <code><span title="nautobot.core.api.views.NautobotAPIVersionMixin">NautobotAPIVersionMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.BulkUpdateModelMixin" href="#nautobot.apps.api.BulkUpdateModelMixin">BulkUpdateModelMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.BulkDestroyModelMixin" href="#nautobot.apps.api.BulkDestroyModelMixin">BulkDestroyModelMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.ModelViewSetMixin" href="#nautobot.apps.api.ModelViewSetMixin">ModelViewSetMixin</a></code>, <code><span title="rest_framework.viewsets.ModelViewSet">ModelViewSet</span></code></p>
+
+
+        <p>Extend DRF's ModelViewSet to support bulk update and delete functions.</p>
+
+
+
 
 
-      <p>Extend DRF's ModelViewSet to support bulk update and delete functions.</p>
 
 
 
@@ -11082,6 +11441,11 @@ containing verbose_name_plural, url and count.</p>
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -11103,7 +11467,25 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Extend rest_framework.generics.GenericAPIView.get_object to allow "pk" lookups to use a composite-key.</p>
+        <p>Extend rest_framework.generics.GenericAPIView.get_object to allow "pk" lookups to use a composite-key.</p>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
+<h3 id="nautobot.apps.api.ModelViewSetMixin.get_queryset" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">get_queryset</span><span class="p">()</span></code>
+
+<a href="#nautobot.apps.api.ModelViewSetMixin.get_queryset" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Attempt to optimize the queryset based on the fields present in the associated serializer.</p>
+<p>See similar logic in nautobot.core.tables.BaseTable.</p>
 
     </div>
 
@@ -11120,7 +11502,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Runs anything that needs to occur prior to calling the method handler.</p>
+        <p>Runs anything that needs to occur prior to calling the method handler.</p>
 <p>Override of internal Django Rest Framework API.</p>
 
     </div>
@@ -11138,7 +11520,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Restrict the view's queryset to allow only the permitted objects for the given request.</p>
+        <p>Restrict the view's queryset to allow only the permitted objects for the given request.</p>
 <p>Subclasses (such as nautobot.extras.api.views.JobModelViewSet) may wish to override this.</p>
 <p>Called by initial(), below.</p>
 
@@ -11167,10 +11549,15 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.serializers.MultipleChoiceField" optional hover>MultipleChoiceField</autoref></code></p>
+              Bases: <code><span title="rest_framework.serializers.MultipleChoiceField">MultipleChoiceField</span></code></p>
+
+
+        <p>A MultipleChoiceField that renders the received value as a JSON-compatible list rather than a set.</p>
+
+
+
 
 
-      <p>A MultipleChoiceField that renders the received value as a JSON-compatible list rather than a set.</p>
 
 
 
@@ -11196,7 +11583,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Overload default choices handling to also accept a callable.</p>
+        <p>Overload default choices handling to also accept a callable.</p>
 
     </div>
 
@@ -11223,10 +11610,15 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="drf_spectacular.openapi.AutoSchema" optional hover>AutoSchema</autoref></code></p>
+              Bases: <code><span title="drf_spectacular.openapi.AutoSchema">AutoSchema</span></code></p>
+
+
+        <p>Nautobot-specific extensions to drf-spectacular's AutoSchema.</p>
+
+
+
 
 
-      <p>Nautobot-specific extensions to drf-spectacular's AutoSchema.</p>
 
 
 
@@ -11255,7 +11647,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Custom property for convenience.</p>
+        <p>Custom property for convenience.</p>
     </div>
 
 </div>
@@ -11276,7 +11668,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Custom property for convenience.</p>
+        <p>Custom property for convenience.</p>
     </div>
 
 </div>
@@ -11294,7 +11686,7 @@ containing verbose_name_plural, url and count.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Get the appropriate description for a given API endpoint.</p>
+        <p>Get the appropriate description for a given API endpoint.</p>
 <p>By default, if a specific action doesn't have its own docstring, and neither does the view class,
 drf-spectacular will walk up the MRO of the view class until it finds a docstring, and use that.
 Most of our viewsets (for better or for worse) do not have docstrings, and so it'll find and use the generic
@@ -11317,7 +11709,7 @@ make an attempt at rendering a basically accurate default description.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Nautobot's custom bulk operations, even though they return a list of records, are NOT filterable.</p>
+        <p>Nautobot's custom bulk operations, even though they return a list of records, are NOT filterable.</p>
 
     </div>
 
@@ -11334,7 +11726,7 @@ make an attempt at rendering a basically accurate default description.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Extend the base method to handle Nautobot's REST API bulk operations.</p>
+        <p>Extend the base method to handle Nautobot's REST API bulk operations.</p>
 <p>Without this extension, every one of our ModelViewSet classes will result in drf-spectacular complaining
 about operationId collisions, e.g. between DELETE /api/dcim/devices/ and DELETE /api/dcim/devices/<pk>/ would
 both get resolved to the same "dcim_devices_destroy" operation-id and this would make drf-spectacular complain.</p>
@@ -11355,7 +11747,7 @@ both get resolved to the same "dcim_devices_destroy" operation-id and this would
 
     <div class="doc doc-contents ">
 
-      <p>Return the request serializer (used for describing/parsing the request payload) for this endpoint.</p>
+        <p>Return the request serializer (used for describing/parsing the request payload) for this endpoint.</p>
 <p>We override the default drf-spectacular behavior for the case where the endpoint describes a write request
 with required data (PATCH, POST, PUT). In those cases we replace FooSerializer with a dynamically-defined
 WritableFooSerializer class in order to more accurately represent the available options on write.</p>
@@ -11377,7 +11769,7 @@ require a list of serializers as input, rather than a single one.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Return the response serializer (used for describing the response payload) for this endpoint.</p>
+        <p>Return the response serializer (used for describing the response payload) for this endpoint.</p>
 <p>We override the default drf-spectacular behavior for the case where the endpoint describes a write request
 to a bulk endpoint, which returns a list of serializers, rather than a single one.</p>
 
@@ -11396,7 +11788,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
 
     <div class="doc doc-contents ">
 
-      <p>Get the serializer's ref_name Meta attribute if set, or else derive a ref_name automatically.</p>
+        <p>Get the serializer's ref_name Meta attribute if set, or else derive a ref_name automatically.</p>
 <p>Based on drf_yasg.utils.get_serializer_ref_name().</p>
 
     </div>
@@ -11414,7 +11806,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
 
     <div class="doc doc-contents ">
 
-      <p>Given a FooSerializer instance, look up or construct a [Bulk]WritableFooSerializer class if necessary.</p>
+        <p>Given a FooSerializer instance, look up or construct a [Bulk]WritableFooSerializer class if necessary.</p>
 <p>If no [Bulk]WritableFooSerializer class is needed, returns None instead.</p>
 
     </div>
@@ -11432,7 +11824,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
 
     <div class="doc doc-contents ">
 
-      <p>Re-add required <code>id</code> field on bulk_partial_update action.</p>
+        <p>Re-add required <code>id</code> field on bulk_partial_update action.</p>
 <p>drf-spectacular clears the <code>required</code> list for any partial serializers in its <code>_map_basic_serializer()</code>,
 but Nautobot bulk partial updates require the <code>id</code> field to be specified for each object to update.</p>
 
@@ -11461,10 +11853,15 @@ but Nautobot bulk partial updates require the <code>id</code> field to be specif
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.parsers.BaseParser" optional hover>BaseParser</autoref></code></p>
+              Bases: <code><span title="rest_framework.parsers.BaseParser">BaseParser</span></code></p>
+
+
+        <p>Counterpart to NautobotCSVRenderer - import CSV data.</p>
+
+
+
 
 
-      <p>Counterpart to NautobotCSVRenderer - import CSV data.</p>
 
 
 
@@ -11490,7 +11887,7 @@ but Nautobot bulk partial updates require the <code>id</code> field to be specif
 
     <div class="doc doc-contents ">
 
-      <p>Parse a single row of CSV data (represented as a dict) into a dict suitable for consumption by the serializer.</p>
+        <p>Parse a single row of CSV data (represented as a dict) into a dict suitable for consumption by the serializer.</p>
 <p>TODO: it would be more elegant if our serializer fields knew how to deserialize the CSV data themselves;
 could we then literally have the parser just return list(reader) and not need this function at all?</p>
 
@@ -11519,10 +11916,15 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.mixins.WritableSerializerMixin" optional hover>WritableSerializerMixin</autoref></code>, <code><autoref identifier="rest_framework.serializers.HyperlinkedRelatedField" optional hover>HyperlinkedRelatedField</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.mixins.WritableSerializerMixin" href="#nautobot.apps.api.WritableSerializerMixin">WritableSerializerMixin</a></code>, <code><span title="rest_framework.serializers.HyperlinkedRelatedField">HyperlinkedRelatedField</span></code></p>
+
+
+        <p>Extend HyperlinkedRelatedField to include URL namespace-awareness, add 'object_type' field, and read composite-keys.</p>
+
+
+
 
 
-      <p>Extend HyperlinkedRelatedField to include URL namespace-awareness, add 'object_type' field, and read composite-keys.</p>
 
 
 
@@ -11548,7 +11950,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Override DRF's namespace-unaware default view_name logic for HyperlinkedRelatedField.</p>
+        <p>Override DRF's namespace-unaware default view_name logic for HyperlinkedRelatedField.</p>
 <p>DRF defaults to '{model_name}-detail' instead of '{app_label}:{model_name}-detail'.</p>
 
     </div>
@@ -11566,7 +11968,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Convert potentially nested representation to a model instance.</p>
+        <p>Convert potentially nested representation to a model instance.</p>
 
     </div>
 
@@ -11583,7 +11985,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Convert URL representation to a brief nested representation.</p>
+        <p>Convert URL representation to a brief nested representation.</p>
 
     </div>
 
@@ -11610,15 +12012,20 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.RelationshipModelSerializerMixin" optional hover>RelationshipModelSerializerMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.serializers.CustomFieldModelSerializerMixin" optional hover>CustomFieldModelSerializerMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.serializers.NotesSerializerMixin" optional hover>NotesSerializerMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.serializers.ValidatedModelSerializer" optional hover>ValidatedModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.RelationshipModelSerializerMixin" href="#nautobot.apps.api.RelationshipModelSerializerMixin">RelationshipModelSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.CustomFieldModelSerializerMixin" href="#nautobot.apps.api.CustomFieldModelSerializerMixin">CustomFieldModelSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.NotesSerializerMixin" href="#nautobot.apps.api.NotesSerializerMixin">NotesSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.ValidatedModelSerializer" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
 
 
-      <p>Base class to use for serializers based on OrganizationalModel or PrimaryModel.</p>
+        <p>Base class to use for serializers based on OrganizationalModel or PrimaryModel.</p>
 <p>Can also be used for models derived from BaseModel, so long as they support custom fields, notes, and relationships.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -11650,15 +12057,20 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.extras.api.views.NotesViewSetMixin" optional hover>NotesViewSetMixin</autoref></code>, <code><autoref identifier="nautobot.extras.api.views.CustomFieldModelViewSet" optional hover>CustomFieldModelViewSet</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.extras.api.views.NotesViewSetMixin" href="#nautobot.apps.api.NotesViewSetMixin">NotesViewSetMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.extras.api.views.CustomFieldModelViewSet" href="#nautobot.apps.api.CustomFieldModelViewSet">CustomFieldModelViewSet</a></code></p>
 
 
-      <p>Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.</p>
+        <p>Base class to use for API ViewSets based on OrganizationalModel or PrimaryModel.</p>
 <p>Can also be used for models derived from BaseModel, so long as they support Notes.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -11690,10 +12102,15 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.BaseModelSerializer" optional hover>BaseModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+
+
+        <p>Extend Serializer with a <code>notes</code> field.</p>
+
+
+
 
 
-      <p>Extend Serializer with a <code>notes</code> field.</p>
 
 
 
@@ -11719,7 +12136,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Ensure that fields includes "notes_url" field if applicable.</p>
+        <p>Ensure that fields includes "notes_url" field if applicable.</p>
 
     </div>
 
@@ -11750,6 +12167,11 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -11772,10 +12194,15 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.authentication.TokenPermissions" optional hover>TokenPermissions</autoref></code></p>
+              Bases: <code><span title="nautobot.core.api.authentication.TokenPermissions">TokenPermissions</span></code></p>
+
+
+        <p>As nautobot.core.api.authentication.TokenPermissions, but enforcing add_note permission.</p>
+
+
+
 
 
-      <p>As nautobot.core.api.authentication.TokenPermissions, but enforcing add_note permission.</p>
 
 
 
@@ -11810,7 +12237,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>API methods for returning or creating notes on an object.</p>
+        <p>API methods for returning or creating notes on an object.</p>
 
     </div>
 
@@ -11827,7 +12254,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Apply "view" permissions on the POST /notes/ endpoint, otherwise as ModelViewSetMixin.</p>
+        <p>Apply "view" permissions on the POST /notes/ endpoint, otherwise as ModelViewSetMixin.</p>
 
     </div>
 
@@ -11854,10 +12281,15 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.serializers.CharField" optional hover>CharField</autoref></code></p>
+              Bases: <code><span title="rest_framework.serializers.CharField">CharField</span></code></p>
+
+
+        <p>Represent the ContentType of this serializer's model as "<app_label>.<model>".</p>
+
+
+
 
 
-      <p>Represent the ContentType of this serializer's model as "<app_label>.<model>".</p>
 
 
 
@@ -11883,7 +12315,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Default read_only to True as this should never be a writable field.</p>
+        <p>Default read_only to True as this should never be a writable field.</p>
 
     </div>
 
@@ -11900,7 +12332,7 @@ could we then literally have the parser just return list(reader) and not need th
 
     <div class="doc doc-contents ">
 
-      <p>Get the content-type of this serializer's model.</p>
+        <p>Get the content-type of this serializer's model.</p>
 <p>Implemented this way because <code>_value</code> may be None when generating the schema.</p>
 
     </div>
@@ -11929,8 +12361,13 @@ could we then literally have the parser just return list(reader) and not need th
     <div class="doc doc-contents ">
 
 
-      <p>A serializer mixin that takes an additional <code>opt_in_fields</code> argument that controls
-which fields should be displayed.</p>
+        <p>Serializer mixin that adjusts its fields based on the <code>include</code> and <code>exclude_m2m</code> query parameters in a request.</p>
+<p>The serializer's <code>Meta.opt_in_fields</code> controls which fields are influenced by <code>include</code>.</p>
+
+
+
+
+
 
 
 
@@ -11959,8 +12396,12 @@ which fields should be displayed.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Removes all serializer fields specified in a serializers <code>opt_in_fields</code> list that aren't specified in the
-<code>include</code> query parameter.</p>
+        <p>Dynamically adjust the dictionary of fields attributed to this serializer instance.</p>
+<ul>
+<li>Removes all serializer fields specified in <code>Meta.opt_in_fields</code> list that aren't specified in the
+  <code>include</code> query parameter. (applies to GET requests only)</li>
+<li>If the <code>exclude_m2m</code> query parameter is truthy, remove all many-to-many serializer fields for performance.</li>
+</ul>
 <p>As an example, if the serializer specifies that <code>opt_in_fields = ["computed_fields"]</code>
 but <code>computed_fields</code> is not specified in the <code>?include</code> query parameter, <code>computed_fields</code> will be popped
 from the list of fields.</p>
@@ -11991,7 +12432,12 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.routers.DefaultRouter" optional hover>DefaultRouter</autoref></code></p>
+              Bases: <code><span title="rest_framework.routers.DefaultRouter">DefaultRouter</span></code></p>
+
+
+
+
+
 
 
 
@@ -12018,7 +12464,7 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Wrap DRF's DefaultRouter to return an alphabetized list of endpoints.</p>
+        <p>Wrap DRF's DefaultRouter to return an alphabetized list of endpoints.</p>
 
     </div>
 
@@ -12035,7 +12481,7 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Override DRF's BaseRouter.register() to bypass an unnecessary restriction added in version 3.15.0.</p>
+        <p>Override DRF's BaseRouter.register() to bypass an unnecessary restriction added in version 3.15.0.</p>
 <p>(Reference: https://github.com/encode/django-rest-framework/pull/8438)</p>
 
     </div>
@@ -12063,10 +12509,15 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.views.NautobotAPIVersionMixin" optional hover>NautobotAPIVersionMixin</autoref></code>, <code><autoref identifier="nautobot.core.api.views.ModelViewSetMixin" optional hover>ModelViewSetMixin</autoref></code>, <code><autoref identifier="rest_framework.viewsets.ReadOnlyModelViewSet" optional hover>ReadOnlyModelViewSet</autoref></code></p>
+              Bases: <code><span title="nautobot.core.api.views.NautobotAPIVersionMixin">NautobotAPIVersionMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.ModelViewSetMixin" href="#nautobot.apps.api.ModelViewSetMixin">ModelViewSetMixin</a></code>, <code><span title="rest_framework.viewsets.ReadOnlyModelViewSet">ReadOnlyModelViewSet</span></code></p>
+
+
+        <p>Extend DRF's ReadOnlyModelViewSet to support queryset restriction.</p>
+
+
+
 
 
-      <p>Extend DRF's ReadOnlyModelViewSet to support queryset restriction.</p>
 
 
 
@@ -12102,10 +12553,15 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.ValidatedModelSerializer" optional hover>ValidatedModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.ValidatedModelSerializer" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
+
+
+        <p>Extend ValidatedModelSerializer with a <code>relationships</code> field.</p>
+
+
+
 
 
-      <p>Extend ValidatedModelSerializer with a <code>relationships</code> field.</p>
 
 
 
@@ -12131,7 +12587,7 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
 
-      <p>Ensure that "relationships" is included as an opt-in field on root serializers.</p>
+        <p>Ensure that "relationships" is included as an opt-in field on root serializers.</p>
 
     </div>
 
@@ -12158,15 +12614,20 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="rest_framework.relations.PrimaryKeyRelatedField" optional hover>PrimaryKeyRelatedField</autoref></code></p>
+              Bases: <code><span title="rest_framework.relations.PrimaryKeyRelatedField">PrimaryKeyRelatedField</span></code></p>
 
 
-      <p>Extends PrimaryKeyRelatedField to return a serialized object on read. This is useful for representing related
+        <p>Extends PrimaryKeyRelatedField to return a serialized object on read. This is useful for representing related
 objects in a ManyToManyField while still allowing a set of primary keys to be written.</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -12198,7 +12659,12 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.BaseModelSerializer" optional hover>BaseModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+
+
+
+
+
 
 
 
@@ -12225,7 +12691,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
 
-      <p>Ensure that 'tags' field is always present except on nested serializers.</p>
+        <p>Ensure that 'tags' field is always present except on nested serializers.</p>
 
     </div>
 
@@ -12252,10 +12718,15 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="timezone_field.rest_framework.TimeZoneSerializerField" optional hover>TimeZoneSerializerField</autoref></code></p>
+              Bases: <code><span title="timezone_field.rest_framework.TimeZoneSerializerField">TimeZoneSerializerField</span></code></p>
+
+
+        <p>Represents a time zone as a string.</p>
+
+
+
 
 
-      <p>Represents a time zone as a string.</p>
 
 
     </div>
@@ -12275,10 +12746,15 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.BaseModelSerializer" optional hover>BaseModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+
+
+        <p>Add a <code>tree_depth</code> field to non-nested model serializers based on django-tree-queries.</p>
+
+
+
 
 
-      <p>Add a <code>tree_depth</code> field to non-nested model serializers based on django-tree-queries.</p>
 
 
 
@@ -12304,7 +12780,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
 
-      <p>Ensure that "tree_depth" is included on root serializers only, as nested objects are not annotated.</p>
+        <p>Ensure that "tree_depth" is included on root serializers only, as nested objects are not annotated.</p>
 
     </div>
 
@@ -12321,7 +12797,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
 
-      <p>The <code>tree_depth</code> is not a database field, but an annotation automatically added by django-tree-queries.</p>
+        <p>The <code>tree_depth</code> is not a database field, but an annotation automatically added by django-tree-queries.</p>
 
     </div>
 
@@ -12348,15 +12824,20 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.BaseModelSerializer" optional hover>BaseModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
 
 
-      <p>Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
+        <p>Extends the built-in ModelSerializer to enforce calling full_clean() on a copy of the associated instance during
 validation. (DRF does not do this by default; see https://github.com/encode/django-rest-framework/issues/3144)</p>
 
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -12388,10 +12869,10 @@ validation. (DRF does not do this by default; see https://github.com/encode/djan
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><autoref identifier="nautobot.core.api.serializers.BaseModelSerializer" optional hover>BaseModelSerializer</autoref></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
 
 
-      <p>Returns a nested representation of an object on read, but accepts either the nested representation or the
+        <p>Returns a nested representation of an object on read, but accepts either the nested representation or the
 primary key value on write operations.</p>
 <p>Note that subclasses will always have a read-only <code>object_type</code> field, which represents the content-type of this
 serializer's associated model (e.g. "dcim.device"). This is required as the OpenAPI schema, using the
@@ -12401,6 +12882,11 @@ which of several possible nested serializers are in use for a given attribute.</
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -12433,7 +12919,7 @@ which of several possible nested serializers are in use for a given attribute.</
     <div class="doc doc-contents ">
 
 
-      <p>WritableSerializerMixin provides the to_internal_value() function.
+        <p>WritableSerializerMixin provides the to_internal_value() function.
 The function provides the ability to write API requests that identify unique objects based on
 combinations of fields other than the primary key.
 e.g:
@@ -12444,6 +12930,11 @@ vs
 
 
 
+
+
+
+
+
   <div class="doc doc-children">
 
 
@@ -12465,7 +12956,7 @@ vs
 
     <div class="doc doc-contents ">
 
-      <p>Retrieve an unique object based on a dictionary of data attributes and raise errors accordingly if the object is not found.</p>
+        <p>Retrieve an unique object based on a dictionary of data attributes and raise errors accordingly if the object is not found.</p>
 
     </div>
 
@@ -12482,7 +12973,7 @@ vs
 
     <div class="doc doc-contents ">
 
-      <p>Data could be a dictionary and an int (for the User model) or a str that represents the primary key.
+        <p>Data could be a dictionary and an int (for the User model) or a str that represents the primary key.
 If it is a dictionary, we return it after remove non-filter fields.
 If it is a primary key, we return a dictionary object formatted like this {"pk": pk}</p>
 
@@ -12501,7 +12992,7 @@ If it is a primary key, we return a dictionary object formatted like this {"pk":
 
     <div class="doc doc-contents ">
 
-      <p>Make output from a WritableSerializer "round-trip" capable by automatically stripping from the
+        <p>Make output from a WritableSerializer "round-trip" capable by automatically stripping from the
 data any serializer fields that do not correspond to a specific model field</p>
 
     </div>
@@ -12519,7 +13010,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Return an object or a list of objects based on a dictionary of data attributes or an UUID.</p>
+        <p>Return an object or a list of objects based on a dictionary of data attributes or an UUID.</p>
 
     </div>
 
@@ -12545,7 +13036,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Translate a dictionary of attributes to a nested set of parameters suitable for QuerySet filtering. For example:</p>
+        <p>Translate a dictionary of attributes to a nested set of parameters suitable for QuerySet filtering. For example:</p>
 <div class="highlight"><pre><span></span><code>{
     &quot;name&quot;: &quot;Foo&quot;,
     &quot;rack&quot;: {
@@ -12578,7 +13069,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Dynamically import a class from an absolute path string</p>
+        <p>Dynamically import a class from an absolute path string</p>
 
     </div>
 
@@ -12595,7 +13086,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Returns the serializer of an api_version</p>
+        <p>Returns the serializer of an api_version</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -12610,9 +13101,11 @@ data any serializer fields that do not correspond to a specific model field</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>serializer_choices</code></td>
             <td>
-                  <code><autoref identifier="tuple" optional>tuple</autoref></code>
+                <code>serializer_choices</code>
+            </td>
+            <td>
+                  <code>tuple</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12624,9 +13117,11 @@ data any serializer fields that do not correspond to a specific model field</p>
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>api_version</code></td>
             <td>
-                  <code><autoref identifier="str" optional>str</autoref></code>
+                <code>api_version</code>
+            </td>
+            <td>
+                  <code>str</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12652,7 +13147,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code><autoref identifier="Serializer" optional>Serializer</autoref></code>
+                  <code>Serializer</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12678,7 +13173,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Dynamically resolve and return the appropriate serializer for a model.</p>
+        <p>Dynamically resolve and return the appropriate serializer for a model.</p>
 
 
 <p><span class="doc-section-title">Raises:</span></p>
@@ -12692,7 +13187,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code><autoref identifier="SerializerNotFound" optional>SerializerNotFound</autoref></code>
+                  <code>SerializerNotFound</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12718,7 +13213,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Derive the view name from its associated model, if it has one. Fall back to DRF's built-in <code>get_view_name</code>.</p>
+        <p>Derive the view name from its associated model, if it has one. Fall back to DRF's built-in <code>get_view_name</code>.</p>
 
     </div>
 
@@ -12735,7 +13230,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Return True of the request is being made via the REST API.</p>
+        <p>Return True of the request is being made via the REST API.</p>
 
     </div>
 
@@ -12752,7 +13247,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Handle exceptions and return a useful error message for REST API requests.</p>
+        <p>Handle exceptions and return a useful error message for REST API requests.</p>
 
     </div>
 
@@ -12769,7 +13264,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
     <div class="doc doc-contents ">
 
-      <p>Returns appropriate serializer class depending on request api_version, and swagger_fake_view</p>
+        <p>Returns appropriate serializer class depending on request api_version, and swagger_fake_view</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -12784,7 +13279,9 @@ data any serializer fields that do not correspond to a specific model field</p>
       </thead>
       <tbody>
           <tr class="doc-section-item">
-            <td><code>obj</code></td>
+            <td>
+                <code>obj</code>
+            </td>
             <td>
                   <code>ViewSet instance</code>
             </td>
@@ -12798,9 +13295,11 @@ data any serializer fields that do not correspond to a specific model field</p>
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>serializer_choices</code></td>
             <td>
-                  <code><autoref identifier="tuple" optional>tuple</autoref></code>
+                <code>serializer_choices</code>
+            </td>
+            <td>
+                  <code>tuple</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12812,9 +13311,11 @@ data any serializer fields that do not correspond to a specific model field</p>
             </td>
           </tr>
           <tr class="doc-section-item">
-            <td><code>default_serializer</code></td>
             <td>
-                  <code><autoref identifier="Serializer" optional>Serializer</autoref></code>
+                <code>default_serializer</code>
+            </td>
+            <td>
+                  <code>Serializer</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -12982,10 +13483,10 @@ data any serializer fields that do not correspond to a specific model field</p>
     </div>
     
     
-    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
+    <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>