diff --git a/docs/author.html b/docs/author.html index 8ee74808..1397d392 100644 --- a/docs/author.html +++ b/docs/author.html @@ -175,7 +175,7 @@

Author

This represents an author (or agency). The entity may be the main content on author pages or simply indicate the author of an Article.

- + @@ -186,7 +186,7 @@

Author

Field nameTypeDescription
idstringThe unique identifier (cms id) of the author.
idint64The unique identifier (cms id) of the author.
typeAuthor.TypeThe type of the author entity.
fieldsmap[string, string]The fields of the author. This is a map of key-value pairs. The keys are the field names and the values are the field values.
elementsArticle.Element[]The elements of the author, e.g. the author's profile picture.
message Author {
-string id = 1;
+int64 id = 1;
 Type type = 2;
 map<string, string> fields = 3; // migrate from Asset[type=metadata]
 repeated Article.Element elements = 4; // profile picture
@@ -227,7 +227,7 @@ 
HistoryEntry<
 
[~]

 
Sample Author

 
{
-  "id": "100000001",
+  "id": 100000001,
   "type": "AUTHOR",
   "fields": {
     "flag:hidden": "true",
diff --git a/docs/print.html b/docs/print.html
index 05d16ac9..ebf2f421 100644
--- a/docs/print.html
+++ b/docs/print.html
@@ -906,7 +906,7 @@ 
enum
 
This represents an author (or agency). The entity may be the main content
 on author pages or simply indicate the author of an Article.

 

-
+
@@ -917,7 +917,7 @@ 
enum
 
Field nameTypeDescription
idstringThe unique identifier (cms id) of the author.
idint64The unique identifier (cms id) of the author.

 
typeAuthor.TypeThe type of the author entity.

 
fieldsmap[string, string]The fields of the author. This is a map of key-value pairs. The keys are the field names and the values are the field values.

 
elementsArticle.Element[]The elements of the author, e.g. the author's profile picture.

 

 
message Author {
-string id = 1;
+int64 id = 1;
 Type type = 2;
 map<string, string> fields = 3; // migrate from Asset[type=metadata]
 repeated Article.Element elements = 4; // profile picture
@@ -958,7 +958,7 @@ 
HistoryEntry<
 
[~]

 
Sample Author

 
{
-  "id": "100000001",
+  "id": 100000001,
   "type": "AUTHOR",
   "fields": {
     "flag:hidden": "true",
diff --git a/docs/searchindex.js b/docs/searchindex.js
index d5830f23..af243bc2 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Object.assign(window.search, {"doc_urls":["article.html#article","article.html#teaser","article.html#fields","article.html#for-articletypearticle","article.html#for-articletypegallery","article.html#enum-type","article.html#enum-subtype","article_۰_body.html#article-۰-body","article_۰_body.html#type","article_۰_body.html#bodynode","article_۰_body.html#fields","article_۰_body.html#custom","article_۰_element.html#article-۰-element","article_۰_element.html#elementtype","article_۰_element.html#elementrelation","article_۰_element.html#samples","article_۰_element.html#image-element","article_۰_element.html#video-element","article_۰_element.html#gallery-element","article_۰_element_۰_asset.html#article-۰-element-۰-asset","article_۰_element_۰_asset.html#enum-type","article_۰_element_۰_asset.html#samples","article_۰_element_۰_asset.html#image-asset","article_۰_element_۰_asset.html#video-asset","article_۰_element_۰_asset.html#video-metadata-asset","article_۰_keyword.html#article-۰-keyword","article_۰_metadata.html#article-۰-metadata","article_۰_metadata.html#enum-state","article_۰_metadata.html#enum-eventsource","author.html#author","author.html#enum-type","author.html#historyentry","author.html#sample-author","reference.html#reference","reference.html#type","reference.html#fields","reference.html#samples","stage.html#stage","⚙︎_articlepageservice.html#-articlepageservice","⚙︎_articlepageservice.html#description","⚙︎_articlepageservice.html#request-message-to-get-an-article-page","⚙︎_articlepageservice.html#response-message-for-an-article-page-request","⚙︎_articlepageservice.html#statuserror-scenarios","⚙︎_articlepageservice.html#scenario-found","⚙︎_articlepageservice.html#scenario-invalid-id","⚙︎_articlepageservice.html#scenario-not-found","⚙︎_articlepageservice.html#scenario-not-yet-valid","⚙︎_articlepageservice.html#scenario-not-published","⚙︎_articlepageservice.html#scenario-expired","⚙︎_articlepageservice.html#scenario-deletedarchived","⚙︎_articlepageservice.html#scenario-internal","⚙︎_articlepageservice.html#scenario-timeout","⚙︎_corearticleservice.html#-corearticleservice","⚙︎_corearticleservice.html#-getarticle","⚙︎_corearticleservice.html#-batchgetarticle","⚙︎_corearticleservice.html#batchgetarticlesresponse","⚙︎_corearticleservice.html#listarticlesrequest","⚙︎_corearticleservice.html#query","⚙︎_corearticleservice.html#type","⚙︎_corearticleservice.html#sortby","⚙︎_corearticleservice.html#order","⚙︎_corearticleservice.html#filters","⚙︎_corearticleservice.html#listarticlesresponse","⚙︎_corearticleservice.html#-listsections","⚙︎_corearticleservice.html#listsectionsresponse","⚙︎_curationservice.html#-curationservice","⚙︎_curationservice.html#-getcuration","⚙︎_curationservice.html#getcurationrequest","⚙︎_curationservice.html#getcurationresponse","⚙︎_curationservice.html#-batchgetcuration","⚙︎_curationservice.html#batchgetcurationrequest","⚙︎_curationservice.html#batchgetcurationresponse","⚙︎_sectionpageservice.html#-sectionpageservice","⚙︎_sectionpageservice.html#statuserror-scenarios","⚙︎_sectionpageservice.html#scenario-found","⚙︎_sectionpageservice.html#scenario-section-path-is-empty","⚙︎_sectionpageservice.html#scenario-section-path-is-invalid","⚙︎_sectionpageservice.html#scenario-section-path-is-unknown","⚙︎_sectionpageservice.html#scenario-partial-section-data","⚙︎_sectionpageservice.html#scenario-internal","⚙︎_sectionpageservice.html#scenario-timeout","⚙︎_stageservice.html#-stageservice","⚙︎_stageservice.html#description","⚙︎_stageservice.html#statuserror-scenarios"],"index":{"documentStore":{"docInfo":{"0":{"body":29,"breadcrumbs":2,"title":1},"1":{"body":230,"breadcrumbs":2,"title":1},"10":{"body":87,"breadcrumbs":3,"title":1},"11":{"body":58,"breadcrumbs":3,"title":1},"12":{"body":153,"breadcrumbs":4,"title":2},"13":{"body":96,"breadcrumbs":3,"title":1},"14":{"body":35,"breadcrumbs":3,"title":1},"15":{"body":8,"breadcrumbs":3,"title":1},"16":{"body":162,"breadcrumbs":4,"title":2},"17":{"body":108,"breadcrumbs":4,"title":2},"18":{"body":110,"breadcrumbs":4,"title":2},"19":{"body":61,"breadcrumbs":6,"title":3},"2":{"body":16,"breadcrumbs":2,"title":1},"20":{"body":80,"breadcrumbs":5,"title":2},"21":{"body":0,"breadcrumbs":4,"title":1},"22":{"body":101,"breadcrumbs":5,"title":2},"23":{"body":52,"breadcrumbs":5,"title":2},"24":{"body":88,"breadcrumbs":6,"title":3},"25":{"body":42,"breadcrumbs":4,"title":2},"26":{"body":216,"breadcrumbs":4,"title":2},"27":{"body":81,"breadcrumbs":4,"title":2},"28":{"body":79,"breadcrumbs":4,"title":2},"29":{"body":110,"breadcrumbs":2,"title":1},"3":{"body":70,"breadcrumbs":2,"title":1},"30":{"body":20,"breadcrumbs":3,"title":2},"31":{"body":28,"breadcrumbs":2,"title":1},"32":{"body":100,"breadcrumbs":3,"title":2},"33":{"body":90,"breadcrumbs":2,"title":1},"34":{"body":9,"breadcrumbs":2,"title":1},"35":{"body":10,"breadcrumbs":2,"title":1},"36":{"body":10,"breadcrumbs":2,"title":1},"37":{"body":29,"breadcrumbs":2,"title":1},"38":{"body":17,"breadcrumbs":2,"title":1},"39":{"body":0,"breadcrumbs":2,"title":1},"4":{"body":10,"breadcrumbs":2,"title":1},"40":{"body":12,"breadcrumbs":5,"title":4},"41":{"body":27,"breadcrumbs":6,"title":5},"42":{"body":0,"breadcrumbs":3,"title":2},"43":{"body":23,"breadcrumbs":3,"title":2},"44":{"body":19,"breadcrumbs":4,"title":3},"45":{"body":18,"breadcrumbs":3,"title":2},"46":{"body":28,"breadcrumbs":3,"title":2},"47":{"body":29,"breadcrumbs":3,"title":2},"48":{"body":28,"breadcrumbs":3,"title":2},"49":{"body":28,"breadcrumbs":3,"title":2},"5":{"body":84,"breadcrumbs":3,"title":2},"50":{"body":20,"breadcrumbs":3,"title":2},"51":{"body":19,"breadcrumbs":3,"title":2},"52":{"body":52,"breadcrumbs":2,"title":1},"53":{"body":32,"breadcrumbs":2,"title":1},"54":{"body":41,"breadcrumbs":2,"title":1},"55":{"body":32,"breadcrumbs":2,"title":1},"56":{"body":83,"breadcrumbs":2,"title":1},"57":{"body":131,"breadcrumbs":2,"title":1},"58":{"body":43,"breadcrumbs":2,"title":1},"59":{"body":21,"breadcrumbs":2,"title":1},"6":{"body":82,"breadcrumbs":3,"title":2},"60":{"body":28,"breadcrumbs":2,"title":1},"61":{"body":85,"breadcrumbs":2,"title":1},"62":{"body":34,"breadcrumbs":2,"title":1},"63":{"body":4,"breadcrumbs":2,"title":1},"64":{"body":12,"breadcrumbs":2,"title":1},"65":{"body":26,"breadcrumbs":2,"title":1},"66":{"body":21,"breadcrumbs":2,"title":1},"67":{"body":15,"breadcrumbs":2,"title":1},"68":{"body":44,"breadcrumbs":2,"title":1},"69":{"body":22,"breadcrumbs":2,"title":1},"7":{"body":61,"breadcrumbs":4,"title":2},"70":{"body":16,"breadcrumbs":2,"title":1},"71":{"body":19,"breadcrumbs":2,"title":1},"72":{"body":112,"breadcrumbs":2,"title":1},"73":{"body":0,"breadcrumbs":3,"title":2},"74":{"body":19,"breadcrumbs":3,"title":2},"75":{"body":20,"breadcrumbs":5,"title":4},"76":{"body":21,"breadcrumbs":5,"title":4},"77":{"body":20,"breadcrumbs":5,"title":4},"78":{"body":25,"breadcrumbs":5,"title":4},"79":{"body":20,"breadcrumbs":3,"title":2},"8":{"body":81,"breadcrumbs":3,"title":1},"80":{"body":35,"breadcrumbs":3,"title":2},"81":{"body":0,"breadcrumbs":2,"title":1},"82":{"body":10,"breadcrumbs":2,"title":1},"83":{"body":55,"breadcrumbs":3,"title":2},"9":{"body":113,"breadcrumbs":3,"title":1}},"docs":{"0":{"body":"An article represents a piece of content created in the content management system. Different types of content like text or video articles share the same message structure, they can be distinguished by the Article.Type field. Text articles (type = Article.Type.ARTICLE) also have Article.SubType to differentiate its purpose and form.","breadcrumbs":"Article » Article","id":"0","title":"Article"},"1":{"body":"To improve performance of database access and during network transmission tapir is using a lightweight representation of Article in some places. Depending on the service used to retrieve an article, the Article message might only contain data required on section pages: Article.body set to null Article.elements filtered by Element.relations to only contain TEASER, but neither OPENER nor SOCIAL Thus, not containing any data that is only required on detail pages. This lightweight representation is sometimes referred to as Teaser. Field name Type Description id int64 Unique ID of the article defined by the content management system (required). type Type Main content type of the article (required). See list of supported [ContentType][ct] sub_type SubType Subtype of the article. For ARTICLE this field holds a sub_type, for others like GALLERY it may not. section_tree Reference Hierarchical section tree information of the article (required). fields map Generic map containing general content and configuration information of the article (required). See fields bodies repeated Body Recursive textual body of the article to be rendered on detail pages. May be null for Teaser . elements repeated Element Elements required to render the teaser, such as IMAGE, VIDEO or AUTHOR keywords repeated Keyword Extracted keywords from the article body like persons, locations, organizations etc. onwards int64 IDs of articles related to this article. Related articles are defined manually in the content management system by the editorial department. variants repeated [Article][a] Variants of this article, e.g. for headline testing. entities string [deprecated] Extracted entities from the article body like persons, locations, organizations etc. deprecated — use keywords instead. authors repeated Author Authors and message Article {\nint64 id = 1;\nType type = 2;\nSubType sub_type = 3;\nstroeer.core.v1.Reference section_tree = 4;\nmap fields = 5;\nrepeated Body bodies = 6;\nMetadata metadata = 7;\nrepeated Element elements = 8;\nrepeated Keyword keywords = 9;\nrepeated int64 onwards = 10;\nmap variants = 11;\nrepeated Author authors = 12;\nrepeated string entities = 100 [deprecated = true]; [~]","breadcrumbs":"Article » Teaser","id":"1","title":"Teaser"},"10":{"body":"HTML like type description text most basic type, its text value can be found in the text field. The word_count can be found in the BodyNode.fields for each BodyNode[type=text] p paragraph / 
 span  sub_headline a sub headline, may be part of the table of contents a anchor /  strong strong /  em emphasis /  sub subscript / sub sup superscript / sup hr horizontal rule / 
 br line break / 
 ul unordered list /