Apply automatic documentation changes

Author: frickjack

docs/_build/doctrees/auth.doctree

@@ -56,18 +56,23 @@ <h1>Source code for gen3.index</h1><div class="highlight"><pre>
 <span class="sd">    A class for interacting with the Gen3 Index services.</span>
 
 <span class="sd">    Args:</span>
+<span class="sd">        endpoint (str): public endpoint for reading/querying indexd - only necessary if auth_provider not provided</span>
 <span class="sd">        auth_provider (Gen3Auth): A Gen3Auth class instance or indexd basic creds tuple</span>
 
 <span class="sd">    Examples:</span>
 <span class="sd">        This generates the Gen3Index class pointed at the sandbox commons while</span>
 <span class="sd">        using the credentials.json downloaded from the commons profile page.</span>
 
 <span class="sd">        &gt;&gt;&gt; auth = Gen3Auth(refresh_file=&quot;credentials.json&quot;)</span>
-<span class="sd">        ... sub = Gen3Submission(auth.endpoint, auth)</span>
+<span class="sd">        ... sub = Gen3Submission(auth)</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">auth_provider</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">service_location</span><span class="o">=</span><span class="s2">&quot;index&quot;</span><span class="p">):</span>
+        <span class="c1"># legacy interface required endpoint as 1st arg</span>
+        <span class="k">if</span> <span class="n">endpoint</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span><span class="n">Gen3Auth</span><span class="p">):</span>
+            <span class="n">auth_provider</span> <span class="o">=</span> <span class="n">endpoint</span>
+            <span class="n">endpoint</span> <span class="o">=</span> <span class="kc">None</span>
         <span class="k">if</span> <span class="n">auth_provider</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">auth_provider</span><span class="p">,</span><span class="n">Gen3Auth</span><span class="p">):</span>
             <span class="n">endpoint</span> <span class="o">=</span> <span class="n">auth_provider</span><span class="o">.</span><span class="n">endpoint</span>
         <span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>

docs/_build/doctrees/environment.pickle

@@ -83,6 +83,7 @@ <h1>Source code for gen3.jobs</h1><div class="highlight"><pre>
 <span class="sd">            service_location (str, optional): deployment location relative to the</span>
 <span class="sd">                endpoint provided</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="c1"># auth_provider legacy interface required endpoint as 1st arg</span>
         <span class="n">auth_provider</span> <span class="o">=</span> <span class="n">auth_provider</span> <span class="ow">or</span> <span class="n">endpoint</span>
         <span class="n">endpoint</span> <span class="o">=</span> <span class="n">auth_provider</span><span class="o">.</span><span class="n">endpoint</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
         <span class="c1"># if running locally, mds is deployed by itself without a location relative</span>

docs/_build/doctrees/indexing.doctree

@@ -49,6 +49,7 @@ <h1>Source code for gen3.metadata</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">sys</span>
 
 <span class="kn">from</span> <span class="nn">gen3.utils</span> <span class="k">import</span> <span class="n">append_query_params</span><span class="p">,</span> <span class="n">DEFAULT_BACKOFF_SETTINGS</span>
+<span class="kn">from</span> <span class="nn">gen3.auth</span> <span class="k">import</span> <span class="n">Gen3Auth</span>
 
 
 <div class="viewcode-block" id="Gen3Metadata"><a class="viewcode-back" href="../../metadata.html#gen3.metadata.Gen3Metadata">[docs]</a><span class="k">class</span> <span class="nc">Gen3Metadata</span><span class="p">:</span>
@@ -59,17 +60,17 @@ <h1>Source code for gen3.metadata</h1><div class="highlight"><pre>
 <span class="sd">        This generates the Gen3Metadata class pointed at the sandbox commons while</span>
 <span class="sd">        using the credentials.json downloaded from the commons profile page.</span>
 
-<span class="sd">        &gt;&gt;&gt; auth = Gen3Auth(endpoint, refresh_file=&quot;credentials.json&quot;)</span>
-<span class="sd">        ... sub = Gen3Metadata(auth.endpoint, auth)</span>
+<span class="sd">        &gt;&gt;&gt; auth = Gen3Auth(refresh_file=&quot;credentials.json&quot;)</span>
+<span class="sd">        ... sub = Gen3Metadata(auth)</span>
 
 <span class="sd">    Attributes:</span>
-<span class="sd">        admin_endpoint (str): endpoint for admin functionality (Create/Update/Delete)</span>
-<span class="sd">        endpoint (str): public endpoint for reading/querying metadata</span>
+<span class="sd">        endpoint (str): public endpoint for reading/querying metadata - only necessary if auth_provider not provided</span>
+<span class="sd">        auth_provider (Gen3Auth): auth manager</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
     <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
-        <span class="n">endpoint</span><span class="p">,</span>
+        <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
         <span class="n">auth_provider</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
         <span class="n">service_location</span><span class="o">=</span><span class="s2">&quot;mds&quot;</span><span class="p">,</span>
         <span class="n">admin_endpoint_suffix</span><span class="o">=</span><span class="s2">&quot;-admin&quot;</span><span class="p">,</span>
@@ -84,6 +85,12 @@ <h1>Source code for gen3.metadata</h1><div class="highlight"><pre>
 <span class="sd">            service_location (str, optional): deployment location relative to the</span>
 <span class="sd">                endpoint provided</span>
 <span class="sd">        &quot;&quot;&quot;</span>
+        <span class="c1"># legacy interface required endpoint as 1st arg</span>
+        <span class="k">if</span> <span class="n">endpoint</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">endpoint</span><span class="p">,</span><span class="n">Gen3Auth</span><span class="p">):</span>
+            <span class="n">auth_provider</span> <span class="o">=</span> <span class="n">endpoint</span>
+            <span class="n">endpoint</span> <span class="o">=</span> <span class="kc">None</span>
+        <span class="k">if</span> <span class="n">auth_provider</span> <span class="ow">and</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">auth_provider</span><span class="p">,</span><span class="n">Gen3Auth</span><span class="p">):</span>
+            <span class="n">endpoint</span> <span class="o">=</span> <span class="n">auth_provider</span><span class="o">.</span><span class="n">endpoint</span>
         <span class="n">endpoint</span> <span class="o">=</span> <span class="n">endpoint</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">&quot;/&quot;</span><span class="p">)</span>
         <span class="c1"># if running locally, mds is deployed by itself without a location relative</span>
         <span class="c1"># to the commons</span>