service ArticlePageService {
# turns the requested article with editorial render relevant data for the user and SEO bots.
rpc GetArticlePage (GetArticlePageRequest) returns (GetArticlePageResponse) {}
}
[~]
message GetArticlePageRequest {
# ID of the article defined by the content management system (required).
int64 id = 1;
}
[~]
Status codes:
OK | article exists and is publishedNOT_FOUND | article doesn't exist or is not published according to it's Metadata
message GetArticlePageResponse {
# Article page with all render relevant data for the user and SEO bots.
stroeer.page.article.v1.ArticlePage article_page = 1;
}
[~]
description article was found in the datastore and is published and valid according to it's metadata gRPC status OK (0)gRPC error payload none HTTP status 200 (OK)cacheable yes
description article id is invalid gRPC status INVALID_ARGUMENT (3)gRPC error payload google.rpc.Bad HTTP status 400 (BAD REQUEST)cacheable yes
description article was not found in the datastore gRPC status NOT_FOUND (5)gRPC error payload none HTTP status 404 (NOT FOUND)cacheable yes
description article was found in the datastore, but is not valid yet according to its metadata.start_time gRPC status NOT_FOUND (5)gRPC error payload google.rpc.ResourceInfo, check description field for recommended http status code HTTP status 404 (NOT FOUND)cacheable yes
description article was found in the datastore, but it's stateState.DELETED nor State.PUBLISHED gRPC status NOT_FOUND (5)gRPC error payload google.rpc.ResourceInfo, check description field for recommended http status code HTTP status 404 (NOT FOUND)cacheable yes
description article was found in the datastore, but is expired according to metadata.end_time gRPC status NOT_FOUND (5)gRPC error payload google.rpc.ResourceInfo, check description field for recommended http status code HTTP status 410 (GONE)cacheable yes
description article was found in the datastore, but it's state is State.DELETED gRPC status NOT_FOUND (5)gRPC error payload google.rpc.ResourceInfo, check description field for recommended http status code HTTP status 410 (GONE)cacheable yes
description internal error processing the article gRPC status INTERNAL (13)gRPC error payload none HTTP status 500 (INTERNAL SERVER ERROR)cacheable no
description timeout loading and processing the article gRPC status DEADLINE_EXCEEDED (4)gRPC error payload none HTTP status 504 (GATEWAY TIMEOUT)cacheable no[~]
[~]