From f77be63a322e8fb5faaa78688fb3d89e52c4b477 Mon Sep 17 00:00:00 2001 From: Harry Herbig Date: Fri, 13 Dec 2024 16:31:12 +0100 Subject: [PATCH] docs released for new tag: v0.52.0 --- docs/404.html | 2 +- docs/article.html | 2 +- "docs/article_\333\260_body.html" | 2 +- "docs/article_\333\260_element.html" | 2 +- ...icle_\333\260_element_\333\260_asset.html" | 2 +- "docs/article_\333\260_keyword.html" | 2 +- "docs/article_\333\260_metadata.html" | 2 +- docs/author.html | 2 +- docs/index.html | 2 +- docs/print.html | 242 +------------ docs/reference.html | 6 +- docs/searchindex.js | 2 +- docs/searchindex.json | 2 +- ...1\357\270\216_articleextenderservice.html" | 23 +- ...2\231\357\270\216_articlepageservice.html" | 336 ------------------ ...2\231\357\270\216_corearticleservice.html" | 6 +- ...\232\231\357\270\216_curationservice.html" | 6 +- ...2\231\357\270\216_sectionpageservice.html" | 335 ----------------- ...342\232\231\357\270\216_stageservice.html" | 8 +- 19 files changed, 45 insertions(+), 939 deletions(-) rename docs/stage.html => "docs/\342\232\231\357\270\216_articleextenderservice.html" (88%) delete mode 100644 "docs/\342\232\231\357\270\216_articlepageservice.html" delete mode 100644 "docs/\342\232\231\357\270\216_sectionpageservice.html" diff --git a/docs/404.html b/docs/404.html index 88b2fa13..dfad9ed8 100644 --- a/docs/404.html +++ b/docs/404.html @@ -89,7 +89,7 @@ diff --git a/docs/article.html b/docs/article.html index 2ed52d2c..a54875a2 100644 --- a/docs/article.html +++ b/docs/article.html @@ -88,7 +88,7 @@ diff --git "a/docs/article_\333\260_body.html" "b/docs/article_\333\260_body.html" index 68ecb98a..c39f528b 100644 --- "a/docs/article_\333\260_body.html" +++ "b/docs/article_\333\260_body.html" @@ -88,7 +88,7 @@ diff --git "a/docs/article_\333\260_element.html" "b/docs/article_\333\260_element.html" index c6363a11..8b53e30c 100644 --- "a/docs/article_\333\260_element.html" +++ "b/docs/article_\333\260_element.html" @@ -88,7 +88,7 @@ diff --git "a/docs/article_\333\260_element_\333\260_asset.html" "b/docs/article_\333\260_element_\333\260_asset.html" index 947aa9a4..da13b5a5 100644 --- "a/docs/article_\333\260_element_\333\260_asset.html" +++ "b/docs/article_\333\260_element_\333\260_asset.html" @@ -88,7 +88,7 @@ diff --git "a/docs/article_\333\260_keyword.html" "b/docs/article_\333\260_keyword.html" index c218904f..a0677a36 100644 --- "a/docs/article_\333\260_keyword.html" +++ "b/docs/article_\333\260_keyword.html" @@ -88,7 +88,7 @@ diff --git "a/docs/article_\333\260_metadata.html" "b/docs/article_\333\260_metadata.html" index 5fb6fe21..bc0a2592 100644 --- "a/docs/article_\333\260_metadata.html" +++ "b/docs/article_\333\260_metadata.html" @@ -88,7 +88,7 @@ diff --git a/docs/author.html b/docs/author.html index cd147a13..1276ab2f 100644 --- a/docs/author.html +++ b/docs/author.html @@ -88,7 +88,7 @@ diff --git a/docs/index.html b/docs/index.html index 2ed52d2c..a54875a2 100644 --- a/docs/index.html +++ b/docs/index.html @@ -88,7 +88,7 @@ diff --git a/docs/print.html b/docs/print.html index eb604481..33298644 100644 --- a/docs/print.html +++ b/docs/print.html @@ -89,7 +89,7 @@ @@ -1104,126 +1104,14 @@

Samples<

[~]

[~]

-

Stage

-

A stream stage with companions and the main content area. -Embedded items can be editorial articles, advertisement and/or stages (only one level deep).

-
message Stage {
-  Configuration configuration = 1;
-  repeated Item stream_items = 2;
-  repeated Item companion_items = 3;
-
-

[~]

-

⚙︎ ArticlePageService

-
service ArticlePageService {
-  # turns the requested article with editorial render relevant data for the user and SEO bots.
-  rpc GetArticlePage (GetArticlePageRequest) returns (GetArticlePageResponse) {}
-}
-
-

Description

-

[~]

-

Request message to get an article page.

-
message GetArticlePageRequest {
-  # ID of the article defined by the content management system (required).
-  int64 id = 1;
-}
-
-

[~]

-

Response message for an article page request.

-

Status codes:

- -
message GetArticlePageResponse {
- # Article page with all render relevant data for the user and SEO bots.
- stroeer.page.article.v1.ArticlePage article_page = 1;
+
⚙︎ ArticleExtenderService

+
The ArticleExtenderService provides methods to extend an article with additional information.
+The main purpose is to retrieve questions for a given article to be rendered in the ArticleExtender Widget on ArticlePages.

+
service ArticleExtenderService {
+rpc GetQuestions(GetQuestionsRequest) returns (GetQuestionsResponse) {}
 }
 

-
[~]

-
Status/Error scenario's

-
scenario found

-

-
-
-
-
-
-
descriptionarticle was found in the datastore and is published and valid according to it's metadata
gRPC statusOK (0)
gRPC error payloadnone
HTTP status200 (OK)
cacheableyes

-

-
scenario invalid id

-

-
-
-
-
-
-
descriptionarticle id is invalid
gRPC statusINVALID_ARGUMENT (3)
gRPC error payloadgoogle.rpc.Bad
HTTP status400 (BAD REQUEST)
cacheableyes

-

-
scenario not found

-

-
-
-
-
-
-
descriptionarticle was not found in the datastore
gRPC statusNOT_FOUND (5)
gRPC error payloadnone
HTTP status404 (NOT FOUND)
cacheableyes

-

-
scenario not yet valid

-

-
-
-
-
-
-
descriptionarticle was found in the datastore, but is not valid yet according to its metadata.start_time
gRPC statusNOT_FOUND (5)
gRPC error payloadgoogle.rpc.ResourceInfo, check description field for recommended http status code
HTTP status404 (NOT FOUND)
cacheableyes

-

-
scenario not published

-

-
-
-
-
-
-
descriptionarticle was found in the datastore, but it's state is neither State.DELETED nor State.PUBLISHED
gRPC statusNOT_FOUND (5)
gRPC error payloadgoogle.rpc.ResourceInfo, check description field for recommended http status code
HTTP status404 (NOT FOUND)
cacheableyes

-

-
scenario expired

-

-
-
-
-
-
-
descriptionarticle was found in the datastore, but is expired according to metadata.end_time
gRPC statusNOT_FOUND (5)
gRPC error payloadgoogle.rpc.ResourceInfo, check description field for recommended http status code
HTTP status410 (GONE)
cacheableyes

-

-
scenario deleted/archived

-

-
-
-
-
-
-
descriptionarticle was found in the datastore, but it's state is State.DELETED
gRPC statusNOT_FOUND (5)
gRPC error payloadgoogle.rpc.ResourceInfo, check description field for recommended http status code
HTTP status410 (GONE)
cacheableyes

-

-
scenario internal

-

-
-
-
-
-
-
descriptioninternal error processing the article
gRPC statusINTERNAL (13)
gRPC error payloadnone
HTTP status500 (INTERNAL SERVER ERROR)
cacheableno

-

-
scenario timeout

-

-
-
-
-
-
-
-
descriptiontimeout loading and processing the article
gRPC statusDEADLINE_EXCEEDED (4)
gRPC error payloadnone
HTTP status504 (GATEWAY TIMEOUT)
cacheableno
[~]

-

-
[~]

+
[~]

 
⚙︎ CoreArticleService

 
Core service to either query a single article (rpc GetArticle()) identified
 by its id or to query multiple articles (rpc ListArticles()) by providing
@@ -1532,123 +1420,13 @@ 
[~]

 
[~]

-
⚙︎ SectionPageService

-
Message to provide parameters when requesting data for a section page, currently only the path of the page.
-Correct paths have a leading and a trailing slash, like /nachrichten/unterhaltung/
-The homepage has the path /.

-
message GetSectionPageRequest {
-  // valid section_path, with leading and trailing slash
-  string section_path = 1;
-
-  // use to page through sections. If unspecified, it will default to `1`.
-  // Paging is 1-based (1 is the first page, there is no page `0`)
-  //
-  // Due to underlying mechanisms and seo requirements, page-size is fixed at 30
-  // The service may return fewer than this value.
-  int32 page = 2;
-}
-

-
[~]

-
Response message when requesting data for a section page.
-Responds with NOT_FOUND if an unknown path is requested, or the path is incorrect.

-
message GetSectionPageResponse {
-stroeer.page.section.v1.SectionPage section_page = 1;
-
- // Total number of pages in this `section_path`
-int32 total_pages = 2;
-
-PaginationType pagination_type = 3;
-
- enum PaginationType {
-   // Not specified.
-   PAGINATION_TYPE_UNSPECIFIED = 0;
-
-   // The default pagination type.
-   FIXED_BLOCK = 1;
-
-   // Pagination type for Evergreen-Ressorts.
-   GHOST_BLOCK = 2;
- }
-}
-

-
[~]

-
Service to fetch all data needed to render a section page, like the homepage or "/politik/"
-[~]

-
Status/Error scenario's

-
scenario: found

-

-
-
-
-
-
-
descriptionall data for the section page was found
gRPC statusOK (0)
gRPC error payloadnone
HTTP status200 (OK)
cacheableyes

-

-
scenario: section path is empty

-

-
-
-
-
-
-
descriptionclient did not provide a section path
gRPC statusINVALID_ARGUMENT (3)
gRPC error payloadgoogle.rpc.Bad
HTTP status400 (BAD REQUEST)
cacheableyes

-

-
scenario: section path is invalid

-

-
-
-
-
-
-
descriptionclient provided an invalid section path
gRPC statusINVALID_ARGUMENT (3)
gRPC error payloadgoogle.rpc.Bad
HTTP status400 (BAD REQUEST)
cacheableyes

-

-
scenario: section path is unknown

-

-
-
-
-
-
-
descriptionclient provided an unknown section path
gRPC statusNOT_FOUND (5)
gRPC error payloadnone
HTTP status404 (NOT FOUND)
cacheableyes

-

-
scenario partial section data

-

-
-
-
-
-
-
descriptionartificial internal error processing parts of this section (no data but valid section)
gRPC statusINTERNAL (13)
gRPC error payloadnone
HTTP status500 (INTERNAL SERVER ERROR)
cacheableno

-

-
scenario internal

-

-
-
-
-
-
-
descriptioninternal error processing the section
gRPC statusINTERNAL (13)
gRPC error payloadnone
HTTP status500 (INTERNAL SERVER ERROR)
cacheableno

-

-
scenario timeout

-

-
-
-
-
-
-
descriptiontimeout loading and processing the section
gRPC statusDEADLINE_EXCEEDED (4)
gRPC error payloadnone
HTTP status504 (GATEWAY TIMEOUT)
cacheableno

-

-
Scenarios about incomplete section data needs to be defined.
-No section data results in an internal server error while incomplete section data might be returned.
-[~]

-
[~]

 
⚙︎ StageService

 
############################################################################

-
Description

+
Description

 
############################################################################
 Get single stages by requesting them via well-known ids, e.g. "schlagzeilen" or "meistgelesen".

 
############################################################################

-
Status/Error scenario's

+
Status/Error scenario's

 
############################################################################

 
scenario: found
 description: service responded without encountering exceptions
@@ -1669,7 +1447,7 @@ 
[~]

-
[~]

+
[~]

 
                     
 
diff --git a/docs/reference.html b/docs/reference.html
index e06a8d74..f1e9ccfe 100644
--- a/docs/reference.html
+++ b/docs/reference.html
@@ -88,7 +88,7 @@
 
         
@@ -232,7 +232,7 @@ 
Samples

                                 
                             
 
-                            
 
@@ -246,7 +246,7 @@ 
Samples

                         
                     
 
-                    
             
diff --git a/docs/searchindex.js b/docs/searchindex.js
index cfcbaa4c..9f93e33b 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#listarticlesrequest","⚙︎_corearticleservice.html#query","⚙︎_corearticleservice.html#type","⚙︎_corearticleservice.html#sortby","⚙︎_corearticleservice.html#order","⚙︎_corearticleservice.html#filters","⚙︎_corearticleservice.html#requestsettings","⚙︎_corearticleservice.html#requestsettingsarticleviewmode","⚙︎_corearticleservice.html#requestsettingsarticlevalidity","⚙︎_corearticleservice.html#requestsettingselementvalidity","⚙︎_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":271,"breadcrumbs":2,"title":1},"10":{"body":93,"breadcrumbs":3,"title":1},"11":{"body":58,"breadcrumbs":3,"title":1},"12":{"body":153,"breadcrumbs":4,"title":2},"13":{"body":115,"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":71,"breadcrumbs":6,"title":3},"2":{"body":16,"breadcrumbs":2,"title":1},"20":{"body":89,"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":240,"breadcrumbs":4,"title":2},"27":{"body":81,"breadcrumbs":4,"title":2},"28":{"body":79,"breadcrumbs":4,"title":2},"29":{"body":121,"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":98,"breadcrumbs":3,"title":2},"50":{"body":20,"breadcrumbs":3,"title":2},"51":{"body":19,"breadcrumbs":3,"title":2},"52":{"body":58,"breadcrumbs":2,"title":1},"53":{"body":35,"breadcrumbs":2,"title":1},"54":{"body":61,"breadcrumbs":2,"title":1},"55":{"body":86,"breadcrumbs":2,"title":1},"56":{"body":131,"breadcrumbs":2,"title":1},"57":{"body":43,"breadcrumbs":2,"title":1},"58":{"body":21,"breadcrumbs":2,"title":1},"59":{"body":28,"breadcrumbs":2,"title":1},"6":{"body":82,"breadcrumbs":3,"title":2},"60":{"body":85,"breadcrumbs":2,"title":1},"61":{"body":25,"breadcrumbs":2,"title":1},"62":{"body":21,"breadcrumbs":2,"title":1},"63":{"body":25,"breadcrumbs":2,"title":1},"64":{"body":62,"breadcrumbs":2,"title":1},"65":{"body":34,"breadcrumbs":2,"title":1},"66":{"body":4,"breadcrumbs":2,"title":1},"67":{"body":12,"breadcrumbs":2,"title":1},"68":{"body":26,"breadcrumbs":2,"title":1},"69":{"body":21,"breadcrumbs":2,"title":1},"7":{"body":61,"breadcrumbs":4,"title":2},"70":{"body":15,"breadcrumbs":2,"title":1},"71":{"body":44,"breadcrumbs":2,"title":1},"72":{"body":22,"breadcrumbs":2,"title":1},"73":{"body":16,"breadcrumbs":2,"title":1},"74":{"body":19,"breadcrumbs":2,"title":1},"75":{"body":112,"breadcrumbs":2,"title":1},"76":{"body":0,"breadcrumbs":3,"title":2},"77":{"body":19,"breadcrumbs":3,"title":2},"78":{"body":20,"breadcrumbs":5,"title":4},"79":{"body":21,"breadcrumbs":5,"title":4},"8":{"body":81,"breadcrumbs":3,"title":1},"80":{"body":20,"breadcrumbs":5,"title":4},"81":{"body":25,"breadcrumbs":5,"title":4},"82":{"body":20,"breadcrumbs":3,"title":2},"83":{"body":35,"breadcrumbs":3,"title":2},"84":{"body":0,"breadcrumbs":2,"title":1},"85":{"body":10,"breadcrumbs":2,"title":1},"86":{"body":55,"breadcrumbs":3,"title":2},"9":{"body":116,"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 . metadata Metadata The articles Metadata , containing state and various timestamps. 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 map 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 or Agencies ƒor this content related_articles repeated Article Editorial articles, which are related to the main article. May only be an empty unresolved article (not all services will resolve these). references repeated Reference [] References, e.g. URLs belonging to this article. 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 [deprecated = true];\nmap variants = 11;\nrepeated Author authors = 12;\nrepeated Article related_articles = 13;\nrepeated Reference references = 14;\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 / , link target can be found in the repeated Reference[] structure strong strong /  em emphasis /  sub subscript / sub sup superscript / sup hr horizontal rule / 
 br line break / 
 ul unordered list /