nautobot 2.4.3__py3-none-any.whl → 2.4.5__py3-none-any.whl

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

@@ -7487,6 +7487,15 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.filters.PrefixFilter" class="md-nav__link">
+    <span class="md-ellipsis">
+      PrefixFilter
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -9724,6 +9733,15 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.filters.PrefixFilter" class="md-nav__link">
+    <span class="md-ellipsis">
+      PrefixFilter
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -10755,6 +10773,50 @@ are needed.</p>
 
 
 
+  </div>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="nautobot.apps.filters.PrefixFilter" class="doc doc-heading">
+            <code>nautobot.apps.filters.PrefixFilter</code>
+
+
+<a href="#nautobot.apps.filters.PrefixFilter" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+    <div class="doc doc-contents ">
+            <p class="doc doc-class-bases">
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+
+
+        <p>Filter that supports filtering a foreign key to Prefix by either its PK or by a literal <code>prefix</code> string.</p>
+
+
+
+
+
+
+
+
+
+  <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+
+
   </div>
 
     </div>

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

@@ -7419,6 +7419,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.jobs.BaseJob.fail" class="md-nav__link">
+    <span class="md-ellipsis">
+      fail
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -9776,6 +9785,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.jobs.BaseJob.fail" class="md-nav__link">
+    <span class="md-ellipsis">
+      fail
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -10624,11 +10642,13 @@ during a approval review workflow.</p>
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>None</code>
+                  <code>Any</code>
             </td>
             <td>
               <div class="doc-md-description">
-                <p>The return value of this handler is ignored.</p>
+                <p>The return value of this handler is ignored normally, <strong>except</strong> if <code>self.fail()</code> is called herein,
+in which case the return value will be used as the overall JobResult return value
+since <code>self.run()</code> will <strong>not</strong> be called in such a case.</p>
               </div>
             </td>
           </tr>
@@ -10835,6 +10855,23 @@ path would consider this a failure of the job execution, as described in <code>n
 <div class="doc doc-object doc-function">
 
 
+<h3 id="nautobot.apps.jobs.BaseJob.fail" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">fail</span><span class="p">(</span><span class="n">msg</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.jobs.BaseJob.fail" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Mark this job as failed without immediately raising an exception and aborting.</p>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
 <h3 id="nautobot.apps.jobs.BaseJob.file_path" class="doc doc-heading">
             <code class="highlight language-python"><span class="n">file_path</span><span class="p">()</span></code>
 
@@ -10914,11 +10951,12 @@ path would consider this a failure of the job execution, as described in <code>n
                 <code>exc</code>
             </td>
             <td>
-                  <code>Exception</code>
+                  <code>Any</code>
             </td>
             <td>
               <div class="doc-md-description">
-                <p>The exception raised by the task.</p>
+                <p>Exception raised by the task (if any) <strong>or</strong> return value from the task, if it failed cleanly,
+such as if the Job called <code>self.fail()</code> rather than raising an exception.</p>
               </div>
             </td>
             <td>
@@ -10982,7 +11020,7 @@ path would consider this a failure of the job execution, as described in <code>n
             </td>
             <td>
               <div class="doc-md-description">
-                <p>Exception information.</p>
+                <p>Exception information, or None.</p>
               </div>
             </td>
             <td>

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

@@ -8238,6 +8238,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="md-nav__link">
+    <span class="md-ellipsis">
+      assertJobResultStatus
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -11423,6 +11432,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="md-nav__link">
+    <span class="md-ellipsis">
+      assertJobResultStatus
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -14322,6 +14340,23 @@ in the dictionary.</p>
 <div class="doc doc-object doc-function">
 
 
+<h3 id="nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">assertJobResultStatus</span><span class="p">(</span><span class="n">job_result</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="n">JobResultStatusChoices</span><span class="o">.</span><span class="n">STATUS_SUCCESS</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Assert that the given job_result has the expected_status, or print the job logs to aid in debugging.</p>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
 <h3 id="nautobot.apps.testing.NautobotTestCaseMixin.assertQuerysetEqualAndNotEmpty" class="doc doc-heading">
             <code class="highlight language-python"><span class="n">assertQuerysetEqualAndNotEmpty</span><span class="p">(</span><span class="n">qs</span><span class="p">,</span> <span class="n">values</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
 

nautobot/project-static/docs/development/apps/api/configuration-view.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="adding-links-to-the-installed-apps-view">Adding Links to the Installed Apps View<a class="headerlink" href="#adding-links-to-the-installed-apps-view" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>It's common for many apps to provide an "app configuration" <a href="views/index.html">view</a> used for interactive configuration of aspects of the app that don't necessarily need to be managed by a system administrator via <code>PLUGINS_CONFIG</code>. The <code>NautobotAppConfig</code> setting of <code>config_view_name</code> lets you provide the URL pattern name defined for this view, which will then be accessible via a button on the <strong>Apps -&gt; Installed Apps</strong> UI view.</p>
 <p>For example, if the <code>animal_sounds</code> app provides a configuration view, which is set up in <code>urls.py</code> as follows:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># urls.py</span>

nautobot/project-static/docs/development/apps/api/models/graphql.html

@@ -9245,10 +9245,6 @@
 <a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
 </code></pre></div>
 <h2 id="creating-your-own-graphql-type-object">Creating Your Own GraphQL Type Object<a class="headerlink" href="#creating-your-own-graphql-type-object" title="Permanent link">&para;</a></h2>
-<details class="version-changed">
-<summary>Changed in version 1.6.2</summary>
-<p>A new base class was introduced for Nautobot GraphQL object types: <code>nautobot.core.graphql.types.OptimizedNautobotObjectType</code>. This class inherits from <code>graphene_django_optimizer.OptimizedDjangoObjectType</code> and adds generic Nautobot specific functionality.</p>
-</details>
 <p>In some cases, such as when a model is using Generic Foreign Keys, or when a model has constructed fields that should also be reflected in GraphQL, the default GraphQL type definition generated by the <code>@extras_features</code> decorator may not work as the developer intends, and it will be preferable to provide custom GraphQL types.</p>
 <p>By default, Nautobot looks for custom GraphQL types in an iterable named <code>graphql_types</code> within a <code>graphql/types.py</code> file. (This can be overridden by setting <code>graphql_types</code> to a custom value on the app's <code>NautobotAppConfig</code>.) Each type defined in this way must be a class inheriting from <code>graphene_django.DjangoObjectType</code>, <code>graphene_django_optimizer.OptimizedDjangoObjectType</code>, or <code>nautobot.core.graphql.types.OptimizedNautobotObjectType</code> and must follow the <a href="https://docs.graphene-python.org/projects/django/en/latest/queries/">standards defined by <code>graphene-django</code></a>.</p>
 <p>Nautobot uses a library called <a href="https://github.com/tfoxy/graphene-django-optimizer"><code>graphene-django-optimizer</code></a> to decrease the time queries take to process. By inheriting from <code>graphene_django_optimizer</code> type classes are automatically optimized.</p>

nautobot/project-static/docs/development/apps/api/platform-features/custom-validators.html

@@ -6534,6 +6534,17 @@
         
       
       
+        <label class="md-nav__link md-nav__link--active" for="__toc">
+          
+  
+  <span class="md-ellipsis">
+    Custom Validators
+  </span>
+  
+
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      
       <a href="custom-validators.html" class="md-nav__link md-nav__link--active">
         
   
@@ -6544,6 +6555,34 @@
 
       </a>
       
+        
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+  
+  
+  
+    
+  
+  
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#user-context" class="md-nav__link">
+    <span class="md-ellipsis">
+      User Context
+    </span>
+  </a>
+  
+</li>
+      
+    </ul>
+  
+</nav>
+      
     </li>
   
 
@@ -9105,6 +9144,23 @@
     
   
   
+    <label class="md-nav__title" for="__toc">
+      <span class="md-nav__icon md-icon"></span>
+      Table of contents
+    </label>
+    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+      
+        <li class="md-nav__item">
+  <a href="#user-context" class="md-nav__link">
+    <span class="md-ellipsis">
+      User Context
+    </span>
+  </a>
+  
+</li>
+      
+    </ul>
+  
 </nav>
                   </div>
                 </div>
@@ -9124,7 +9180,7 @@
 <h1 id="implementing-custom-validators">Implementing Custom Validators<a class="headerlink" href="#implementing-custom-validators" title="Permanent link">&para;</a></h1>
 <p>Apps can register custom validator classes which implement model validation logic to be executed during a model's <code>clean()</code> method. Like template extensions, custom validators are registered to a single model and offer a method which app authors override to implement their validation logic. This is accomplished by subclassing <code>CustomValidator</code> and implementing the <code>clean()</code> method.</p>
 <p>App authors must raise <code>django.core.exceptions.ValidationError</code> within the <code>clean()</code> method to trigger validation error messages which are propagated to the user and prevent saving of the model instance. A convenience method <code>validation_error()</code> may be used to simplify this process. Raising a <code>ValidationError</code> is no different than vanilla Django, and the convenience method will simply pass the provided message through to the exception.</p>
-<p>When a CustomValidator is instantiated, the model instance is assigned to context dictionary using the <code>object</code> key, much like TemplateExtension. E.g. <code>self.context['object']</code>.</p>
+<p>When a CustomValidator is instantiated, the model instance is assigned to context dictionary using the <code>object</code> key, much like TemplateExtension. E.g. <code>self.context['object']</code>. The context is also populated with the current request user object. E.g. <code>self.context['user']</code>.</p>
 <p>Declared subclasses should be gathered into a list or tuple for integration with Nautobot. By default, Nautobot looks for an iterable named <code>custom_validators</code> within a <code>custom_validators.py</code> file. (This can be overridden by setting <code>custom_validators</code> to a custom value on the app's <code>NautobotAppConfig</code>.) An example is below.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># custom_validators.py</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="kn">from</span> <span class="nn">nautobot.apps.models</span> <span class="kn">import</span> <span class="n">CustomValidator</span>
@@ -9145,6 +9201,43 @@
 <a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a>
 <a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="n">custom_validators</span> <span class="o">=</span> <span class="p">[</span><span class="n">LocationValidator</span><span class="p">]</span>
 </code></pre></div>
+<h2 id="user-context">User Context<a class="headerlink" href="#user-context" title="Permanent link">&para;</a></h2>
+<details class="version-added">
+<summary>Added in version 2.4.4</summary>
+</details>
+<p>Custom validators have access to the current user via <code>self.context['user']</code> whenever the custom validator is invoked within a web request context. This is true for any Web UI, REST API request, Job execution, and anytime the <code>web_request_context</code> context manager is used in <code>nbshell</code> or a out of band script. In the event a custom validator is run outside of a web request context, <code>self.context['user']</code> will be populated with an instance of <code>AnonymousUser</code> from <code>django.contrib.auth</code>. This allows a custom validator author to write code that is durable to cases where a real user is not available.</p>
+<p>With the user object, you can inspect the groups and permissions that the user has, allowing more granular access related validation.</p>
+<p>This example shows a custom validator that only allows users in the group "Tenant Managers" to change the tenant of a location:</p>
+<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># custom_validators.py</span>
+<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="kn">from</span> <span class="nn">nautobot.apps.models</span> <span class="kn">import</span> <span class="n">CustomValidator</span>
+<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
+<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
+<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="k">class</span> <span class="nc">LocationTenantValidator</span><span class="p">(</span><span class="n">CustomValidator</span><span class="p">):</span>
+<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Custom validator for Locations to enforce that only some users can update the Tenant.&quot;&quot;&quot;</span>
+<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a>
+<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a>    <span class="n">model</span> <span class="o">=</span> <span class="s1">&#39;dcim.location&#39;</span>
+<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a>
+<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>    <span class="k">def</span> <span class="nf">clean</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a>        <span class="n">new_object_state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">[</span><span class="s2">&quot;object&quot;</span><span class="p">]</span>
+<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a>        <span class="k">if</span> <span class="ow">not</span> <span class="n">new_object_state</span><span class="o">.</span><span class="n">present_in_database</span><span class="p">:</span>
+<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a>            <span class="c1"># This is a brand new Location, so skip the rest of the checks here</span>
+<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a>            <span class="k">return</span>
+<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a>
+<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a>        <span class="c1"># Get a copy of the object as it currently exists in the database</span>
+<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a>        <span class="n">current_object_state</span> <span class="o">=</span> <span class="n">new_object_state</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="nb">id</span><span class="o">=</span><span class="n">new_object_state</span><span class="o">.</span><span class="n">id</span><span class="p">)</span>
+<a id="__codelineno-1-18" name="__codelineno-1-18" href="#__codelineno-1-18"></a>
+<a id="__codelineno-1-19" name="__codelineno-1-19" href="#__codelineno-1-19"></a>        <span class="c1"># Compare the tenant values between the two states</span>
+<a id="__codelineno-1-20" name="__codelineno-1-20" href="#__codelineno-1-20"></a>        <span class="k">if</span> <span class="n">new_object_state</span><span class="o">.</span><span class="n">tenant</span> <span class="o">!=</span> <span class="n">current_object_state</span><span class="o">.</span><span class="n">tenant</span><span class="p">:</span>
+<a id="__codelineno-1-21" name="__codelineno-1-21" href="#__codelineno-1-21"></a>
+<a id="__codelineno-1-22" name="__codelineno-1-22" href="#__codelineno-1-22"></a>            <span class="c1"># Check if the user has permission to change the tenant, via being a member of &quot;Tenant Managers&quot;</span>
+<a id="__codelineno-1-23" name="__codelineno-1-23" href="#__codelineno-1-23"></a>            <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">context</span><span class="p">[</span><span class="s2">&quot;user&quot;</span><span class="p">]</span><span class="o">.</span><span class="n">groups</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s2">&quot;Tenant Managers&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">exists</span><span class="p">():</span>
+<a id="__codelineno-1-24" name="__codelineno-1-24" href="#__codelineno-1-24"></a>                <span class="bp">self</span><span class="o">.</span><span class="n">validation_error</span><span class="p">({</span>
+<a id="__codelineno-1-25" name="__codelineno-1-25" href="#__codelineno-1-25"></a>                    <span class="s2">&quot;tenant&quot;</span><span class="p">:</span> <span class="s2">&quot;You do not have permission to change the tenant&quot;</span>
+<a id="__codelineno-1-26" name="__codelineno-1-26" href="#__codelineno-1-26"></a>                <span class="p">})</span>
+<a id="__codelineno-1-27" name="__codelineno-1-27" href="#__codelineno-1-27"></a>
+<a id="__codelineno-1-28" name="__codelineno-1-28" href="#__codelineno-1-28"></a>
+<a id="__codelineno-1-29" name="__codelineno-1-29" href="#__codelineno-1-29"></a><span class="n">custom_validators</span> <span class="o">=</span> <span class="p">[</span><span class="n">LocationTenantValidator</span><span class="p">]</span>
+</code></pre></div>
 
 
 

nautobot/project-static/docs/development/apps/api/platform-features/filter-extensions.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="extending-filters">Extending Filters<a class="headerlink" href="#extending-filters" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.3.0</summary>
-</details>
 <p>Apps can extend any model-based <code>FilterSet</code> and <code>FilterForm</code> classes that are provided by the Nautobot core.</p>
 <p>The requirements to extend a filter set or a filter form (or both) are:</p>
 <ul>

nautobot/project-static/docs/development/apps/api/platform-features/jinja2-filters.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="adding-jinja2-filters">Adding Jinja2 Filters<a class="headerlink" href="#adding-jinja2-filters" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.1.0</summary>
-</details>
 <p>Apps can define custom Jinja2 filters to be used when rendering templates defined in computed fields. Check out the <a href="https://jinja.palletsprojects.com/en/3.0.x/api/#custom-filters">official Jinja2 documentation</a> on how to create filter functions.</p>
 <p>In the file that defines your filters (by default <code>jinja_filters.py</code>, but configurable in the <code>NautobotAppConfig</code> if desired), you must import the <code>library</code> module from the <code>django_jinja</code> library. Filters must then be decorated with <code>@library.filter</code>. See an example below that defines a filter called <code>leet_speak</code>.</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">django_jinja</span> <span class="kn">import</span> <span class="n">library</span>

nautobot/project-static/docs/development/apps/api/platform-features/populating-extensibility-features.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="populating-extensibility-features">Populating Extensibility Features<a class="headerlink" href="#populating-extensibility-features" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>In many cases, an app may wish to make use of Nautobot's various extensibility features, such as <a href="../../../../user-guide/platform-functionality/customfield.html">custom fields</a> or <a href="../../../../user-guide/platform-functionality/relationship.html">relationships</a>. It can be useful for an app to automatically create a custom field definition or relationship definition as a consequence of being installed and activated, so that everyday usage of the app can rely upon these definitions to be present.</p>
 <p>To make this possible, Nautobot provides a custom <a href="https://docs.djangoproject.com/en/stable/topics/signals/">signal</a>, <code>nautobot_database_ready</code>, that apps can register to listen for. This signal is triggered when <code>nautobot-server migrate</code> or <code>nautobot-server post_upgrade</code> is run after installing an app, and provides an opportunity for the app to make any desired additions to the database at this time.</p>
 <p>For example, maybe we want our app to make use of a Relationship allowing each Location to be linked to our Animal model. We would define our callback function that makes sure this Relationship exists, by convention in a <code>signals.py</code> file:</p>

nautobot/project-static/docs/development/apps/api/platform-features/secrets-providers.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="implementing-secrets-providers">Implementing Secrets Providers<a class="headerlink" href="#implementing-secrets-providers" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>An app can define and register additional providers (sources) for <a href="../../../../user-guide/platform-functionality/secret.html">Secrets</a>, allowing Nautobot to retrieve secret values from additional systems or data sources. By default, Nautobot looks for an iterable named <code>secrets_providers</code> within a <code>secrets.py</code> file. (This can be overridden by setting <code>secrets_providers</code> to a custom value on the app's <code>NautobotAppConfig</code>.)</p>
 <p>To define a new <code>SecretsProvider</code> subclass, we must specify the following:</p>
 <ul>

nautobot/project-static/docs/development/apps/api/prometheus.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="prometheus-metrics">Prometheus Metrics<a class="headerlink" href="#prometheus-metrics" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.5.13</summary>
-</details>
 <p>It is possible for Nautobot apps to provide their own <a href="../../../user-guide/administration/guides/prometheus-metrics.html">Prometheus metrics</a>. There are two general ways to achieve this:</p>
 <ol>
 <li>Use the <code>prometheus_client</code> library directly in your app code. Depending on whether that code runs in the web server or the worker context, the metric will show up in the respective <code>/metrics</code> endpoint(s) (i.e. metrics generated in the worker context show up in the worker's endpoint and those generated in the web application's context show up in the web application's endpoint).</li>

nautobot/project-static/docs/development/apps/api/testing.html

@@ -9232,14 +9232,8 @@
 <h1 id="testing-apps">Testing Apps<a class="headerlink" href="#testing-apps" title="Permanent link">&para;</a></h1>
 <p>In general apps can be tested like other Django apps. In most cases you'll want to run your automated tests via the <code>nautobot-server test &lt;app_module&gt;</code> command or, if using the <code>coverage</code> Python library, <code>coverage run --module nautobot.core.cli test &lt;app_module&gt;</code>.</p>
 <h2 id="factories">Factories<a class="headerlink" href="#factories" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.5.0</summary>
-</details>
 <p>The <a href="../../../user-guide/administration/configuration/settings.html#test_use_factories"><code>TEST_USE_FACTORIES</code></a> setting defaults to <code>False</code> when testing apps, primarily for backwards-compatibility reasons. It can prove a useful way of populating a baseline of Nautobot database data for your tests and save you the trouble of creating a large amount of baseline data yourself. We recommend adding <a href="https://pypi.org/project/factory-boy/"><code>factory-boy</code></a> to your app's development dependencies and settings <code>TEST_USE_FACTORIES = True</code> in your app's development/test <code>nautobot_config.py</code> to take advantage of this.</p>
 <h2 id="performance-tests">Performance Tests<a class="headerlink" href="#performance-tests" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.5.0</summary>
-</details>
 <h2 id="running-performance-tests">Running Performance Tests<a class="headerlink" href="#running-performance-tests" title="Permanent link">&para;</a></h2>
 <p>You need to install <code>django-slowtests</code> as a part of your app dev dependency to run performance tests. It has a very intuitive way to measure the performance of your own tests for your app  (all you have to do is tag your tests with <code>performance</code>) and do <code>invoke performance-test</code> to get the time to run your tests with <code>NautobotPerformanceTestRunner</code>.</p>
 <p><code>NautobotPerformanceTestRunner</code> is used by adding the flag <code>--testrunner nautobot.core.tests.runner.NautobotPerformanceTestRunner</code> to the <code>coverage run</code> command used for unit tests. This flag will replace the default <code>NautobotTestRunner</code> while retaining all its functionalities with the addition of performance evaluation after test

nautobot/project-static/docs/development/apps/api/ui-extensions/banners.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="adding-a-banner">Adding a Banner<a class="headerlink" href="#adding-a-banner" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>An app can provide a function that renders a custom banner on any number of Nautobot views. By default Nautobot looks for a function <code>banner()</code> inside of <code>banner.py</code>. (This can be overridden by setting <code>banner_function</code> to a custom value on the app's <code>NautobotAppConfig</code>.)</p>
 <p>This function currently receives a single argument, <code>context</code>, which is the <a href="https://docs.djangoproject.com/en/stable/ref/templates/api/#using-requestcontext">Django request context</a> in which the current page is being rendered. The function can return <code>None</code> if no banner is needed for a given page view, or can return a <code>Banner</code> object describing the banner contents. Here's a simple example <code>banner.py</code>:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># banner.py</span>

nautobot/project-static/docs/development/apps/api/ui-extensions/home-page.html

@@ -9122,9 +9122,6 @@
 
 
 <h1 id="adding-home-page-content">Adding Home Page Content<a class="headerlink" href="#adding-home-page-content" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.2.0</summary>
-</details>
 <p>Apps can add content to the Nautobot home page. By default, Nautobot looks for a <code>layout</code> list inside of <code>homepage.py</code>. (This can be overridden by setting <code>homepage_layout</code> to a custom value on the app's <code>NautobotAppConfig</code>.)</p>
 <p>Using a key and weight system, a developer can integrate the app content amongst existing panels, groups, and items and/or create entirely new panels as desired.</p>
 <p>More documentation and examples can be found in the guide on <a href="../../../core/homepage.html">Home Page Panels</a>.</p>

nautobot/project-static/docs/development/apps/api/ui-extensions/object-views.html

@@ -9457,9 +9457,6 @@
 </code></pre></div>
 <p>Note that a <code>Tab</code> defines its contents directly (as <code>panels</code>) while the <code>DistinctViewTab</code> instead provides a <code>url_name</code> to the related URL that it should link against.</p>
 <h3 id="via-detail_tabs-deprecated">Via <code>detail_tabs()</code> (Deprecated)<a class="headerlink" href="#via-detail_tabs-deprecated" title="Permanent link">&para;</a></h3>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>The <code>TemplateExtension.detail_tabs()</code> method should return a list of dicts, each of which has the keys <code>"title"</code> and <code>"url"</code>. In addition, in order for tabs to work properly:</p>
 <ul>
 <li>The <code>"url"</code> key should typically be a URL that includes <code>self.context["object"].pk</code> in some form (so that the URL may know which object is being referenced)</li>

nautobot/project-static/docs/development/apps/api/views/core-view-overrides.html

@@ -9124,9 +9124,6 @@
 
 
 <h1 id="replacing-views">Replacing Views<a class="headerlink" href="#replacing-views" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>You may override any of the core or app views by providing an <code>override_views</code> <code>dict</code> in an app's <code>views.py</code> file.</p>
 <p>To override a view, you must specify the view's fully qualified name as the <code>dict</code> key which consists of the app name followed by the view's name separated by a colon, for instance <code>dcim:device</code>. The <code>dict</code> value should be the overriding view function.</p>
 <p>A simple example to override the device detail view:</p>

nautobot/project-static/docs/development/apps/api/views/nautobot-generic-views.html

@@ -9182,15 +9182,9 @@
 <p class="admonition-title">Warning</p>
 <p>Currently preferred way of implementing views is to use <a href="nautobotuiviewset.html"><code>NautobotUIViewSet</code></a></p>
 </div>
-<details class="version-added">
-<summary>Added in version 1.1.0</summary>
-<p>Via <a href="https://github.com/nautobot/nautobot/issues/14">PR #14</a>, some <code>generic</code> views have been exposed to help aid in App development. These views have some requirements that must be in place in order to work. These can be used by importing them from <code>from nautobot.core.views import generic</code>.</p>
-</details>
+<p>Some <code>generic</code> views have been exposed to help aid in App development. These views have some requirements that must be in place in order to work. These can be used by importing them from <code>from nautobot.core.views import generic</code>.</p>
 <p>More documentation and examples can be found in <a href="../../../core/generic-views.html">Generic Views</a> guide.</p>
 <h2 id="note-url-endpoint">Note URL Endpoint<a class="headerlink" href="#note-url-endpoint" title="Permanent link">&para;</a></h2>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>Models that inherit from <code>PrimaryModel</code> and <code>OrganizationalModel</code> can have notes associated. In order to utilize this new feature you will need to add the endpoint to <code>urls.py</code>. Here is an option to be able to support both 1.4+ and older versions of Nautobot:</p>
 <div class="admonition tip">
 <p class="admonition-title">Tip</p>

nautobot/project-static/docs/development/apps/api/views/nautobotuiviewset.html

@@ -9280,9 +9280,6 @@
 
 
 <h1 id="nautobotuiviewset">NautobotUIViewSet<a class="headerlink" href="#nautobotuiviewset" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>New in Nautobot 1.4 is the debut of <code>NautobotUIViewSet</code>: A powerful app development tool that can save app developer hundreds of lines of code compared to using legacy <code>generic.views</code>. Using it to gain access to default functionalities previous provided by <code>generic.views</code> such as <code>create()</code>, <code>update()</code>, <code>partial_update()</code>, <code>bulk_update()</code>, <code>destroy()</code>, <code>bulk_destroy()</code>, <code>retrieve()</code> and <code>list()</code> actions.</p>
 <p>Note that this ViewSet is catered specifically to the UI, not the API.</p>
 <p>Concrete examples on how to use <code>NautobotUIViewSet</code> resides in <code>nautobot.circuits.views</code>.</p>
@@ -9443,10 +9440,6 @@ The framework provides many pre-built panel types.</p>
 <p>If you do not provide your own templates in the <code>yourapp/templates/yourapp</code> folder, <code>NautobotUIViewSet</code> will fall back to <code>generic/object_{self.action}.html</code>.</p>
 <p>Since in many cases the <code>create</code> and <code>update</code> templates for a model will be identical, you are not required to create both. If you provide a <code>{app_label}/{model_opts.model_name}_create.html</code> file but not a <code>{app_label}/{model_opts.model_name}_update.html</code> file, then when you update an object, it will fall back to <code>{app_label}/{model_opts.model_name}_create.html</code> and vice versa.</p>
 <h3 id="adding-custom-views-to-nautobotuiviewset-nautobotuiviewsetrouter">Adding Custom Views To NautobotUIViewSet &amp; NautobotUIViewSetRouter<a class="headerlink" href="#adding-custom-views-to-nautobotuiviewset-nautobotuiviewsetrouter" title="Permanent link">&para;</a></h3>
-<details class="version-changed">
-<summary>Changed in version 1.6.0</summary>
-<p>Via <a href="https://github.com/nautobot/nautobot/pull/4045">PR #4045</a>, notes and changelog views provided by mixins have now been moved to this pattern.</p>
-</details>
 <p>Django REST Framework provides the ability to decorate a method on a ViewSet with <code>@action(detail=True)</code> to add the method as a view to the ViewSetRouter. This method must return a fully rendered HTML view.</p>
 <p>Below is an example of adding a custom action view to an App's ViewSet. A few considerations to keep in mind:</p>
 <ul>

nautobot/project-static/docs/development/apps/api/views/nautobotuiviewsetrouter.html

@@ -9154,10 +9154,6 @@
 <a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a><span class="p">]</span>
 <a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="n">urlpatterns</span> <span class="o">+=</span> <span class="n">router</span><span class="o">.</span><span class="n">urls</span>
 </code></pre></div>
-<details class="version-added">
-<summary>Added in version 1.5.1</summary>
-<p>Changelog and Notes views and URLs are now provided in the NautobotUIViewSet and NautobotUIViewSetRouter.</p>
-</details>
 
 
 

nautobot/project-static/docs/development/apps/api/views/notes.html

@@ -9124,9 +9124,6 @@
 
 
 <h1 id="note-url-endpoint">Note URL Endpoint<a class="headerlink" href="#note-url-endpoint" title="Permanent link">&para;</a></h1>
-<details class="version-added">
-<summary>Added in version 1.4.0</summary>
-</details>
 <p>Models that inherit from <code>PrimaryModel</code> and <code>OrganizationalModel</code> can have notes associated. In order to utilize this new feature you will need to add the endpoint to <code>urls.py</code>. Here is an option to be able to support both 1.4+ and older versions of Nautobot:</p>
 <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="n">urlpatterns</span> <span class="o">=</span> <span class="p">[</span>
 <a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>    <span class="n">path</span><span class="p">(</span><span class="s1">&#39;random/&#39;</span><span class="p">,</span> <span class="n">views</span><span class="o">.</span><span class="n">RandomAnimalView</span><span class="o">.</span><span class="n">as_view</span><span class="p">(),</span> <span class="n">name</span><span class="o">=</span><span class="s1">&#39;random_animal&#39;</span><span class="p">),</span>