Skip to content

Commit

Permalink
docs released for new tag: v0.47.0
Browse files Browse the repository at this point in the history
  • Loading branch information
thisismana committed Mar 25, 2024
1 parent afc3af7 commit 638c16a
Show file tree
Hide file tree
Showing 6 changed files with 26 additions and 22 deletions.
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#L887-L902">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L906-L907">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L889-L904">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L908-L909">[~]</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 @@ -186,6 +186,7 @@ <h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Artic
<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>
<tr><td><code>tenant</code></td><td><code>string</code></td><td>The tenant this article belongs to. e.g. <code>www</code>, <code>berlin</code> or such</td></tr>
</tbody></table>
</div>
<pre><code class="language-protobuf/">message Metadata {
Expand All @@ -201,9 +202,10 @@ <h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Artic
double seo_score = 10;
int64 publication_id = 11;
string related_article_source = 12;
string tenant = 13;

</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L777-L814">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L777-L816">[~]</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 @@ -230,7 +232,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#L817-L848">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L819-L850">[~]</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 @@ -256,8 +258,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#L851-L879">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L883-L884">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L853-L881">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L885-L886">[~]</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#L910-L936">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L912-L938">[~]</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#L938-L954">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L940-L956">[~]</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#L956-L973">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L958-L975">[~]</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#L975-L1047">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L977-L1049">[~]</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
22 changes: 12 additions & 10 deletions docs/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -818,8 +818,8 @@ <h3 id="video-metadata-asset"><a class="header" href="#video-metadata-asset">Vid
float score = 3;
}
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L887-L902">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L906-L907">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L889-L904">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L908-L909">[~]</a></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="article-۰-metadata"><a class="header" href="#article-۰-metadata">Article ۰ Metadata</a></h1>
<p>Article metadata like publication state and technical timestamps.</p>
<div class="table-wrapper"><table><thead><tr><th>Field name</th><th>Type</th><th>Description</th></tr></thead><tbody>
Expand All @@ -835,6 +835,7 @@ <h3 id="video-metadata-asset"><a class="header" href="#video-metadata-asset">Vid
<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>
<tr><td><code>tenant</code></td><td><code>string</code></td><td>The tenant this article belongs to. e.g. <code>www</code>, <code>berlin</code> or such</td></tr>
</tbody></table>
</div>
<pre><code class="language-protobuf/">message Metadata {
Expand All @@ -850,9 +851,10 @@ <h3 id="video-metadata-asset"><a class="header" href="#video-metadata-asset">Vid
double seo_score = 10;
int64 publication_id = 11;
string related_article_source = 12;
string tenant = 13;

</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L777-L814">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L777-L816">[~]</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 @@ -879,7 +881,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#L817-L848">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L819-L850">[~]</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 @@ -905,8 +907,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#L851-L879">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L883-L884">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L853-L881">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L885-L886">[~]</a></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="author"><a class="header" href="#author">Author</a></h1>
<p>This represents an author (or agency). The entity may be the main content
on author pages or simply indicate the author of an <a href="article.html">Article</a>.</p>
Expand All @@ -932,7 +934,7 @@ <h2 id="enum-eventsource"><a class="header" href="#enum-eventsource"><code>enum
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#L910-L936">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L912-L938">[~]</a></p>
<h2 id="enum-type-2"><a class="header" href="#enum-type-2"><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 @@ -946,7 +948,7 @@ <h2 id="enum-type-2"><a class="header" href="#enum-type-2"><code>enum Type</code
AGENCY = 2;
}
</code></pre>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L938-L954">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L940-L956">[~]</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 @@ -960,7 +962,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#L956-L973">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L958-L975">[~]</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 @@ -1032,7 +1034,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#L975-L1047">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/article.proto#L977-L1049">[~]</a></p>
<p><a href="https://github.com/stroeer/tapir/blob/main/stroeer/core/v1/core_article_service.proto#L3-L4">[~]</a></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="reference"><a class="header" href="#reference">Reference</a></h1>
<p>A Reference represents a link to another entity, for example an <code>Article</code>,
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json

Large diffs are not rendered by default.

0 comments on commit 638c16a

Please sign in to comment.