updated docs

stroeer · Sep 29, 2021 · ee2c8ae · ee2c8ae
1 parent ce9417b
commit ee2c8ae
Show file tree

Hide file tree

Showing 18 changed files with 411 additions and 163 deletions.
diff --git a/docs/404.html b/docs/404.html
@@ -97,7 +97,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">6.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">7.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">8.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">9.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">10.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">11.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">12.</strong> ℠StageService</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="keyword.html"><strong aria-hidden="true">6.</strong> Keyword</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">7.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">8.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">9.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">10.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">11.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">12.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">13.</strong> ℠StageService</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>

diff --git a/docs/article.html b/docs/article.html
@@ -95,7 +95,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html" class="active"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">6.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">7.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">8.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">9.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">10.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">11.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">12.</strong> ℠StageService</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html" class="active"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="keyword.html"><strong aria-hidden="true">6.</strong> Keyword</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">7.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">8.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">9.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">10.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">11.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">12.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">13.</strong> ℠StageService</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>
@@ -260,9 +260,9 @@ <h2><a class="header" href="#elements" id="elements"><code>elements</code></a></
 as a teaser e.g. on section pages. See <a href="element.html"><code>Element</code></a>
 <a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L152-L159">[~]</a></p>
 <h2><a class="header" href="#keywords" id="keywords"><code>keywords</code></a></h2>
-<pre><code class="language-protobuf">repeated string keywords = 9;
+<pre><code class="language-protobuf">repeated Keyword keywords = 9;
 </code></pre>
-<p>Extracted entities from the article body like people, places, organizations etc.
+<p>Extracted keywords from the article body like persons, locations, organizations etc.
 <a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L163-L168">[~]</a></p>
 <h2><a class="header" href="#onwards" id="onwards"><code>onwards</code></a></h2>
 <pre><code class="language-protobuf">repeated int64 onwards = 10;
@@ -271,6 +271,12 @@ <h2><a class="header" href="#onwards" id="onwards"><code>onwards</code></a></h2>
 <p>Related articles are defined manually in the content management system
 by the editorial department.
 <a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L172-L180">[~]</a></p>
+<h2><a class="header" href="#entities" id="entities"><code>entities</code></a></h2>
+<pre><code class="language-protobuf">repeated string entities = 100;
+</code></pre>
+<p>Extracted entities from the article body like persons, locations, organizations etc.</p>
+<p><code>entities</code> are deprecated and should not be used by clients, use <code>keywords</code> instead.
+<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L184-L191">[~]</a></p>
 <h2><a class="header" href="#enum-contenttype" id="enum-contenttype"><code>enum ContentType</code></a></h2>
 <pre><code class="language-protobuf">enum ContentType {
   // Not specified.
@@ -298,7 +304,7 @@ <h2><a class="header" href="#enum-contenttype" id="enum-contenttype"><code>enum
   AGENCY = 7;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L184-L212">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L195-L223">[~]</a></p>
 <h2><a class="header" href="#enum-contentsubtype" id="enum-contentsubtype"><code>enum ContentSubType</code></a></h2>
 <pre><code class="language-protobuf">enum ContentSubType {
   // Not specified.
@@ -310,39 +316,27 @@ <h2><a class="header" href="#enum-contentsubtype" id="enum-contentsubtype"><code
   // 'Kolumne'
   COLUMN = 2;
 
-  // 'Bericht'
-  REPORT = 3;
-
   // 'Kommentar'
-  COMMENTARY = 4;
+  COMMENTARY = 3;
 
   // 'Interview'
-  INTERVIEW = 5;
+  INTERVIEW = 4;
 
   // 'Pro und Kontra/Streitgespräch'
-  CONTROVERSY = 6;
-
-  // 'Reportage'
-  STORY = 7;
-
-  // 'Rezension/Kritik'
-  RECENSION = 8;
+  CONTROVERSY = 5;
 
   // 'Tagesanbruch'
-  TAGESANBRUCH = 9;
-
-  // 'Analyse'
-  ANALYSIS = 10;
+  TAGESANBRUCH = 6;
 
-  // 'Satire/Glosse'
-  SATIRE = 11;
+  // 'Evergreen'
+  EVERGREEN = 7;
 
   // Content originally imported from agency/tickers by the CMS
-  AGENCY_IMPORT = 12;
+  AGENCY_IMPORT = 8;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L240-L283">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L326-L327">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L251-L282">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L313-L314">[~]</a></p>
 
                     </main>
 

diff --git a/docs/asset.html b/docs/asset.html
@@ -95,7 +95,7 @@
 
         <nav id="sidebar" class="sidebar" aria-label="Table of contents">
             <div class="sidebar-scrollbox">
-                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html" class="active"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">6.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">7.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">8.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">9.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">10.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">11.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">12.</strong> ℠StageService</a></li></ol>
+                <ol class="chapter"><li class="chapter-item expanded "><a href="article.html"><strong aria-hidden="true">1.</strong> Article</a></li><li class="chapter-item expanded "><a href="asset.html" class="active"><strong aria-hidden="true">2.</strong> Asset</a></li><li class="chapter-item expanded "><a href="body.html"><strong aria-hidden="true">3.</strong> Body</a></li><li class="chapter-item expanded "><a href="bodynode.html"><strong aria-hidden="true">4.</strong> BodyNode</a></li><li class="chapter-item expanded "><a href="element.html"><strong aria-hidden="true">5.</strong> Element</a></li><li class="chapter-item expanded "><a href="keyword.html"><strong aria-hidden="true">6.</strong> Keyword</a></li><li class="chapter-item expanded "><a href="metadata.html"><strong aria-hidden="true">7.</strong> Metadata</a></li><li class="chapter-item expanded "><a href="reference.html"><strong aria-hidden="true">8.</strong> Reference</a></li><li class="chapter-item expanded "><a href="stage.html"><strong aria-hidden="true">9.</strong> Stage</a></li><li class="chapter-item expanded "><a href="℠articlepageservice.html"><strong aria-hidden="true">10.</strong> ℠ArticlePageService</a></li><li class="chapter-item expanded "><a href="℠curationservice.html"><strong aria-hidden="true">11.</strong> ℠CurationService</a></li><li class="chapter-item expanded "><a href="℠sectionpageservice.html"><strong aria-hidden="true">12.</strong> ℠SectionPageService</a></li><li class="chapter-item expanded "><a href="℠stageservice.html"><strong aria-hidden="true">13.</strong> ℠StageService</a></li></ol>
             </div>
             <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
         </nav>
@@ -169,24 +169,24 @@ <h1><a class="header" href="#asset" id="asset">Asset</a></h1>
 <p>Asset of an <a href="element.html">Element</a>.</p>
 <p>An asset configuration is dependant upon its use, it may alter depending
 on its <a href="#enum-assettype"><code>type</code></a> field.
-<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L775-L783">[~]</a></p>
+<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L762-L770">[~]</a></p>
 <h2><a class="header" href="#type" id="type"><code>type</code></a></h2>
 <p>Type of the asset. See <a href="#assettype"><code>AssetType</code></a></p>
 <pre><code class="language-protobuf">AssetType type = 1;
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L787-L792">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L774-L779">[~]</a></p>
 <h2><a class="header" href="#fields" id="fields"><code>fields</code></a></h2>
 <pre><code class="language-protobuf">map&lt;string, string&gt; fields = 2;
 </code></pre>
 <p>Generic map containing general content and configuration information of
 the asset.</p>
 <p>Clients must be resilient to unknown or missing entry sets.
-<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L796-L805">[~]</a></p>
+<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L783-L792">[~]</a></p>
 <h2><a class="header" href="#metadata" id="metadata"><code>metadata</code></a></h2>
 <pre><code class="language-protobuf">Metadata metadata = 3;
 </code></pre>
 <p>Technical metadata for this asset (state, validity, ...). See <a href="metadata.html"><code>Metadata</code></a>
-<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L809-L814">[~]</a></p>
+<a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L796-L801">[~]</a></p>
 <h2><a class="header" href="#enum-assettype" id="enum-assettype"><code>enum AssetType</code></a></h2>
 <p>Type of an asset.</p>
 <pre><code class="language-protobuf">  enum AssetType {
@@ -207,7 +207,7 @@ <h2><a class="header" href="#enum-assettype" id="enum-assettype"><code>enum Asse
   METADATA = 4;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L819-L841">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L806-L828">[~]</a></p>
 <h2><a class="header" href="#samples" id="samples">Samples</a></h2>
 <h3><a class="header" href="#image-asset" id="image-asset">Image Asset</a></h3>
 <pre><code class="language-javascript">{
@@ -288,8 +288,8 @@ <h3><a class="header" href="#video-metadata-asset" id="video-metadata-asset">Vid
 
 ...
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L862-L951">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L955-L956">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L849-L938">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/master/stroeer/core/v1/article.proto#L942-L943">[~]</a></p>
 
                     </main>