docs released for new tag: v0.41.0

stroeer · Sep 12, 2023 · ddd0615 · ddd0615
1 parent 2d335b9
commit ddd0615
Show file tree

Hide file tree

Showing 10 changed files with 58 additions and 52 deletions.
diff --git a/docs/article.html b/docs/article.html
@@ -194,6 +194,7 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
 <tr><td><code>elements</code></td><td><code>repeated</code> <a href="article_%DB%B0_element.html"><code>Element</code></a></td><td><code>Element</code>s required to render the teaser, such as <code>IMAGE</code>, <code>VIDEO</code> or <code>AUTHOR</code></td></tr>
 <tr><td><code>keywords</code></td><td><code>repeated</code> <a href="article_%DB%B0_keyword.html"><code>Keyword</code></a></td><td>Extracted keywords from the article body like persons, locations, organizations etc.</td></tr>
 <tr><td><code>onwards</code></td><td><code>int64</code></td><td>IDs of articles related to this article. Related articles are defined manually in the content management system by the editorial department.</td></tr>
+<tr><td><code>variants</code></td><td><code>repeated</code> [<code>Article</code>][a]</td><td>Variants of this article, e.g. for headline testing.</td></tr>
 <tr><td><code>entities</code></td><td><code>string</code> <code>[deprecated]</code></td><td>Extracted entities from the article body like persons, locations, organizations etc. <code>deprecated</code> — use <code>keywords</code> instead.</td></tr>
 </tbody></table>
 </div>
@@ -209,10 +210,11 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
 repeated Element elements = 8;
 repeated Keyword keywords = 9;
 repeated int64 onwards = 10;
+map&lt;string, Article&gt; variants = 11;
 repeated string entities = 100 [deprecated = true];
 
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L71">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L73">[~]</a></p>
 <h2 id="fields"><a class="header" href="#fields"><code>fields</code></a></h2>
 <p>The entry set is defined by the content management system and
 will vary depending on the main type of the article.</p>
@@ -271,7 +273,7 @@ <h2 id="enum-type"><a class="header" href="#enum-type"><code>enum Type</code></a
 INTERNAL = 100;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L74-L144">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L76-L146">[~]</a></p>
 <h2 id="enum-subtype"><a class="header" href="#enum-subtype"><code>enum SubType</code></a></h2>
 <p>Content with <code>Type.ARTICLE</code> is usually sub typed to alter its form and purpose.</p>
 <div class="table-wrapper"><table><thead><tr><th>Enum value</th><th>Description</th></tr></thead><tbody>
@@ -309,8 +311,8 @@ <h2 id="enum-subtype"><a class="header" href="#enum-subtype"><code>enum SubType<
 RECIPE = 13;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L147-L187">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L190-L191">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L149-L189">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L192-L193">[~]</a></p>
 
                     </main>
 

diff --git a/docs/article_۰_body.html b/docs/article_۰_body.html
@@ -180,7 +180,7 @@ <h1 id="article-۰-body"><a class="header" href="#article-۰-body">Article ۰ Bo
 repeated BodyNode children = 1;
 Type type = 2;
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L634-L654">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L636-L656">[~]</a></p>
 <h2 id="type"><a class="header" href="#type">Type</a></h2>
 <p>Each <code>Body</code> has a <code>Body.Type</code> to help the consumer to correctly interpret
 the  <a href="#bodynode"><code>BodyNode's</code></a> content.</p>
@@ -202,7 +202,7 @@ <h2 id="type"><a class="header" href="#type">Type</a></h2>
 TABLE_OF_CONTENTS = 5;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L657-L681">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L659-L683">[~]</a></p>
 <h2 id="bodynode"><a class="header" href="#bodynode"><code>BodyNode</code></a></h2>
 <p>Recursive structure representing all types of possible nodes inside an article.</p>
 <p>One use-case is to represent <a href="#html-like">HTML-like</a> markup in tapir, but it
@@ -219,7 +219,7 @@ <h2 id="bodynode"><a class="header" href="#bodynode"><code>BodyNode</code></a></
 repeated Element elements = 5;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L684-L705">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L686-L707">[~]</a></p>
 <div class="table-wrapper"><table><thead><tr><th>Field name</th><th>Type</th><th>Description</th></tr></thead><tbody>
 <tr><td><code>type</code></td><td><code>string</code></td><td>Type of the node (required).</td></tr>
 <tr><td><code>text</code></td><td><code>string</code></td><td>Text of the node, only set for text nodes (<code>type == 'text'</code>).</td></tr>
@@ -264,10 +264,10 @@ <h3 id="custom"><a class="header" href="#custom"><em>Custom</em></a></h3>
 <tr><td><code>quote</code></td><td>inline quotation element, check <code>elements</code></td></tr>
 <tr><td><code>infobox</code></td><td>inline box, consists of textual content in <code>children</code> and optional <code>elements</code></td></tr>
 <tr><td><code>pros_and_cons</code></td><td>pros and cons box, consists of <code>elements</code> and structured text in <code>children</code></td></tr>
-<tr><td><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L707-L760">[~]</a></td><td></td></tr>
+<tr><td><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L709-L762">[~]</a></td><td></td></tr>
 </tbody></table>
 </div>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L764-L765">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L766-L767">[~]</a></p>
 
                     </main>
 

diff --git a/docs/article_۰_element.html b/docs/article_۰_element.html
@@ -214,7 +214,7 @@ <h1 id="article-۰-element"><a class="header" href="#article-۰-element">Article
 repeated Element children = 4;
 
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L194-L246">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L196-L248">[~]</a></p>
 <h2 id="elementtype"><a class="header" href="#elementtype"><code>Element.Type</code></a></h2>
 <div class="table-wrapper"><table><thead><tr><th>Enum value</th><th>Description</th></tr></thead><tbody>
 <tr><td><code>TYPE_UNSPECIFIED</code></td><td>unspecified</td></tr>
@@ -243,7 +243,7 @@ <h2 id="elementtype"><a class="header" href="#elementtype"><code>Element.Type</c
 CITATION = 9;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L249-L285">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L251-L287">[~]</a></p>
 <h2 id="elementrelation"><a class="header" href="#elementrelation"><code>Element.Relation</code></a></h2>
 <div class="table-wrapper"><table><thead><tr><th>Enum value</th><th>Description</th></tr></thead><tbody>
 <tr><td><code>RELATION_UNSPECIFIED</code></td><td>unspecified</td></tr>
@@ -259,7 +259,7 @@ <h2 id="elementrelation"><a class="header" href="#elementrelation"><code>Element
 SOCIAL = 3;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L288-L305">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L290-L307">[~]</a></p>
 <h2 id="samples"><a class="header" href="#samples">Samples</a></h2>
 <p>For details on certain <code>fields</code> or usages of <a href="asset.html#samples"><code>Assets</code>, please follow this link.</a></p>
 <h3 id="image-element"><a class="header" href="#image-element"><code>image element</code></a></h3>
@@ -419,8 +419,8 @@ <h3 id="gallery-element"><a class="header" href="#gallery-element"><code>gallery
   ]
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L308-L474">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L477-L478">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L310-L476">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L479-L480">[~]</a></p>
 
                     </main>
 

diff --git a/docs/article_۰_element_۰_asset.html b/docs/article_۰_element_۰_asset.html
@@ -181,7 +181,7 @@ <h1 id="article-۰-element-۰-asset"><a class="header" href="#article-۰-element
 map&lt;string, string&gt; fields = 2;
 Metadata metadata = 3;
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L481-L501">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L483-L503">[~]</a></p>
 <h2 id="enum-type"><a class="header" href="#enum-type"><code>enum Type</code></a></h2>
 <p>Type of an asset.</p>
 <div class="table-wrapper"><table><thead><tr><th>Enum value</th><th>Description</th></tr></thead><tbody>
@@ -203,7 +203,7 @@ <h2 id="enum-type"><a class="header" href="#enum-type"><code>enum Type</code></a
 LINK = 5;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L504-L528">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L506-L530">[~]</a></p>
 <h2 id="samples"><a class="header" href="#samples">Samples</a></h2>
 <h3 id="image-asset"><a class="header" href="#image-asset">Image Asset</a></h3>
 <pre><code class="language-json">{
@@ -287,8 +287,8 @@ <h3 id="video-metadata-asset"><a class="header" href="#video-metadata-asset">Vid
 
 ...
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L532-L626">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L630-L631">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L534-L628">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L632-L633">[~]</a></p>
 
                     </main>
 

diff --git a/docs/article_۰_keyword.html b/docs/article_۰_keyword.html
@@ -180,7 +180,7 @@ <h1 id="article-۰-keyword"><a class="header" href="#article-۰-keyword">Article
 float score = 3;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L876-L891">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L878-L893">[~]</a></p>
 <p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/core_article_service.proto#L3-L4">[~]</a></p>
 
                     </main>

diff --git a/docs/article_۰_metadata.html b/docs/article_۰_metadata.html
@@ -196,7 +196,7 @@ <h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Artic
 int64 publication_id = 11;
 
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L768-L803">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L770-L805">[~]</a></p>
 <h2 id="enum-state"><a class="header" href="#enum-state"><code>enum State</code></a></h2>
 <p>State of the item (<a href="article.html"><code>Article</code></a>, <a href="article.element.html"><code>Element</code></a>)
 in the content management system. The <code>state</code> in combination with
@@ -223,7 +223,7 @@ <h2 id="enum-state"><a class="header" href="#enum-state"><code>enum State</code>
 DRAFT = 3;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L806-L837">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L808-L839">[~]</a></p>
 <h2 id="enum-eventsource"><a class="header" href="#enum-eventsource"><code>enum EventSource</code></a></h2>
 <p>Even more detail about the circumstances of transformation for this article.</p>
 <p>The <code>EventSource</code> will be of type:</p>
@@ -249,8 +249,8 @@ <h2 id="enum-eventsource"><a class="header" href="#enum-eventsource"><code>enum
 CONTENT_ENGINE = 3;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L840-L868">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L872-L873">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L842-L870">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L874-L875">[~]</a></p>
 
                     </main>
 

diff --git a/docs/index.html b/docs/index.html
@@ -194,6 +194,7 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
 <tr><td><code>elements</code></td><td><code>repeated</code> <a href="article_%DB%B0_element.html"><code>Element</code></a></td><td><code>Element</code>s required to render the teaser, such as <code>IMAGE</code>, <code>VIDEO</code> or <code>AUTHOR</code></td></tr>
 <tr><td><code>keywords</code></td><td><code>repeated</code> <a href="article_%DB%B0_keyword.html"><code>Keyword</code></a></td><td>Extracted keywords from the article body like persons, locations, organizations etc.</td></tr>
 <tr><td><code>onwards</code></td><td><code>int64</code></td><td>IDs of articles related to this article. Related articles are defined manually in the content management system by the editorial department.</td></tr>
+<tr><td><code>variants</code></td><td><code>repeated</code> [<code>Article</code>][a]</td><td>Variants of this article, e.g. for headline testing.</td></tr>
 <tr><td><code>entities</code></td><td><code>string</code> <code>[deprecated]</code></td><td>Extracted entities from the article body like persons, locations, organizations etc. <code>deprecated</code> — use <code>keywords</code> instead.</td></tr>
 </tbody></table>
 </div>
@@ -209,10 +210,11 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
 repeated Element elements = 8;
 repeated Keyword keywords = 9;
 repeated int64 onwards = 10;
+map&lt;string, Article&gt; variants = 11;
 repeated string entities = 100 [deprecated = true];
 
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L71">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L73">[~]</a></p>
 <h2 id="fields"><a class="header" href="#fields"><code>fields</code></a></h2>
 <p>The entry set is defined by the content management system and
 will vary depending on the main type of the article.</p>
@@ -271,7 +273,7 @@ <h2 id="enum-type"><a class="header" href="#enum-type"><code>enum Type</code></a
 INTERNAL = 100;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L74-L144">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L76-L146">[~]</a></p>
 <h2 id="enum-subtype"><a class="header" href="#enum-subtype"><code>enum SubType</code></a></h2>
 <p>Content with <code>Type.ARTICLE</code> is usually sub typed to alter its form and purpose.</p>
 <div class="table-wrapper"><table><thead><tr><th>Enum value</th><th>Description</th></tr></thead><tbody>
@@ -309,8 +311,8 @@ <h2 id="enum-subtype"><a class="header" href="#enum-subtype"><code>enum SubType<
 RECIPE = 13;
 }
 </code></pre>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L147-L187">[~]</a></p>
-<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L190-L191">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L149-L189">[~]</a></p>
+<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L192-L193">[~]</a></p>
 
                     </main>