docs: updated sphinx docs

Author: akimrx

docs/_modules/yc_lockbox/_models.html

@@ -227,9 +227,12 @@ <h1>Source code for yc_lockbox._models</h1><div class="highlight"><pre>
     <span class="n">model_config</span><span class="p">:</span> <span class="n">ConfigDict</span> <span class="o">=</span> <span class="n">ConfigDict</span><span class="p">(</span><span class="n">extra</span><span class="o">=</span><span class="s2">&quot;forbid&quot;</span><span class="p">,</span> <span class="n">populate_by_name</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
 
 
+<div class="viewcode-block" id="IamTokenResponse">
+<a class="viewcode-back" href="../../pages/models.html#yc_lockbox._models.IamTokenResponse">[docs]</a>
 <span class="k">class</span> <span class="nc">IamTokenResponse</span><span class="p">(</span><span class="n">BaseDomainModel</span><span class="p">):</span>
     <span class="n">token</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="s2">&quot;iamToken&quot;</span><span class="p">)</span>
-    <span class="n">expires_at</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="s2">&quot;expiresAt&quot;</span><span class="p">)</span>
+    <span class="n">expires_at</span><span class="p">:</span> <span class="n">datetime</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="o">...</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="s2">&quot;expiresAt&quot;</span><span class="p">)</span></div>
+
 
 
 <div class="viewcode-block" id="SecretPayloadEntry">
@@ -535,20 +538,31 @@ <h1>Source code for yc_lockbox._models</h1><div class="highlight"><pre>
     <span class="n">next_page_token</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="n">Field</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="n">alias</span><span class="o">=</span><span class="s2">&quot;nextPageToken&quot;</span><span class="p">)</span>
 
 
+<div class="viewcode-block" id="SecretsList">
+<a class="viewcode-back" href="../../pages/models.html#yc_lockbox._models.SecretsList">[docs]</a>
 <span class="k">class</span> <span class="nc">SecretsList</span><span class="p">(</span><span class="n">BasePaginatedResponse</span><span class="p">):</span>
-    <span class="n">secrets</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Secret</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
+    <span class="n">secrets</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">Secret</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></div>
+
 
 
+<div class="viewcode-block" id="SecretVersionsList">
+<a class="viewcode-back" href="../../pages/models.html#yc_lockbox._models.SecretVersionsList">[docs]</a>
 <span class="k">class</span> <span class="nc">SecretVersionsList</span><span class="p">(</span><span class="n">BasePaginatedResponse</span><span class="p">):</span>
-    <span class="n">versions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">SecretVersion</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
+    <span class="n">versions</span><span class="p">:</span> <span class="nb">list</span><span class="p">[</span><span class="n">SecretVersion</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span></div>
+
 
 
+<div class="viewcode-block" id="YandexCloudError">
+<a class="viewcode-back" href="../../pages/models.html#yc_lockbox._models.YandexCloudError">[docs]</a>
 <span class="k">class</span> <span class="nc">YandexCloudError</span><span class="p">(</span><span class="n">BaseDomainModel</span><span class="p">):</span>
     <span class="n">code</span><span class="p">:</span> <span class="nb">int</span>
     <span class="n">message</span><span class="p">:</span> <span class="nb">str</span> <span class="o">|</span> <span class="kc">None</span> <span class="o">=</span> <span class="kc">None</span>
-    <span class="n">details</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span>
+    <span class="n">details</span><span class="p">:</span> <span class="n">Any</span> <span class="o">=</span> <span class="kc">None</span></div>
 
 
+
+<div class="viewcode-block" id="Operation">
+<a class="viewcode-back" href="../../pages/models.html#yc_lockbox._models.Operation">[docs]</a>
 <span class="k">class</span> <span class="nc">Operation</span><span class="p">(</span><span class="n">BaseDomainModel</span><span class="p">):</span>
     <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span>
     <span class="n">done</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
@@ -587,7 +601,8 @@ <h1>Source code for yc_lockbox._models</h1><div class="highlight"><pre>
 
         <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">client</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
             <span class="n">resource</span><span class="o">.</span><span class="n">inject_client</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">client</span><span class="p">)</span>
-        <span class="k">return</span> <span class="n">resource</span>
+        <span class="k">return</span> <span class="n">resource</span></div>
+
 </pre></div>
         </article>
       </div>

docs/_sources/pages/models.rst.txt

@@ -16,6 +16,17 @@ Domain models provide complete information about the resource, similar to aggreg
 .. autopydantic_model:: yc_lockbox._models.SecretPayloadEntry
 
 
+Paginated models
+^^^^^^^^^^^^^^^^
+
+Used when ``iterator=False``.
+
+.. autopydantic_model:: yc_lockbox._models.SecretsList
+
+.. autopydantic_model:: yc_lockbox._models.SecretVersionsList
+
+
+
 Upsert models
 -------------
 
@@ -28,3 +39,15 @@ Upsert models (interfaces) are designed for operations of creating new resources
 .. autopydantic_model:: yc_lockbox._models.INewSecretPayloadEntry
 
 .. autopydantic_model:: yc_lockbox._models.IUpdateSecret
+
+
+Common models
+-------------
+
+Other Yandex Cloud models related to Lockbox.
+
+.. autopydantic_model:: yc_lockbox._models.Operation
+
+.. autopydantic_model:: yc_lockbox._models.YandexCloudError
+
+.. autopydantic_model:: yc_lockbox._models.IamTokenResponse

docs/genindex.html

@@ -197,7 +197,7 @@
 
 <section class="genindex-section">
   <h1 id="index">Index</h1>
-  <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#K"><strong>K</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#Y"><strong>Y</strong></a></div>
+  <div class="genindex-jumpbox"><a href="#A"><strong>A</strong></a> | <a href="#B"><strong>B</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#E"><strong>E</strong></a> | <a href="#F"><strong>F</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#I"><strong>I</strong></a> | <a href="#K"><strong>K</strong></a> | <a href="#L"><strong>L</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#N"><strong>N</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#T"><strong>T</strong></a> | <a href="#U"><strong>U</strong></a> | <a href="#V"><strong>V</strong></a> | <a href="#Y"><strong>Y</strong></a></div>
 </section>
 <section id="A" class="genindex-section">
   <h2>A</h2>
@@ -251,16 +251,22 @@ <h2>C</h2>
           <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.cancel_version_destruction">(yc_lockbox._models.SecretVersion method)</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.YandexCloudError.code">code (yc_lockbox._models.YandexCloudError attribute)</a>
+</li>
         <li><a href="pages/clients.html#yc_lockbox.YandexLockboxClient.create_secret">create_secret() (yc_lockbox.YandexLockboxClient method)</a>
 </li>
-        <li><a href="pages/models.html#yc_lockbox._models.Secret.created_at">created_at (yc_lockbox._models.Secret attribute)</a>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.created_at">created_at (yc_lockbox._models.Operation attribute)</a>
 
         <ul>
+          <li><a href="pages/models.html#yc_lockbox._models.Secret.created_at">(yc_lockbox._models.Secret attribute)</a>
+</li>
           <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.created_at">(yc_lockbox._models.SecretVersion attribute)</a>
 </li>
         </ul></li>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.created_by">created_by (yc_lockbox._models.Operation attribute)</a>
+</li>
         <li><a href="pages/models.html#yc_lockbox._models.Secret.current_version">current_version (yc_lockbox._models.Secret attribute)</a>
 </li>
     </ul></td>
@@ -287,21 +293,27 @@ <h2>D</h2>
           <li><a href="pages/models.html#yc_lockbox._models.Secret.deletion_protection">(yc_lockbox._models.Secret attribute)</a>
 </li>
         </ul></li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.INewSecret.description">description (yc_lockbox._models.INewSecret attribute)</a>
 
         <ul>
           <li><a href="pages/models.html#yc_lockbox._models.INewSecretVersion.description">(yc_lockbox._models.INewSecretVersion attribute)</a>
 </li>
           <li><a href="pages/models.html#yc_lockbox._models.IUpdateSecret.description">(yc_lockbox._models.IUpdateSecret attribute)</a>
+</li>
+          <li><a href="pages/models.html#yc_lockbox._models.Operation.description">(yc_lockbox._models.Operation attribute)</a>
 </li>
           <li><a href="pages/models.html#yc_lockbox._models.Secret.description">(yc_lockbox._models.Secret attribute)</a>
 </li>
           <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.description">(yc_lockbox._models.SecretVersion attribute)</a>
 </li>
         </ul></li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.destroy_at">destroy_at (yc_lockbox._models.SecretVersion attribute)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.YandexCloudError.details">details (yc_lockbox._models.YandexCloudError attribute)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.done">done (yc_lockbox._models.Operation attribute)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -312,6 +324,12 @@ <h2>E</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.SecretPayload.entries">entries (yc_lockbox._models.SecretPayload attribute)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.error">error (yc_lockbox._models.Operation attribute)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.IamTokenResponse.expires_at">expires_at (yc_lockbox._models.IamTokenResponse attribute)</a>
 </li>
     </ul></td>
   </tr></table>
@@ -353,9 +371,11 @@ <h2>G</h2>
   <h2>I</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="pages/models.html#yc_lockbox._models.Secret.id">id (yc_lockbox._models.Secret attribute)</a>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.id">id (yc_lockbox._models.Operation attribute)</a>
 
         <ul>
+          <li><a href="pages/models.html#yc_lockbox._models.Secret.id">(yc_lockbox._models.Secret attribute)</a>
+</li>
           <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.id">(yc_lockbox._models.SecretVersion attribute)</a>
 </li>
         </ul></li>
@@ -413,6 +433,22 @@ <h2>L</h2>
   </tr></table>
 </section>
 
+<section id="M" class="genindex-section">
+  <h2>M</h2>
+  <table style="width: 100%" class="indextable genindextable"><tr>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.YandexCloudError.message">message (yc_lockbox._models.YandexCloudError attribute)</a>
+</li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.metadata">metadata (yc_lockbox._models.Operation attribute)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.modified_at">modified_at (yc_lockbox._models.Operation attribute)</a>
+</li>
+    </ul></td>
+  </tr></table>
+</section>
+
 <section id="N" class="genindex-section">
   <h2>N</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
@@ -454,9 +490,13 @@ <h2>R</h2>
   <table style="width: 100%" class="indextable genindextable"><tr>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.Secret.refresh">refresh() (yc_lockbox._models.Secret method)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.resource">resource (yc_lockbox._models.Operation property)</a>
 </li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.Operation.response">response (yc_lockbox._models.Operation attribute)</a>
+</li>
         <li><a href="pages/models.html#yc_lockbox._models.SecretPayloadEntry.reveal_binary_value">reveal_binary_value() (yc_lockbox._models.SecretPayloadEntry method)</a>
 </li>
         <li><a href="pages/models.html#yc_lockbox._models.SecretPayloadEntry.reveal_text_value">reveal_text_value() (yc_lockbox._models.SecretPayloadEntry method)</a>
@@ -477,9 +517,11 @@ <h2>S</h2>
           <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.schedule_version_destruction">(yc_lockbox._models.SecretVersion method)</a>
 </li>
         </ul></li>
+        <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.secret_id">secret_id (yc_lockbox._models.SecretVersion attribute)</a>
+</li>
     </ul></td>
     <td style="width: 33%; vertical-align: top;"><ul>
-        <li><a href="pages/models.html#yc_lockbox._models.SecretVersion.secret_id">secret_id (yc_lockbox._models.SecretVersion attribute)</a>
+        <li><a href="pages/models.html#yc_lockbox._models.SecretsList.secrets">secrets (yc_lockbox._models.SecretsList attribute)</a>
 </li>
         <li><a href="pages/clients.html#yc_lockbox.YandexLockboxClient.set_secret_access_bindings">set_secret_access_bindings() (yc_lockbox.YandexLockboxClient method)</a>
 </li>
@@ -504,6 +546,10 @@ <h2>T</h2>
 </li>
         </ul></li>
     </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
+        <li><a href="pages/models.html#yc_lockbox._models.IamTokenResponse.token">token (yc_lockbox._models.IamTokenResponse attribute)</a>
+</li>
+    </ul></td>
   </tr></table>
 </section>
 
@@ -531,11 +577,13 @@ <h2>V</h2>
     <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.INewSecret.version_description">version_description (yc_lockbox._models.INewSecret attribute)</a>
 </li>
-    </ul></td>
-    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.SecretPayload.version_id">version_id (yc_lockbox._models.SecretPayload attribute)</a>
 </li>
+    </ul></td>
+    <td style="width: 33%; vertical-align: top;"><ul>
         <li><a href="pages/models.html#yc_lockbox._models.INewSecret.version_payload_entries">version_payload_entries (yc_lockbox._models.INewSecret attribute)</a>
+</li>
+        <li><a href="pages/models.html#yc_lockbox._models.SecretVersionsList.versions">versions (yc_lockbox._models.SecretVersionsList attribute)</a>
 </li>
     </ul></td>
   </tr></table>

docs/index.html

@@ -405,6 +405,7 @@ <h2>Modules<a class="headerlink" href="#modules" title="Link to this heading">#<
 <li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.SecretVersion"><code class="docutils literal notranslate"><span class="pre">SecretVersion</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.SecretPayload"><code class="docutils literal notranslate"><span class="pre">SecretPayload</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.SecretPayloadEntry"><code class="docutils literal notranslate"><span class="pre">SecretPayloadEntry</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pages/models.html#paginated-models">Paginated models</a></li>
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pages/models.html#upsert-models">Upsert models</a><ul>
@@ -414,6 +415,12 @@ <h2>Modules<a class="headerlink" href="#modules" title="Link to this heading">#<
 <li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.IUpdateSecret"><code class="docutils literal notranslate"><span class="pre">IUpdateSecret</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="pages/models.html#common-models">Common models</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.Operation"><code class="docutils literal notranslate"><span class="pre">Operation</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.YandexCloudError"><code class="docutils literal notranslate"><span class="pre">YandexCloudError</span></code></a></li>
+<li class="toctree-l3"><a class="reference internal" href="pages/models.html#yc_lockbox._models.IamTokenResponse"><code class="docutils literal notranslate"><span class="pre">IamTokenResponse</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="pages/exceptions.html">Exceptions</a></li>