helpdesk_faq

Documentation

Index

• type ConfigMapClient
  • func NewCMClient(kubeClient ctrlruntimeclient.Client, namespace string, logger *logrus.Entry) ConfigMapClient
  • func (c *ConfigMapClient) GetFAQItemIfExists(timestamp string) (*FaqItem, error)
  • func (c *ConfigMapClient) GetSerializedFAQItems() ([]string, error)
  • func (c *ConfigMapClient) RemoveItem(timestamp string) error
  • func (c *ConfigMapClient) UpsertItem(item FaqItem) error
• type FaqItem
  • func (f FaqItem) ReplyExists(timestamp string) bool
• type FaqItemClient
• type Question
• type Reply

Types

type ConfigMapClient

type ConfigMapClient struct {
	// contains filtered or unexported fields
}

func NewCMClient

func NewCMClient(kubeClient ctrlruntimeclient.Client, namespace string, logger *logrus.Entry) ConfigMapClient

func (*ConfigMapClient) GetFAQItemIfExists

func (c *ConfigMapClient) GetFAQItemIfExists(timestamp string) (*FaqItem, error)

func (*ConfigMapClient) GetSerializedFAQItems

func (c *ConfigMapClient) GetSerializedFAQItems() ([]string, error)

func (*ConfigMapClient) RemoveItem

func (c *ConfigMapClient) RemoveItem(timestamp string) error

func (*ConfigMapClient) UpsertItem

func (c *ConfigMapClient) UpsertItem(item FaqItem) error

type FaqItem

type FaqItem struct {
	Question         Question `json:"question"`
	Timestamp        string   `json:"timestamp"`
	ThreadLink       string   `json:"thread_link"`
	ContributingInfo []Reply  `json:"contributing_info"`
	Answers          []Reply  `json:"answers"`
}

func (FaqItem) ReplyExists

func (f FaqItem) ReplyExists(timestamp string) bool

ReplyExists takes a timestamp and returns true if the reply at that timestamp is included in the Answers or ContributingInfo on this FaqItem

type FaqItemClient

type FaqItemClient interface {
	GetSerializedFAQItems() ([]string, error)
	GetFAQItemIfExists(timestamp string) (*FaqItem, error)
	UpsertItem(item FaqItem) error
	RemoveItem(timestamp string) error
}

type Question

type Question struct {
	Author  string `json:"author"`
	Topic   string `json:"topic"`
	Subject string `json:"subject"`
	Body    string `json:"body"`
}

type Reply

type Reply struct {
	Author    string `json:"author"`
	Timestamp string `json:"timestamp"`
	Body      string `json:"body"`
}