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

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.49">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.46">
     
     
       
@@ -2112,27 +2112,6 @@
 
               
             
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../../../user-guide/feature-guides/wireless-networks-and-controllers.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Wireless Networks and Controllers
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
           </ul>
         </nav>
       
@@ -5152,27 +5131,6 @@
   
   
   
-    <li class="md-nav__item">
-      <a href="../../../user-guide/platform-functionality/jobs/kubernetes-job-support.html" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Kubernetes Job Support
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
     <li class="md-nav__item">
       <a href="../../../user-guide/platform-functionality/jobs/jobbutton.html" class="md-nav__link">
         
@@ -8209,11 +8167,11 @@
   
   
     <li class="md-nav__item">
-      <a href="../../../development/core/minikube-dev-environment-for-k8s-jobs.html" class="md-nav__link">
+      <a href="../../../development/core/local-k8s.html" class="md-nav__link">
         
   
   <span class="md-ellipsis">
-    Minikube Dev Environment for K8s Jobs
+    Local Kubernetes Cluster
   </span>
   
 
@@ -9222,12 +9180,7 @@
 
     <div class="doc doc-contents first">
 
-        <p>GraphQL API for Nautobot.</p>
-
-
-
-
-
+      <p>GraphQL API for Nautobot.</p>
 
 
 
@@ -9253,21 +9206,16 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><span title="graphene.types.Scalar">Scalar</span></code></p>
+              Bases: <code><autoref identifier="graphene.types.Scalar" optional hover>Scalar</autoref></code></p>
 
 
-        <p>An integer which, unlike GraphQL's native Int type, doesn't reject values outside (-2^31, 2^31-1).</p>
+      <p>An integer which, unlike GraphQL's native Int type, doesn't reject values outside (-2^31, 2^31-1).</p>
 <p>Currently only used for ASNField, which goes up to 2^32-1 (i.e., unsigned 32-bit int); it's possible
 that this approach may fail for values in excess of 2^53-1 (the largest integer value supported in JavaScript).</p>
 
 
 
 
-
-
-
-
-
   <div class="doc doc-children">
 
 
@@ -9299,20 +9247,15 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><span title="nautobot.core.graphql.types.OptimizedNautobotObjectType">OptimizedNautobotObjectType</span></code></p>
+              Bases: <code><autoref identifier="nautobot.core.graphql.types.OptimizedNautobotObjectType" optional hover>OptimizedNautobotObjectType</autoref></code></p>
 
 
-        <p>Graphene-Django object type for ContentType records.</p>
+      <p>Graphene-Django object type for ContentType records.</p>
 <p>Needed because ContentType is a built-in model, not one that we own and can auto-generate types for.</p>
 
 
 
 
-
-
-
-
-
   <div class="doc doc-children">
 
 
@@ -9343,7 +9286,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
 
     <div class="doc doc-contents ">
 
-        <p>Constructs a resolve_[cable_peer|connected_endpoint]_<endpoint> function for a given model type.</p>
+      <p>Constructs a resolve_[cable_peer|connected_endpoint]_<endpoint> function for a given model type.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9358,11 +9301,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
       </thead>
       <tbody>
           <tr class="doc-section-item">
+            <td><code>model_name</code></td>
             <td>
-                <code>model_name</code>
-            </td>
-            <td>
-                  <code>str</code>
+                  <code><autoref identifier="str" optional>str</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9374,11 +9315,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
             </td>
           </tr>
           <tr class="doc-section-item">
+            <td><code>resolver_type</code></td>
             <td>
-                <code>resolver_type</code>
-            </td>
-            <td>
-                  <code>str</code>
+                  <code><autoref identifier="str" optional>str</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9407,7 +9346,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
 
     <div class="doc doc-contents ">
 
-        <p>Execute a query from the ORM.</p>
+      <p>Execute a query from the ORM.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9422,11 +9361,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
       </thead>
       <tbody>
           <tr class="doc-section-item">
+            <td><code>query</code></td>
             <td>
-                <code>query</code>
-            </td>
-            <td>
-                  <code>str</code>
+                  <code><autoref identifier="str" optional>str</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9438,11 +9375,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
             </td>
           </tr>
           <tr class="doc-section-item">
+            <td><code>variables</code></td>
             <td>
-                <code>variables</code>
-            </td>
-            <td>
-                  <code>dict</code>
+                  <code><autoref identifier="dict" optional>dict</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9454,11 +9389,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
             </td>
           </tr>
           <tr class="doc-section-item">
+            <td><code>request</code></td>
             <td>
-                <code>request</code>
-            </td>
-            <td>
-                  <code><span title="django.test.client.RequestFactory">RequestFactory</span></code>
+                  <code><autoref identifier="django.test.client.RequestFactory" optional hover>RequestFactory</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9470,11 +9403,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
             </td>
           </tr>
           <tr class="doc-section-item">
+            <td><code>user</code></td>
             <td>
-                <code>user</code>
-            </td>
-            <td>
-                  <code><span title="django.contrib.auth.models.User">User</span></code>
+                  <code><autoref identifier="django.contrib.auth.models.User" optional hover>User</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9500,7 +9431,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>GraphQLDocument</code>
+                  <code><autoref identifier="GraphQLDocument" optional>GraphQLDocument</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9526,7 +9457,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
 
     <div class="doc doc-contents ">
 
-        <p>Execute saved query from the ORM.</p>
+      <p>Execute saved query from the ORM.</p>
 
 
 <p><span class="doc-section-title">Parameters:</span></p>
@@ -9541,11 +9472,9 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
       </thead>
       <tbody>
           <tr class="doc-section-item">
+            <td><code>saved_query_name</code></td>
             <td>
-                <code>saved_query_name</code>
-            </td>
-            <td>
-                  <code>str</code>
+                  <code><autoref identifier="str" optional>str</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9573,7 +9502,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
           <tr class="doc-section-item">
             <td><code>variables</code></td>
             <td>
-                  <code>Optional[dict]</code>
+                  <code><autoref identifier="Optional" optional>Optional</autoref>[<autoref identifier="dict" optional>dict</autoref>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9584,7 +9513,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
           <tr class="doc-section-item">
             <td><code>request</code></td>
             <td>
-                  <code>Optional[<span title="django.test.client.RequestFactory">RequestFactory</span>]</code>
+                  <code><autoref identifier="Optional" optional>Optional</autoref>[<autoref identifier="django.test.client.RequestFactory" optional hover>RequestFactory</autoref>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9595,7 +9524,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
           <tr class="doc-section-item">
             <td><code>user</code></td>
             <td>
-                  <code>Optional[<span title="django.contrib.auth.models.User">User</span>]</code>
+                  <code><autoref identifier="Optional" optional>Optional</autoref>[<autoref identifier="django.contrib.auth.models.User" optional hover>User</autoref>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9618,7 +9547,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>GraphQLDocument</code>
+                  <code><autoref identifier="GraphQLDocument" optional>GraphQLDocument</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9644,7 +9573,7 @@ that this approach may fail for values in excess of 2^53-1 (the largest integer
 
     <div class="doc doc-contents ">
 
-        <p>Generate a list of filter arguments from a filterset.</p>
+      <p>Generate a list of filter arguments from a filterset.</p>
 <p>The FilterSet class will be instantiated before extracting the list of arguments to
 account for dynamic filters, inserted when the class is instantiated. (required for Custom Fields filters).</p>
 <p>Filter fields that are inheriting from BooleanFilter and NumberFilter will be converted
@@ -9664,11 +9593,9 @@ if the filter field is a subclass of MultipleChoiceFilter, the argument will be
       </thead>
       <tbody>
           <tr class="doc-section-item">
+            <td><code>filterset_class</code></td>
             <td>
-                <code>filterset_class</code>
-            </td>
-            <td>
-                  <code>FilterSet</code>
+                  <code><autoref identifier="FilterSet" optional>FilterSet</autoref></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9694,7 +9621,7 @@ if the filter field is a subclass of MultipleChoiceFilter, the argument will be
       <tbody>
           <tr class="doc-section-item">
             <td>
-                  <code>dict[<span title="graphene.Argument">Argument</span>]</code>
+                  <code><autoref identifier="dict" optional>dict</autoref>[<autoref identifier="graphene.Argument" optional hover>Argument</autoref>]</code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -9720,7 +9647,7 @@ if the filter field is a subclass of MultipleChoiceFilter, the argument will be
 
     <div class="doc doc-contents ">
 
-        <p>Convert a string to a variable compatible name.</p>
+      <p>Convert a string to a variable compatible name.</p>
 
 
 <p><span class="doc-section-title">Examples:</span></p>
@@ -9883,7 +9810,7 @@ if the filter field is a subclass of MultipleChoiceFilter, the argument will be
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.annotate", "content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.88dd0f4e.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>