nautobot 2.1.7__py3-none-any.whl → 2.1.9__py3-none-any.whl

nautobot/project-static/docs/user-guide/index.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3886,8 +3900,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4586,6 +4600,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/change-logging.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3936,8 +3950,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4636,6 +4650,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/computedfield.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3950,8 +3964,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4650,6 +4664,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/customfield.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3970,8 +3984,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4670,6 +4684,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models
@@ -5343,12 +5371,13 @@
 <p>Custom fields can be created through the UI under <strong>Extensibility &gt; Miscellaneous &gt; Custom Fields</strong> or through the REST API.</p>
 <p>Nautobot supports these custom field types:</p>
 <ul>
-<li>Text: Free-form text (up to 255 characters)</li>
+<li>Text: Free-form text</li>
 <li>Integer: A whole number (positive or negative)</li>
 <li>Boolean: True or false</li>
 <li>Date: A date in ISO 8601 format (YYYY-MM-DD)</li>
 <li>URL: This will be presented as a link in the web UI</li>
 <li>JSON: Arbitrary JSON data</li>
+<li>Markdown: Free-form text that will be rendered from Markdown in the web UI.</li>
 <li>Selection: A selection of one of several pre-defined custom choices</li>
 <li>Multiple selection: A selection field which supports the assignment of multiple values</li>
 </ul>
@@ -5356,6 +5385,14 @@
 <p class="admonition-title">Added in version 1.3.0</p>
 <p>Support for JSON-type custom fields was added.</p>
 </div>
+<div class="admonition version-added">
+<p class="admonition-title">Added in version 1.6.0</p>
+<p>Support for Markdown-type custom fields was added.</p>
+</div>
+<div class="admonition version-changed">
+<p class="admonition-title">Changed in version 2.1.8</p>
+<p>Prior to this release, text-type custom fields were always limited to a maximum of 255 characters. In this and later releases, text-type custom fields have no intrinsic length limit unless one is <a href="#custom-field-validation">explicitly defined</a>.</p>
+</div>
 <p>Each custom field must have a key; this should be a simple database-friendly string, e.g. <code>tps_report</code>. You may also assign a corresponding human-friendly label (e.g. "TPS report"); the label will be displayed on web forms. A weight is also required: Higher-weight fields will be ordered lower within a form. (The default weight is 100.) If a description is provided, it will appear beneath the field in a form.</p>
 <div class="admonition version-changed">
 <p class="admonition-title">Changed in version 1.4.0</p>
@@ -5379,20 +5416,79 @@
 <p>A custom field must be assigned to one or more object types, or models, in Nautobot. Once created, custom fields will automatically appear as part of these models in the web UI and REST API.</p>
 <p>When creating a custom field, if "Move to Advanced tab" is checked, this custom field won't appear on the object's main detail tab in the UI, but will appear in the "Advanced" tab. This is useful when the requirement is to hide this field from the main detail tab when, for instance, it is only required for machine-to-machine communication and not user consumption.</p>
 <h3 id="custom-field-validation">Custom Field Validation<a class="headerlink" href="#custom-field-validation" title="Permanent link">&para;</a></h3>
-<p>Nautobot supports limited custom validation for custom field values. Following are the types of validation enforced for each field type:</p>
-<ul>
-<li>Text: Regular expression (optional)</li>
-<li>URL: Regular expression (optional)</li>
-<li>Integer: Minimum and/or maximum value (optional)</li>
-<li>JSON: If not empty, this field must contain valid JSON data</li>
-<li>Selection: Must exactly match one of the prescribed choices<ul>
-<li>Selection Fields: Regular expression (optional)</li>
-</ul>
-</li>
-</ul>
+<p>Nautobot supports limited custom validation for custom field values. Following are the types of validation that can be enforced for each field type:</p>
+<table>
+<thead>
+<tr>
+<th>Field Type</th>
+<th>Minimum</th>
+<th>Maximum</th>
+<th>Regex</th>
+<th>Notes</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>Text</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td></td>
+</tr>
+<tr>
+<td>Integer</td>
+<td>✅ (value)</td>
+<td>✅ (value)</td>
+<td>❌</td>
+<td></td>
+</tr>
+<tr>
+<td>Boolean</td>
+<td>❌</td>
+<td>❌</td>
+<td>❌</td>
+<td></td>
+</tr>
+<tr>
+<td>URL</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td></td>
+</tr>
+<tr>
+<td>Markdown</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td></td>
+</tr>
+<tr>
+<td>JSON</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td>Must be valid JSON; validators apply to string representation</td>
+</tr>
+<tr>
+<td>Select</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td>Must match defined choice; validators apply to defining choices</td>
+</tr>
+<tr>
+<td>Multi-select</td>
+<td>✅ (length)</td>
+<td>✅ (length)</td>
+<td>✅</td>
+<td>Must match defined choice(s); validators apply to defining choices</td>
+</tr>
+</tbody>
+</table>
 <h3 id="custom-selection-fields">Custom Selection Fields<a class="headerlink" href="#custom-selection-fields" title="Permanent link">&para;</a></h3>
 <p>Choices are stored as independent values and are assigned a numeric weight which affects their ordering in selection lists and dropdowns. Note that choice values are saved exactly as they appear, so it's best to avoid superfluous punctuation or symbols where possible.</p>
-<p>A regular expression can optionally be defined on custom selection choices to validate the defined field choices in the user interface and the API.</p>
+<p>A regular expression can optionally be defined on custom selection choices to validate the defined field choices in the user interface and the API. Similarly, minimum and maximum lengths may be defined to validate defined field choices.</p>
 <p>If a default value is specified for a selection field, it must exactly match one of the provided choices. Note that the default value can only be set on the custom field after its corresponding choice has been added.</p>
 <p>The value of a multiple selection field will always return a list, even if only one value is selected.</p>
 <h3 id="filtering-on-custom-fields">Filtering on Custom Fields<a class="headerlink" href="#filtering-on-custom-fields" title="Permanent link">&para;</a></h3>

nautobot/project-static/docs/user-guide/platform-functionality/customlink.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3943,8 +3957,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4643,6 +4657,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/dynamicgroup.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -4178,8 +4192,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4878,6 +4892,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/exporttemplate.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3929,8 +3943,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4629,6 +4643,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/externalintegration.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3929,8 +3943,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4629,6 +4643,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/gitrepository.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -4024,8 +4038,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4724,6 +4738,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models

nautobot/project-static/docs/user-guide/platform-functionality/graphql.html

@@ -552,6 +552,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -3890,8 +3904,8 @@
   
   
     <li class="md-nav__item">
-      <a href="../../development/apps/api/ui-extensions/object-detail-views.html" class="md-nav__link">
-        Object Detail Views and Tabs
+      <a href="../../development/apps/api/ui-extensions/object-views.html" class="md-nav__link">
+        Object Detail & List Views
       </a>
     </li>
   
@@ -4590,6 +4604,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../development/core/caching.html" class="md-nav__link">
+        Caching
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../development/core/extending-models.html" class="md-nav__link">
         Extending Models