nautobot 2.0.5__py3-none-any.whl → 2.1.0b1__py3-none-any.whl

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/authentication.html

@@ -2663,6 +2663,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -2683,7 +2697,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -2692,14 +2706,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -2751,7 +2765,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -2760,14 +2774,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <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">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -2891,7 +2905,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" checked>
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" checked>
       
       
       
@@ -2900,14 +2914,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="true">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="true">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -3091,17 +3105,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -4834,6 +4848,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/filtering.html

@@ -2663,6 +2663,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -2683,7 +2697,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -2692,14 +2706,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -2751,7 +2765,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -2760,14 +2774,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <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">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -2891,7 +2905,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" checked>
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" checked>
       
       
       
@@ -2900,14 +2914,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="true">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="true">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -2988,8 +3002,15 @@
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
-  <a href="#numeric-fields" class="md-nav__link">
-    Numeric Fields
+  <a href="#nullable-fields" class="md-nav__link">
+    Nullable Fields
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#numeric-and-datetime-fields" class="md-nav__link">
+    Numeric and Date/Time Fields
   </a>
   
 </li>
@@ -3145,17 +3166,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -4888,6 +4909,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0
@@ -5293,8 +5328,15 @@
       <ul class="md-nav__list">
         
           <li class="md-nav__item">
-  <a href="#numeric-fields" class="md-nav__link">
-    Numeric Fields
+  <a href="#nullable-fields" class="md-nav__link">
+    Nullable Fields
+  </a>
+  
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#numeric-and-datetime-fields" class="md-nav__link">
+    Numeric and Date/Time Fields
   </a>
   
 </li>
@@ -5405,43 +5447,70 @@
 <p>Custom field filters are now based on the custom field <code>key</code> string.</p>
 </div>
 <h2 id="lookup-expressions">Lookup Expressions<a class="headerlink" href="#lookup-expressions" title="Permanent link">&para;</a></h2>
-<p>Certain model fields (including, in Nautobot 1.4.0 and later, custom fields of type <code>text</code>, <code>url</code>, <code>select</code>, <code>integer</code>, and <code>date</code>) also support filtering using additional lookup expressions. This allows
-for negation and other context-specific filtering.</p>
+<p>Certain model fields (including, in Nautobot 1.4.0 and later, custom fields of type <code>text</code>, <code>url</code>, <code>select</code>, <code>integer</code>, and <code>date</code>) also support filtering using additional lookup expressions. This allows for negation and other context-specific filtering.</p>
 <p>These lookup expressions can be applied by adding a suffix to the desired field's name, e.g. <code>mac_address__n</code>. In this case, the filter expression is for negation and it is separated by two underscores. Below are the lookup expressions that are supported across different field types.</p>
-<h3 id="numeric-fields">Numeric Fields<a class="headerlink" href="#numeric-fields" title="Permanent link">&para;</a></h3>
-<p>Numeric-based fields (ASN, VLAN ID, etc.) support these lookup expressions:</p>
+<h3 id="nullable-fields">Nullable Fields<a class="headerlink" href="#nullable-fields" title="Permanent link">&para;</a></h3>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
+</div>
+<p>Filters corresponding to nullable model fields (that is, <code>null=True</code>) of any type support the lookup expression:</p>
+<ul>
+<li><code>__isnull</code> - field has a null value (<em>not</em> blank -- a string-based (char) field with value <code>""</code> will match <code>__isnull=False</code>, <em>not</em> <code>__isnull=True</code>)</li>
+</ul>
+<h3 id="numeric-and-datetime-fields">Numeric and Date/Time Fields<a class="headerlink" href="#numeric-and-datetime-fields" title="Permanent link">&para;</a></h3>
+<p>Numeric-based fields (ASN, VLAN ID, etc.) as well as date/time fields (<code>created</code>, <code>last_updated</code>, etc.) support these lookup expressions:</p>
+<ul>
+<li><code>__n</code> - not equal to (negation)</li>
+<li><code>__lt</code> - less than</li>
+<li><code>__lte</code> - less than or equal</li>
+<li><code>__gt</code> - greater than</li>
+<li><code>__gte</code> - greater than or equal</li>
+</ul>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
 <ul>
-<li><code>n</code> - not equal to (negation)</li>
-<li><code>lt</code> - less than</li>
-<li><code>lte</code> - less than or equal</li>
-<li><code>gt</code> - greater than</li>
-<li><code>gte</code> - greater than or equal</li>
+<li><code>__isnull</code> - as above, only if this field is nullable (most numeric fields in Nautobot are not)</li>
 </ul>
+</div>
 <h3 id="string-fields">String Fields<a class="headerlink" href="#string-fields" title="Permanent link">&para;</a></h3>
 <p>String-based (char) fields (Name, Address, etc.) support these lookup expressions:</p>
 <ul>
-<li><code>n</code> - not equal to (negation)</li>
-<li><code>ic</code> - case-insensitive contains</li>
-<li><code>nic</code> - negated case-insensitive contains</li>
-<li><code>isw</code> - case-insensitive starts-with</li>
-<li><code>nisw</code> - negated case-insensitive starts-with</li>
-<li><code>iew</code> - case-insensitive ends-with</li>
-<li><code>niew</code> - negated case-insensitive ends-with</li>
-<li><code>ie</code> - case-insensitive exact match</li>
-<li><code>nie</code> - negated case-insensitive exact match</li>
+<li><code>__n</code> - not equal to (negation)</li>
+<li><code>__ic</code> - case-insensitive contains</li>
+<li><code>__nic</code> - negated case-insensitive contains</li>
+<li><code>__isw</code> - case-insensitive starts-with</li>
+<li><code>__nisw</code> - negated case-insensitive starts-with</li>
+<li><code>__iew</code> - case-insensitive ends-with</li>
+<li><code>__niew</code> - negated case-insensitive ends-with</li>
+<li><code>__ie</code> - case-insensitive exact match</li>
+<li><code>__nie</code> - negated case-insensitive exact match</li>
 </ul>
 <div class="admonition version-added">
 <p class="admonition-title">Added in version 1.3.0</p>
 <ul>
-<li><code>re</code> - case-sensitive regular expression match</li>
-<li><code>nre</code> - negated case-sensitive regular expression match</li>
-<li><code>ire</code> - case-insensitive regular expression match</li>
-<li><code>nire</code> - negated case-insensitive regular expression match</li>
+<li><code>__re</code> - case-sensitive regular expression match</li>
+<li><code>__nre</code> - negated case-sensitive regular expression match</li>
+<li><code>__ire</code> - case-insensitive regular expression match</li>
+<li><code>__nire</code> - negated case-insensitive regular expression match</li>
+</ul>
+</div>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
+<ul>
+<li><code>__isnull</code> - as above, only if this field is nullable (most string fields in Nautobot are not)</li>
 </ul>
 </div>
 <h3 id="foreign-keys-other-fields">Foreign Keys &amp; Other Fields<a class="headerlink" href="#foreign-keys-other-fields" title="Permanent link">&para;</a></h3>
-<p>Certain other fields, namely foreign key relationships support just the negation
-expression: <code>n</code>.</p>
+<p>Certain other fields, namely foreign key relationships support the lookup expression:</p>
+<ul>
+<li><code>__n</code> - not equal to (negation)</li>
+</ul>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 2.1.0</p>
+<ul>
+<li><code>__isnull</code> - as above, only if this field is nullable</li>
+</ul>
+</div>
 <h3 id="network-and-host-fields">Network and Host Fields<a class="headerlink" href="#network-and-host-fields" title="Permanent link">&para;</a></h3>
 <p>There are <a href="https://docs.djangoproject.com/en/3.2/howto/custom-lookups/">Custom Lookups</a> built for the <code>VarbinaryIPField</code> field types. While
 the <code>VarbinaryIPField</code> is applied to fields for network, host, and broadcast, the below filters only apply to network and host. The design

nautobot/project-static/docs/user-guide/platform-functionality/rest-api/overview.html

@@ -2663,6 +2663,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../externalintegration.html" class="md-nav__link">
+        External Integrations
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../gitrepository.html" class="md-nav__link">
         Git Repositories
@@ -2683,7 +2697,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_8" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
       
       
       
@@ -2692,14 +2706,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../graphql.html">GraphQL</a>
           
-            <label for="__nav_2_4_8">
+            <label for="__nav_2_4_9">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_8_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_8">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           GraphQL
         </label>
@@ -2751,7 +2765,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_10" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
       
       
       
@@ -2760,14 +2774,14 @@
         <div class="md-nav__link md-nav__link--index ">
           <a href="../jobs/index.html">Jobs</a>
           
-            <label for="__nav_2_4_10">
+            <label for="__nav_2_4_11">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <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">
+      <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">
           <span class="md-nav__icon md-icon"></span>
           Jobs
         </label>
@@ -2891,7 +2905,7 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_14" checked>
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" checked>
       
       
       
@@ -2900,14 +2914,14 @@
         <div class="md-nav__link md-nav__link--index md-nav__link--active">
           <a href="overview.html">REST API</a>
           
-            <label for="__nav_2_4_14">
+            <label for="__nav_2_4_15">
               <span class="md-nav__icon md-icon"></span>
             </label>
           
         </div>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_14_label" aria-expanded="true">
-        <label class="md-nav__title" for="__nav_2_4_14">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_15_label" aria-expanded="true">
+        <label class="md-nav__title" for="__nav_2_4_15">
           <span class="md-nav__icon md-icon"></span>
           REST API
         </label>
@@ -3043,17 +3057,17 @@
       
       
       
-      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_20" >
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
       
       
       
-        <label class="md-nav__link" for="__nav_2_4_20" id="__nav_2_4_20_label" tabindex="0">
+        <label class="md-nav__link" for="__nav_2_4_21" id="__nav_2_4_21_label" tabindex="0">
           Users
           <span class="md-nav__icon md-icon"></span>
         </label>
       
-      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_20_label" aria-expanded="false">
-        <label class="md-nav__title" for="__nav_2_4_20">
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_4_21_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_4_21">
           <span class="md-nav__icon md-icon"></span>
           Users
         </label>
@@ -4786,6 +4800,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../release-notes/version-2.1.html" class="md-nav__link">
+        Version 2.1
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../release-notes/version-2.0.html" class="md-nav__link">
         Version 2.0