Build documentation for 0.0 at 0cfb0fc

_modules/exodus_gw/settings.html

@@ -151,6 +151,19 @@ <h1>Source code for exodus_gw.settings</h1><div class="highlight"><pre>
     <span class="n">upload_meta_fields</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Permitted metadata field names for s3 uploads and their regex</span>
 <span class="sd">    for validation. E.g., &quot;exodus-migration-md5&quot;: &quot;^[0-9a-f]{32}$&quot;</span>
+<span class="sd">    &quot;&quot;&quot;</span>
+
+    <span class="n">publish_paths</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">list</span><span class="p">[</span><span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="p">{}</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;A set of user or service accounts which are only authorized to publish to a</span>
+<span class="sd">    particular set of path(s) in a given CDN environment and the regex(es) describing</span>
+<span class="sd">    the paths to which the user or service account is authorized to publish. The user or</span>
+<span class="sd">    service account will be prevented from publishing to any paths that do not match the</span>
+<span class="sd">    defined regular expression(s).</span>
+<span class="sd">    E.g., &#39;{&quot;pre&quot;: {&quot;fake-user&quot;:</span>
+<span class="sd">    [&quot;^(/content)?/origin/files/sha256/[0-f]{2}/[0-f]{64}/[^/]{1,300}$&quot;]}}&#39;</span>
+
+<span class="sd">    Any user or service account not included in this configuration is considered to have</span>
+<span class="sd">    unrestricted publish access (i.e., can publish to any path).</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="n">log_config</span><span class="p">:</span> <span class="nb">dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>

deployment.html

@@ -119,6 +119,20 @@ <h2>Settings<a class="headerlink" href="#settings" title="Link to this heading">
 for validation. E.g., “exodus-migration-md5”: “^[0-9a-f]{32}$”</p>
 </dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="exodus_gw.settings.Settings.publish_paths">
+<span class="sig-name descname"><span class="pre">publish_paths</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#list" title="(in Python v3.12)"><span class="pre">list</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#exodus_gw.settings.Settings.publish_paths" title="Link to this definition">¶</a></dt>
+<dd><p>A set of user or service accounts which are only authorized to publish to a
+particular set of path(s) in a given CDN environment and the regex(es) describing
+the paths to which the user or service account is authorized to publish. The user or
+service account will be prevented from publishing to any paths that do not match the
+defined regular expression(s).
+E.g., ‘{“pre”: {“fake-user”:
+[“^(/content)?/origin/files/sha256/[0-f]{2}/[0-f]{64}/[^/]{1,300}$”]}}’</p>
+<p>Any user or service account not included in this configuration is considered to have
+unrestricted publish access (i.e., can publish to any path).</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="exodus_gw.settings.Settings.log_config">
 <span class="sig-name descname"><span class="pre">log_config</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#dict" title="(in Python v3.12)"><span class="pre">dict</span></a><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Any" title="(in Python v3.12)"><span class="pre">Any</span></a><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#exodus_gw.settings.Settings.log_config" title="Link to this definition">¶</a></dt>

genindex.html

@@ -148,6 +148,10 @@ <h2 id="L">L</h2>
 
 <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="deployment.html#exodus_gw.settings.Settings.publish_paths">publish_paths (exodus_gw.settings.Settings attribute)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="deployment.html#exodus_gw.settings.Settings.publish_timeout">publish_timeout (exodus_gw.settings.Settings attribute)</a>
 </li>