Skip to content

Commit

Permalink
Minor manual fix
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexanderWatzinger committed Feb 5, 2025
1 parent 711584e commit d5d8a7b
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 19 deletions.
Binary file modified openatlas/static/manual/.doctrees/admin/api.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/admin/import.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/entity/source.doctree
Binary file not shown.
Binary file modified openatlas/static/manual/.doctrees/environment.pickle
Binary file not shown.
60 changes: 51 additions & 9 deletions openatlas/static/manual/admin/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,29 +113,71 @@ <h1>API<a class="headerlink" href="#api" title="Permalink to this heading"></
<div class="toctree-wrapper compound">
</div>
<p>Description: <a class="reference internal" href="../technical/api.html"><span class="doc">API</span></a></p>
<ul>
<li><p><strong>Public</strong> (default=off)</p>
<section id="public-default-off">
<h2><strong>Public</strong> (default=off)<a class="headerlink" href="#public-default-off" title="Permalink to this heading"></a></h2>
<blockquote>
<div><ul>
<li><p>If turned off the API and files with a license can still be accessed by</p>
<li><p>If turned off, the API can still be accessed by</p>
<blockquote>
<div><ul class="simple">
<li><p>A browser used b a logged in user</p></li>
<li><p>A browser used by a logged in user</p></li>
<li><p>A request is using a <a class="reference internal" href="#valid-token"><span class="std std-ref">Valid token</span></a></p></li>
<li><p>If the IP of the request-computer is on the <strong>IP Whitelist</strong></p></li>
</ul>
</div></blockquote>
</li>
<li><p>If turned on the API and linked files with a license can be accessed without being logged in. This might be useful if you want to allow other systems to use your data without restrictions.</p></li>
</ul>
</div></blockquote>
</section>
<section id="api-token">
<h2><strong>API token</strong><a class="headerlink" href="#api-token" title="Permalink to this heading"></a></h2>
<p>API Tokens can be created to query the API if it is turned off. Only Admins
are allowed to create, revoke and delete tokens. Available options are:</p>
<blockquote>
<div><ul class="simple">
<li><p><strong>Generate</strong>: <a class="reference internal" href="#generate"><span class="std std-ref">Generate</span></a> a new token</p></li>
<li><p><strong>Revoke all tokens</strong>: Revoke all available tokens</p></li>
<li><p><strong>Authorize all tokens</strong>: All revoked tokens will be valid again</p></li>
<li><p><strong>Delete revoked tokens</strong>: All revoked tokens will be deleted</p></li>
<li><p><strong>Delete invalid tokens</strong>: All invalid tokens will be deleted (see <a class="reference internal" href="#valid-token"><span class="std std-ref">Valid token</span></a>)</p></li>
</ul>
</div></blockquote>
<section id="valid-token">
<span id="id1"></span><h3><strong>Valid token</strong><a class="headerlink" href="#valid-token" title="Permalink to this heading"></a></h3>
<p>A token is valid if:</p>
<blockquote>
<div><ul class="simple">
<li><p><strong>valid from</strong> is greater than current date</p></li>
<li><p><strong>revoked</strong> is <em>false</em>, meaning the token is not revoked</p></li>
<li><p><a class="reference internal" href="user.html"><span class="doc">User</span></a> is active</p></li>
</ul>
</div></blockquote>
</section>
<section id="generate">
<span id="id2"></span><h3><strong>Generate</strong><a class="headerlink" href="#generate" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><dl class="simple">
<dt><strong>Expiration</strong>:</dt><dd><p>Set how long a token is valid. Entered numbers are days. 0 means no expiration date.</p>
</dd>
</dl>
</li>
<li><dl class="simple">
<dt>If turned on the API and linked files with a</dt><dd><p>license can be accessed without being logged in. This might be useful
if you want to allow other systems to use your data without
restrictions.</p>
<dt><strong>Token name</strong>:</dt><dd><p>To better distinguish between tokens, a individual name can be entered.</p>
</dd>
</dl>
</li>
</ul>
</div></blockquote>
<li><dl class="simple">
<dt><strong>User</strong>:</dt><dd><p>Select a <a class="reference internal" href="user.html"><span class="doc">User</span></a> for which the token will be created.</p>
</dd>
</dl>
</li>
</ul>
<p>After the <em>Generate</em> button is clicked, the site will reload and a grey box appears.
In this box the token string will be visible and is copied on click.</p>
<p><strong>Be aware</strong>, this is the only time, the token will be visible!</p>
</section>
</section>
</section>


Expand Down
4 changes: 2 additions & 2 deletions openatlas/static/manual/admin/import.html
Original file line number Diff line number Diff line change
Expand Up @@ -361,8 +361,8 @@ <h2>After the import<a class="headerlink" href="#after-the-import" title="Permal
If advanced layout is enabled, the detail view of an entity shows from which
project the entity was imported, which user did the import and the
origin ID value.</p>
<p><strong>It is always a good idea to run :doc:`/admin/data_integrity_checks` after
each import.</strong></p>
<p>It is always a good idea to run <a class="reference internal" href="data_integrity_checks.html"><span class="doc">Data integrity checks</span></a> after
each import.</p>
</section>
</section>

Expand Down
8 changes: 7 additions & 1 deletion openatlas/static/manual/admin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,13 @@ <h1>Admin<a class="headerlink" href="#admin" title="Permalink to this heading">
<li class="toctree-l2"><a class="reference internal" href="execute_sql.html#result">Result</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul class="simple">
<li class="toctree-l1"><a class="reference internal" href="api.html">API</a><ul>
<li class="toctree-l2"><a class="reference internal" href="api.html#public-default-off"><strong>Public</strong> (default=off)</a></li>
<li class="toctree-l2"><a class="reference internal" href="api.html#api-token"><strong>API token</strong></a><ul>
<li class="toctree-l3"><a class="reference internal" href="api.html#valid-token"><strong>Valid token</strong></a></li>
<li class="toctree-l3"><a class="reference internal" href="api.html#generate"><strong>Generate</strong></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="arche.html">ARCHE</a><ul>
Expand Down
3 changes: 0 additions & 3 deletions openatlas/static/manual/entity/source.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,6 @@ <h2>Can be linked via tabs to<a class="headerlink" href="#can-be-linked-via-tabs
<li><p><a class="reference internal" href="file.html"><span class="doc">File</span></a></p></li>
</ul>
</section>
<section id="text-annotation">
<h2>Text annotation<a class="headerlink" href="#text-annotation" title="Permalink to this heading"></a></h2>
</section>
</section>


Expand Down
Binary file modified openatlas/static/manual/objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion openatlas/static/manual/searchindex.js

Large diffs are not rendered by default.

3 changes: 0 additions & 3 deletions sphinx/source/entity/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,3 @@ Can be linked via tabs to
editions of charters or secondary sources
* **Text** - add translations or similar to the source
* :doc:`file`

Text annotation
---------------

0 comments on commit d5d8a7b

Please sign in to comment.