nautobot 2.4.14__py3-none-any.whl → 2.4.16__py3-none-any.whl

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

@@ -9571,6 +9571,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -11841,6 +11864,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11876,6 +11900,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11907,7 +11932,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              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>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.OptInFieldsMixin (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>
@@ -11932,6 +11957,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11957,6 +11983,7 @@
     <div class="doc doc-contents ">
 
         <p>Return whether this is a nested serializer.</p>
+
     </div>
 
 </div>
@@ -11978,6 +12005,7 @@
 <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>
 
+
     </div>
 
 </div>
@@ -11995,6 +12023,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Return a two tuple of (cls, kwargs) to build a serializer field with.</p>
 
+
     </div>
 
 </div>
@@ -12012,6 +12041,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Create a property field for model methods and properties.</p>
 
+
     </div>
 
 </div>
@@ -12029,6 +12059,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Override DRF's default relational-field construction to be app-aware.</p>
 
+
     </div>
 
 </div>
@@ -12046,6 +12077,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Override DRF's default 'url' field construction to be app-aware.</p>
 
+
     </div>
 
 </div>
@@ -12063,6 +12095,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Prepend or append the given field_name to <code>fields</code> and optionally self.Meta.opt_in_fields as well.</p>
 
+
     </div>
 
 </div>
@@ -12080,6 +12113,7 @@ which is necessary to be able to export appropriately structured CSV from a Job
 
         <p>Return either the <code>display</code> property of the instance or <code>str(instance)</code></p>
 
+
     </div>
 
 </div>
@@ -12102,6 +12136,7 @@ like</code>display<code>,</code>created<code>, and</code>last_updated`. However,
 <p>The other purpose of this method now is to manipulate the set of fields that "<strong>all</strong>" actually means as a
 way of <em>excluding</em> fields that we <em>don't</em> want to include by default for performance or data exposure reasons.</p>
 
+
     </div>
 
 </div>
@@ -12144,6 +12179,7 @@ or more JSON objects, each specifying the UUID of an object to be deleted. For e
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12199,6 +12235,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12245,6 +12282,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12289,6 +12327,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12320,7 +12359,7 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.ValidatedModelSerializer" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ValidatedModelSerializer (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>
@@ -12333,6 +12372,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12356,6 +12396,7 @@ For example:</p>
 
         <p>Ensure that "custom_fields" and "computed_fields" are included appropriately.</p>
 
+
     </div>
 
 </div>
@@ -12381,7 +12422,7 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.views.ModelViewSet" href="#nautobot.apps.api.ModelViewSet">ModelViewSet</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ModelViewSet (nautobot.core.api.views.ModelViewSet)" href="#nautobot.apps.api.ModelViewSet">ModelViewSet</a></code></p>
 
 
         <p>Include the applicable set of CustomFields in the ModelViewSet context.</p>
@@ -12394,6 +12435,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12425,7 +12467,7 @@ For example:</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              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>
+              Bases: <code><span title="nautobot.core.api.views.NautobotAPIVersionMixin">NautobotAPIVersionMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BulkUpdateModelMixin (nautobot.core.api.views.BulkUpdateModelMixin)" href="#nautobot.apps.api.BulkUpdateModelMixin">BulkUpdateModelMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BulkDestroyModelMixin (nautobot.core.api.views.BulkDestroyModelMixin)" href="#nautobot.apps.api.BulkDestroyModelMixin">BulkDestroyModelMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ModelViewSetMixin (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>
@@ -12438,6 +12480,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12478,6 +12521,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12501,6 +12545,7 @@ For example:</p>
 
         <p>Extend rest_framework.generics.GenericAPIView.get_object to allow "pk" lookups to use a composite-key.</p>
 
+
     </div>
 
 </div>
@@ -12519,6 +12564,7 @@ For example:</p>
         <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>
 
 </div>
@@ -12537,6 +12583,7 @@ For example:</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>
 
 </div>
@@ -12556,6 +12603,7 @@ For example:</p>
 <p>Subclasses (such as nautobot.extras.api.views.JobModelViewSet) may wish to override this.</p>
 <p>Called by initial(), below.</p>
 
+
     </div>
 
 </div>
@@ -12594,6 +12642,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12617,6 +12666,7 @@ For example:</p>
 
         <p>Overload default choices handling to also accept a callable.</p>
 
+
     </div>
 
 </div>
@@ -12655,6 +12705,7 @@ For example:</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12680,6 +12731,7 @@ For example:</p>
     <div class="doc doc-contents ">
 
         <p>Custom property for convenience.</p>
+
     </div>
 
 </div>
@@ -12701,6 +12753,7 @@ For example:</p>
     <div class="doc doc-contents ">
 
         <p>Custom property for convenience.</p>
+
     </div>
 
 </div>
@@ -12726,6 +12779,7 @@ docstring of the <code>NautobotModelViewSet</code> class, which isn't very usefu
 we only use the docstring of the view itself (ignoring its parent class docstrings), or if none exists, we
 make an attempt at rendering a basically accurate default description.</p>
 
+
     </div>
 
 </div>
@@ -12743,6 +12797,7 @@ make an attempt at rendering a basically accurate default description.</p>
 
         <p>Nautobot's custom bulk operations, even though they return a list of records, are NOT filterable.</p>
 
+
     </div>
 
 </div>
@@ -12764,6 +12819,7 @@ about operationId collisions, e.g. between DELETE /api/dcim/devices/ and DELETE
 both get resolved to the same "dcim_devices_destroy" operation-id and this would make drf-spectacular complain.</p>
 <p>With this extension, the bulk endpoints automatically get a different operation-id from the non-bulk endpoints.</p>
 
+
     </div>
 
 </div>
@@ -12786,6 +12842,7 @@ WritableFooSerializer class in order to more accurately represent the available
 <p>We also override for the case where the endpoint is one of Nautobot's custom bulk API endpoints, which
 require a list of serializers as input, rather than a single one.</p>
 
+
     </div>
 
 </div>
@@ -12805,6 +12862,7 @@ require a list of serializers as input, rather than a single one.</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>
 
+
     </div>
 
 </div>
@@ -12823,6 +12881,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
         <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>
 
 </div>
@@ -12841,6 +12900,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
         <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>
 
 </div>
@@ -12860,6 +12920,7 @@ to a bulk endpoint, which returns a list of serializers, rather than a single on
 <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>
 
+
     </div>
 
 </div>
@@ -12898,6 +12959,7 @@ but Nautobot bulk partial updates require the <code>id</code> field to be specif
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12923,6 +12985,7 @@ but Nautobot bulk partial updates require the <code>id</code> field to be specif
 <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>
 
+
     </div>
 
 </div>
@@ -12948,7 +13011,7 @@ 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><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>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.WritableSerializerMixin (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>
@@ -12961,6 +13024,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12985,6 +13049,7 @@ could we then literally have the parser just return list(reader) and not need th
         <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>
 
 </div>
@@ -13002,6 +13067,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>Convert potentially nested representation to a model instance.</p>
 
+
     </div>
 
 </div>
@@ -13019,6 +13085,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>Convert URL representation to a brief nested representation.</p>
 
+
     </div>
 
 </div>
@@ -13044,7 +13111,7 @@ 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><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>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.RelationshipModelSerializerMixin (nautobot.core.api.serializers.RelationshipModelSerializerMixin)" href="#nautobot.apps.api.RelationshipModelSerializerMixin">RelationshipModelSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.CustomFieldModelSerializerMixin (nautobot.core.api.serializers.CustomFieldModelSerializerMixin)" href="#nautobot.apps.api.CustomFieldModelSerializerMixin">CustomFieldModelSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.NotesSerializerMixin (nautobot.core.api.serializers.NotesSerializerMixin)" href="#nautobot.apps.api.NotesSerializerMixin">NotesSerializerMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ValidatedModelSerializer (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>
@@ -13058,6 +13125,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13089,7 +13157,7 @@ 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><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>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.NotesViewSetMixin (nautobot.extras.api.views.NotesViewSetMixin)" href="#nautobot.apps.api.NotesViewSetMixin">NotesViewSetMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.CustomFieldModelViewSet (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>
@@ -13103,6 +13171,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13134,7 +13203,7 @@ 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><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BaseModelSerializer (nautobot.core.api.serializers.BaseModelSerializer)" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
 
 
         <p>Extend Serializer with a <code>notes</code> field.</p>
@@ -13147,6 +13216,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13170,6 +13240,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>Ensure that fields includes "notes_url" field if applicable.</p>
 
+
     </div>
 
 </div>
@@ -13204,6 +13275,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13239,6 +13311,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13271,6 +13344,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>API methods for returning or creating notes on an object.</p>
 
+
     </div>
 
 </div>
@@ -13288,6 +13362,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>Apply "view" permissions on the POST /notes/ endpoint, otherwise as ModelViewSetMixin.</p>
 
+
     </div>
 
 </div>
@@ -13326,6 +13401,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13349,6 +13425,7 @@ could we then literally have the parser just return list(reader) and not need th
 
         <p>Default read_only to True as this should never be a writable field.</p>
 
+
     </div>
 
 </div>
@@ -13367,6 +13444,7 @@ could we then literally have the parser just return list(reader) and not need th
         <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>
 
 </div>
@@ -13404,6 +13482,7 @@ could we then literally have the parser just return list(reader) and not need th
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13437,6 +13516,7 @@ could we then literally have the parser just return list(reader) and not need th
 <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>
+
     </div>
 
 </div>
@@ -13475,6 +13555,7 @@ from the list of fields.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13498,6 +13579,7 @@ from the list of fields.</p>
 
         <p>Wrap DRF's DefaultRouter to return an alphabetized list of endpoints.</p>
 
+
     </div>
 
 </div>
@@ -13516,6 +13598,7 @@ from the list of fields.</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>
 
 </div>
@@ -13541,7 +13624,7 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              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>
+              Bases: <code><span title="nautobot.core.api.views.NautobotAPIVersionMixin">NautobotAPIVersionMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ModelViewSetMixin (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>
@@ -13554,6 +13637,7 @@ from the list of fields.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13585,7 +13669,7 @@ from the list of fields.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.ValidatedModelSerializer" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.ValidatedModelSerializer (nautobot.core.api.serializers.ValidatedModelSerializer)" href="#nautobot.apps.api.ValidatedModelSerializer">ValidatedModelSerializer</a></code></p>
 
 
         <p>Extend ValidatedModelSerializer with a <code>relationships</code> field.</p>
@@ -13598,6 +13682,7 @@ from the list of fields.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13621,6 +13706,7 @@ from the list of fields.</p>
 
         <p>Ensure that "relationships" is included as an opt-in field on root serializers.</p>
 
+
     </div>
 
 </div>
@@ -13660,6 +13746,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13691,7 +13778,8 @@ 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><a class="autorefs autorefs-internal" title="nautobot.core.api.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BaseModelSerializer (nautobot.core.api.BaseModelSerializer)" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+
 
 
 
@@ -13725,6 +13813,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
         <p>Ensure that 'tags' field is always present except on nested serializers.</p>
 
+
     </div>
 
 </div>
@@ -13761,6 +13850,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
 
 
+
     </div>
 
 </div>
@@ -13778,7 +13868,7 @@ 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><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BaseModelSerializer (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>
@@ -13791,6 +13881,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13814,6 +13905,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
         <p>Ensure that "tree_depth" is included on root serializers only, as nested objects are not annotated.</p>
 
+
     </div>
 
 </div>
@@ -13831,6 +13923,7 @@ objects in a ManyToManyField while still allowing a set of primary keys to be wr
 
         <p>The <code>tree_depth</code> is not a database field, but an annotation automatically added by django-tree-queries.</p>
 
+
     </div>
 
 </div>
@@ -13856,7 +13949,7 @@ 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><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BaseModelSerializer (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
@@ -13870,6 +13963,7 @@ validation. (DRF does not do this by default; see https://github.com/encode/djan
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13901,7 +13995,7 @@ 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><a class="autorefs autorefs-internal" title="nautobot.core.api.serializers.BaseModelSerializer" href="#nautobot.apps.api.BaseModelSerializer">BaseModelSerializer</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.api.BaseModelSerializer (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
@@ -13919,6 +14013,7 @@ which of several possible nested serializers are in use for a given attribute.</
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13967,6 +14062,7 @@ vs
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -13990,6 +14086,7 @@ vs
 
         <p>Retrieve an unique object based on a dictionary of data attributes and raise errors accordingly if the object is not found.</p>
 
+
     </div>
 
 </div>
@@ -14009,6 +14106,7 @@ vs
 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>
 
+
     </div>
 
 </div>
@@ -14027,6 +14125,7 @@ If it is a primary key, we return a dictionary object formatted like this {"pk":
         <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>
 
 </div>
@@ -14044,6 +14143,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
         <p>Return an object or a list of objects based on a dictionary of data attributes or an UUID.</p>
 
+
     </div>
 
 </div>
@@ -14086,6 +14186,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 <div class="highlight"><pre><span></span><code>Device.objects.filter(**dict_to_filter(attrs_dict))
 </code></pre></div>
 
+
     </div>
 
 </div>
@@ -14103,6 +14204,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
         <p>Dynamically import a class from an absolute path string</p>
 
+
     </div>
 
 </div>
@@ -14137,7 +14239,7 @@ data any serializer fields that do not correspond to a specific model field</p>
                 <code>serializer_choices</code>
             </td>
             <td>
-                  <code>tuple</code>
+                  <code><span title="tuple">tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14153,7 +14255,7 @@ data any serializer fields that do not correspond to a specific model field</p>
                 <code>api_version</code>
             </td>
             <td>
-                  <code>str</code>
+                  <code><span title="str">str</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14179,7 +14281,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>Serializer</code>
+                  <code><span title="Serializer">Serializer</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14190,6 +14292,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -14219,7 +14322,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>SerializerNotFound</code>
+                  <code><span title="SerializerNotFound">SerializerNotFound</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14230,6 +14333,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -14247,6 +14351,7 @@ data any serializer fields that do not correspond to a specific model field</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>
 
 </div>
@@ -14264,6 +14369,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
         <p>Return True of the request is being made via the REST API.</p>
 
+
     </div>
 
 </div>
@@ -14281,6 +14387,7 @@ data any serializer fields that do not correspond to a specific model field</p>
 
         <p>Handle exceptions and return a useful error message for REST API requests.</p>
 
+
     </div>
 
 </div>
@@ -14331,7 +14438,7 @@ data any serializer fields that do not correspond to a specific model field</p>
                 <code>serializer_choices</code>
             </td>
             <td>
-                  <code>tuple</code>
+                  <code><span title="tuple">tuple</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14347,7 +14454,7 @@ data any serializer fields that do not correspond to a specific model field</p>
                 <code>default_serializer</code>
             </td>
             <td>
-                  <code>Serializer</code>
+                  <code><span title="Serializer">Serializer</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -14361,6 +14468,7 @@ data any serializer fields that do not correspond to a specific model field</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>