Skip to content

Commit

Permalink
docs released for new tag: v0.43.0
Browse files Browse the repository at this point in the history
  • Loading branch information
harryherbig committed Dec 19, 2023
1 parent b74b710 commit 99c1c1b
Show file tree
Hide file tree
Showing 11 changed files with 75 additions and 65 deletions.
12 changes: 7 additions & 5 deletions docs/article.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
<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>
<tr><td><code>authors</code></td><td><code>repeated</code> <a href="author.html"><code>Author</code></a></td><td>Authors and</td></tr>
<tr><td><code>related_articles</code></td><td><code>repeated</code> [<code>RelatedArticle</code>][related_articles]</td><td>Editorial articles, which are related to the main article. Can only be an article shell with id and source in the core api.</td></tr>
</tbody></table>
</div>
<pre><code class="language-protobuf*/">
Expand All @@ -215,13 +216,14 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
Metadata metadata = 7;
repeated Element elements = 8;
repeated Keyword keywords = 9;
repeated int64 onwards = 10;
repeated int64 onwards = 10 [deprecated = true];
map&lt;string, Article&gt; variants = 11;
repeated Author authors = 12;
repeated Article related_articles = 13;
repeated string entities = 100 [deprecated = true];

</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L76">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L78">[~]</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>
Expand Down Expand Up @@ -280,7 +282,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#L79-L149">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L81-L151">[~]</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>
Expand Down Expand Up @@ -318,8 +320,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#L152-L192">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L195-L196">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L154-L194">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L197-L198">[~]</a></p>

</main>

Expand Down
10 changes: 5 additions & 5 deletions docs/article_۰_body.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,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#L639-L659">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L641-L661">[~]</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>
Expand All @@ -207,7 +207,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#L662-L686">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L664-L688">[~]</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
Expand All @@ -224,7 +224,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#L689-L710">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L691-L712">[~]</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>
Expand Down Expand Up @@ -269,10 +269,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#L712-L765">[~]</a></td><td></td></tr>
<tr><td><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L714-L767">[~]</a></td><td></td></tr>
</tbody></table>
</div>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L769-L770">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L771-L772">[~]</a></p>

</main>

Expand Down
10 changes: 5 additions & 5 deletions docs/article_۰_element.html
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,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#L199-L251">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L201-L253">[~]</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>
Expand Down Expand Up @@ -248,7 +248,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#L254-L290">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L256-L292">[~]</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>
Expand All @@ -264,7 +264,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#L293-L310">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L295-L312">[~]</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>
Expand Down Expand Up @@ -424,8 +424,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#L313-L479">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L482-L483">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L315-L481">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L484-L485">[~]</a></p>

</main>

Expand Down
8 changes: 4 additions & 4 deletions docs/article_۰_element_۰_asset.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,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#L486-L506">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L488-L508">[~]</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>
Expand All @@ -208,7 +208,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#L509-L533">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L511-L535">[~]</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">{
Expand Down Expand Up @@ -292,8 +292,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#L537-L631">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L635-L636">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L539-L633">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L637-L638">[~]</a></p>

</main>

Expand Down
4 changes: 2 additions & 2 deletions docs/article_۰_keyword.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,8 +185,8 @@ <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#L881-L896">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L900-L901">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L885-L900">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L904-L905">[~]</a></p>

</main>

Expand Down
10 changes: 6 additions & 4 deletions docs/article_۰_metadata.html
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ <h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Artic
<tr><td><code>event_source</code></td><td><a href="#enum-eventsource"><code>EventSource</code></a></td><td>Source of the event that caused this item to be transformed and to be written into the DB.</td></tr>
<tr><td><code>seo_score</code></td><td><code>double</code></td><td>The <code>article score</code> (originates from team data's <em>Content Engine</em>, higher scores are better)</td></tr>
<tr><td><code>publication_id</code></td><td><code>int64</code></td><td>The unique <code>publication_id</code> provided by the CMS, can be used to correlate the state of documents in tapir with the corresponding CMS publication event.</td></tr>
<tr><td><code>related_article_source</code></td><td><code>string</code></td><td>Source of this article, if embedded in another article as a related article.</td></tr>
</tbody></table>
</div>
<pre><code class="language-protobuf/">message Metadata {
Expand All @@ -199,9 +200,10 @@ <h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Artic
EventSource event_source = 9;
double seo_score = 10;
int64 publication_id = 11;
string related_article_source = 12;

</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L773-L808">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L775-L812">[~]</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
Expand All @@ -228,7 +230,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#L811-L842">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L815-L846">[~]</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>
Expand All @@ -254,8 +256,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#L845-L873">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L877-L878">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L849-L877">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L881-L882">[~]</a></p>

</main>

Expand Down
8 changes: 4 additions & 4 deletions docs/author.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ <h1 id="author"><a class="header" href="#author">Author</a></h1>
repeated Reference social_profiles = 7;
repeated string areas_of_expertise = 8;
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L904-L930">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L908-L934">[~]</a></p>
<h2 id="enum-type"><a class="header" href="#enum-type"><code>enum 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>
Expand All @@ -210,7 +210,7 @@ <h2 id="enum-type"><a class="header" href="#enum-type"><code>enum Type</code></a
AGENCY = 2;
}
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L932-L948">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L936-L952">[~]</a></p>
<h2 id="historyentry"><a class="header" href="#historyentry"><code>HistoryEntry</code></a></h2>
<p>Lists previous jobs and details about the author's career.</p>
<div class="table-wrapper"><table><thead><tr><th>Field name</th><th>Type</th><th>Description</th></tr></thead><tbody>
Expand All @@ -224,7 +224,7 @@ <h2 id="historyentry"><a class="header" href="#historyentry"><code>HistoryEntry<
string description = 2;
}
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L950-L967">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L954-L971">[~]</a></p>
<h2 id="sample-author"><a class="header" href="#sample-author">Sample Author</a></h2>
<pre><code class="language-json">{
&quot;id&quot;: 100000001,
Expand Down Expand Up @@ -296,7 +296,7 @@ <h2 id="sample-author"><a class="header" href="#sample-author">Sample Author</a>
]
}
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L969-L1041">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L973-L1045">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/core_article_service.proto#L3-L4">[~]</a></p>

</main>
Expand Down
12 changes: 7 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
<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>
<tr><td><code>authors</code></td><td><code>repeated</code> <a href="author.html"><code>Author</code></a></td><td>Authors and</td></tr>
<tr><td><code>related_articles</code></td><td><code>repeated</code> [<code>RelatedArticle</code>][related_articles]</td><td>Editorial articles, which are related to the main article. Can only be an article shell with id and source in the core api.</td></tr>
</tbody></table>
</div>
<pre><code class="language-protobuf*/">
Expand All @@ -215,13 +216,14 @@ <h2 id="teaser"><a class="header" href="#teaser">Teaser</a></h2>
Metadata metadata = 7;
repeated Element elements = 8;
repeated Keyword keywords = 9;
repeated int64 onwards = 10;
repeated int64 onwards = 10 [deprecated = true];
map&lt;string, Article&gt; variants = 11;
repeated Author authors = 12;
repeated Article related_articles = 13;
repeated string entities = 100 [deprecated = true];

</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L76">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L14-L78">[~]</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>
Expand Down Expand Up @@ -280,7 +282,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#L79-L149">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L81-L151">[~]</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>
Expand Down Expand Up @@ -318,8 +320,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#L152-L192">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L195-L196">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L154-L194">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L197-L198">[~]</a></p>

</main>

Expand Down
Loading

0 comments on commit 99c1c1b

Please sign in to comment.