articlev1

package
v1.33.0-20230707151846... Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: unknown License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	RelatedArticleSource_name = map[int32]string{
		0: "RELATED_ARTICLE_SOURCE_UNSPECIFIED",
		1: "RELATED_ARTICLE_SOURCE_EDITORIAL",
	}
	RelatedArticleSource_value = map[string]int32{
		"RELATED_ARTICLE_SOURCE_UNSPECIFIED": 0,
		"RELATED_ARTICLE_SOURCE_EDITORIAL":   1,
	}
)

Enum value maps for RelatedArticleSource.

View Source
var File_stroeer_page_article_v1_article_page_proto protoreflect.FileDescriptor
View Source
var File_stroeer_page_article_v1_article_page_service_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ArticlePage

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"`
	// stages for article pages contain companions, links to topic pages, A-Z Modules etc.
	// configuration.fields contains a `stage_type`, which defines the rendering position
	Stages []*v11.Stage `protobuf:"bytes,3,rep,name=stages,proto3" json:"stages,omitempty"`
	// Page navigation including internal and external references
	// The root references has nested references
	// root
	//   - menu
	//   - submenu
	//   - menu
	//   - submenu
	//   - external references
	NavigationMenu *v1.Reference `protobuf:"bytes,4,opt,name=navigation_menu,json=navigationMenu,proto3" json:"navigation_menu,omitempty"`
	// contains filtered or unexported fields
}

Article page with all render relevant data for the user and SEO bots.

func (*ArticlePage) Descriptor deprecated

func (*ArticlePage) Descriptor() ([]byte, []int)

Deprecated: Use ArticlePage.ProtoReflect.Descriptor instead.

func (*ArticlePage) GetArticle

func (x *ArticlePage) GetArticle() *v1.Article

func (*ArticlePage) GetNavigationMenu

func (x *ArticlePage) GetNavigationMenu() *v1.Reference

func (*ArticlePage) GetRelatedArticles

func (x *ArticlePage) GetRelatedArticles() []*RelatedArticle

func (*ArticlePage) GetStages

func (x *ArticlePage) GetStages() []*v11.Stage

func (*ArticlePage) ProtoMessage

func (*ArticlePage) ProtoMessage()

func (*ArticlePage) ProtoReflect

func (x *ArticlePage) ProtoReflect() protoreflect.Message

func (*ArticlePage) Reset

func (x *ArticlePage) Reset()

func (*ArticlePage) String

func (x *ArticlePage) String() string

type GetArticlePageRequest

type GetArticlePageRequest struct {
	Id int64 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

* ## Request message to get an article page. ```protobuf

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

```

func (*GetArticlePageRequest) Descriptor deprecated

func (*GetArticlePageRequest) Descriptor() ([]byte, []int)

Deprecated: Use GetArticlePageRequest.ProtoReflect.Descriptor instead.

func (*GetArticlePageRequest) GetId

func (x *GetArticlePageRequest) GetId() int64

func (*GetArticlePageRequest) ProtoMessage

func (*GetArticlePageRequest) ProtoMessage()

func (*GetArticlePageRequest) ProtoReflect

func (x *GetArticlePageRequest) ProtoReflect() protoreflect.Message

func (*GetArticlePageRequest) Reset

func (x *GetArticlePageRequest) Reset()

func (*GetArticlePageRequest) String

func (x *GetArticlePageRequest) String() string

type GetArticlePageResponse

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
}

* ## Response message for an article page request.

Status codes: - `OK` | article exists and is published - `NOT_FOUND` | article doesn't exist or is not published according to it's `Metadata`

```protobuf

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

```

func (*GetArticlePageResponse) Descriptor deprecated

func (*GetArticlePageResponse) Descriptor() ([]byte, []int)

Deprecated: Use GetArticlePageResponse.ProtoReflect.Descriptor instead.

func (*GetArticlePageResponse) GetArticlePage

func (x *GetArticlePageResponse) GetArticlePage() *ArticlePage

func (*GetArticlePageResponse) ProtoMessage

func (*GetArticlePageResponse) ProtoMessage()

func (*GetArticlePageResponse) ProtoReflect

func (x *GetArticlePageResponse) ProtoReflect() protoreflect.Message

func (*GetArticlePageResponse) Reset

func (x *GetArticlePageResponse) Reset()

func (*GetArticlePageResponse) String

func (x *GetArticlePageResponse) String() string

type RelatedArticle

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"`
	// Deprecated (since 04.04.2023) source of the related article in form of an enum.
	Source RelatedArticleSource `protobuf:"varint,2,opt,name=source,proto3,enum=stroeer.page.article.v1.RelatedArticleSource" json:"source,omitempty"`
	// Source of the related article.
	RelatedArticleSource string `protobuf:"bytes,3,opt,name=related_article_source,json=relatedArticleSource,proto3" json:"related_article_source,omitempty"`
	// contains filtered or unexported fields
}

An editorial article, which is related to another article.

Related articles are specified manually be the editorial department or identified by recommendation systems.

func (*RelatedArticle) Descriptor deprecated

func (*RelatedArticle) Descriptor() ([]byte, []int)

Deprecated: Use RelatedArticle.ProtoReflect.Descriptor instead.

func (*RelatedArticle) GetArticle

func (x *RelatedArticle) GetArticle() *v1.Article

func (*RelatedArticle) GetRelatedArticleSource

func (x *RelatedArticle) GetRelatedArticleSource() string

func (*RelatedArticle) GetSource

func (x *RelatedArticle) GetSource() RelatedArticleSource

func (*RelatedArticle) ProtoMessage

func (*RelatedArticle) ProtoMessage()

func (*RelatedArticle) ProtoReflect

func (x *RelatedArticle) ProtoReflect() protoreflect.Message

func (*RelatedArticle) Reset

func (x *RelatedArticle) Reset()

func (*RelatedArticle) String

func (x *RelatedArticle) String() string

type RelatedArticleSource

type RelatedArticleSource int32
const (
	// Not specified.
	RelatedArticleSource_RELATED_ARTICLE_SOURCE_UNSPECIFIED RelatedArticleSource = 0
	// Article was related manually by the editorial department.
	RelatedArticleSource_RELATED_ARTICLE_SOURCE_EDITORIAL RelatedArticleSource = 1
)

func (RelatedArticleSource) Descriptor

func (RelatedArticleSource) Enum

func (RelatedArticleSource) EnumDescriptor deprecated

func (RelatedArticleSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use RelatedArticleSource.Descriptor instead.

func (RelatedArticleSource) Number

func (RelatedArticleSource) String

func (x RelatedArticleSource) String() string

func (RelatedArticleSource) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL