article

type ArticlePage struct {

	// The editorial article with the ID of a `GetArticlePageRequest`.
	//
	// Unpublished elements will be filtered according to their metadata.
	Article *v1.Article `protobuf:"bytes,1,opt,name=article,proto3" json:"article,omitempty"`
	// Additional related editorial articles. Articles which are not published
	// according to their `Metadata` will be filtered.
	RelatedArticles []*RelatedArticle `protobuf:"bytes,2,rep,name=related_articles,json=relatedArticles,proto3" json:"related_articles,omitempty"`
	// stage(s) for the bottom of article pages, mostly seo cases like A-Z Modules
	Stages []*v11.Stage `protobuf:"bytes,3,rep,name=stages,proto3" json:"stages,omitempty"`
	// contains filtered or unexported fields
}

type ArticlePageServiceClient interface {
	//*
	//############################################################################
	//# Description
	//############################################################################
	//Returns the requested article with all render relevant data for the user and SEO bots.
	//
	//############################################################################
	//# Status/Error scenario's
	//############################################################################
	//
	//scenario: found
	//description: article was found in the datastore and is published according to it's metadata
	//gRPC status: OK
	//gRPC error payload: none
	//HTTP status: OK
	//cacheable: yes
	//
	//scenario: invalid id
	//description: article id is invalid
	//gRPC status: INVALID_ARGUMENT
	//gRPC error payload: google.rpc.BadRequest
	//HTTP status: 400
	//cacheable: yes
	//
	//scenario: not found
	//description: article was not found in the datastore
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: not published yet
	//description: article was found in the datastore but according to it's metadata the article is not published yet
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo with info about the 'start_time'
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: expired
	//description: article was found in the datastore but is expired according to it's metadata
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo with info about the 'end_time'
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: deleted/archived
	//description: article was found in the datastore but it's state is marked as deleted/archived
	//gRPC status: FAILED_PRECONDITION
	//gRPC error payload: google.rpc.PreconditionFailure with info about the state
	//HTTP status: 410
	//cacheable: yes
	//
	//scenario: internal
	//description: internal error processing the article
	//gRPC status: INTERNAL
	//gRPC error payload: none
	//HTTP status: 500
	//cacheable: no
	//
	//scenario: timeout
	//description: timeout loading and processing the article
	//gRPC status: DEADLINE_EXCEEDED
	//gRPC error payload: none
	//HTTP status: 504
	//cacheable: no
	//
	//*Redirect cases should be defined after requirements are clear**
	GetArticlePage(ctx context.Context, in *GetArticlePageRequest, opts ...grpc.CallOption) (*GetArticlePageResponse, error)
}

type ArticlePageServiceServer interface {
	//*
	//############################################################################
	//# Description
	//############################################################################
	//Returns the requested article with all render relevant data for the user and SEO bots.
	//
	//############################################################################
	//# Status/Error scenario's
	//############################################################################
	//
	//scenario: found
	//description: article was found in the datastore and is published according to it's metadata
	//gRPC status: OK
	//gRPC error payload: none
	//HTTP status: OK
	//cacheable: yes
	//
	//scenario: invalid id
	//description: article id is invalid
	//gRPC status: INVALID_ARGUMENT
	//gRPC error payload: google.rpc.BadRequest
	//HTTP status: 400
	//cacheable: yes
	//
	//scenario: not found
	//description: article was not found in the datastore
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: not published yet
	//description: article was found in the datastore but according to it's metadata the article is not published yet
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo with info about the 'start_time'
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: expired
	//description: article was found in the datastore but is expired according to it's metadata
	//gRPC status: NOT_FOUND
	//gRPC error payload: google.rpc.ResourceInfo with info about the 'end_time'
	//HTTP status: 404
	//cacheable: yes
	//
	//scenario: deleted/archived
	//description: article was found in the datastore but it's state is marked as deleted/archived
	//gRPC status: FAILED_PRECONDITION
	//gRPC error payload: google.rpc.PreconditionFailure with info about the state
	//HTTP status: 410
	//cacheable: yes
	//
	//scenario: internal
	//description: internal error processing the article
	//gRPC status: INTERNAL
	//gRPC error payload: none
	//HTTP status: 500
	//cacheable: no
	//
	//scenario: timeout
	//description: timeout loading and processing the article
	//gRPC status: DEADLINE_EXCEEDED
	//gRPC error payload: none
	//HTTP status: 504
	//cacheable: no
	//
	//*Redirect cases should be defined after requirements are clear**
	GetArticlePage(context.Context, *GetArticlePageRequest) (*GetArticlePageResponse, error)
	// contains filtered or unexported methods
}

type GetArticlePageRequest struct {

	// ID of the article defined by the content management system (required).
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetArticlePageResponse struct {

	// Article page with all render relevant data for the user and SEO bots.
	ArticlePage *ArticlePage `protobuf:"bytes,1,opt,name=article_page,json=articlePage,proto3" json:"article_page,omitempty"`
	// contains filtered or unexported fields
}

type RelatedArticle struct {

	// Data of the related article. This message will only contain data required
	// to render the article as a _Teaser_ (e.g. with `Article.body` set to `null`
	// thus not containing any data that is only required on detail pages).
	Article *v1.Article `protobuf:"bytes,1,opt,name=article,proto3" json:"article,omitempty"`
	// Source of the related article.
	Source RelatedArticleSource `protobuf:"varint,2,opt,name=source,proto3,enum=stroeer.page.article.v1.RelatedArticleSource" json:"source,omitempty"`
	// contains filtered or unexported fields
}

type RelatedArticleSource int32

type UnimplementedArticlePageServiceServer struct {
}

type UnsafeArticlePageServiceServer interface {
	// contains filtered or unexported methods
}