articles

Documentation

Index

• type Bulletin
• type Client
  • func NewAPIClient(articlesAPIURL string) *Client
  • func NewWithHealthClient(hcCli *health.Client) *Client
  • func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error
  • func (c *Client) GetLegacyBulletin(ctx context.Context, userAccessToken, collectionID, lang, uri string) (*Bulletin, error)
  • func (c *Client) HealthClient() *health.Client
  • func (c *Client) URL() string

Types

type Bulletin

type Bulletin = zebedee.Bulletin

Bulletin holds the response body containing a bulletin

type Client

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

Client is an articles api client which can be used to make requests to the server. It extends the generic healthcheck Client structure.

func NewAPIClient

func NewAPIClient(articlesAPIURL string) *Client

NewAPIClient creates a new instance of ArticlesApi Client with a given article api url

func NewWithHealthClient

func NewWithHealthClient(hcCli *health.Client) *Client

NewWithHealthClient creates a new instance of ArticlesApi Client, reusing the URL and Clienter from the provided healthcheck client.

func (*Client) Checker

func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error

Checker calls articles API health endpoint and returns a check object to the caller.

func (*Client) GetLegacyBulletin

func (c *Client) GetLegacyBulletin(ctx context.Context, userAccessToken, collectionID, lang, uri string) (*Bulletin, error)

GetLegacyBulletin returns a legacy bulletin

func (*Client) HealthClient

func (c *Client) HealthClient() *health.Client

HealthClient returns the underlying Healthcheck Client for this articles API client

func (*Client) URL

func (c *Client) URL() string

URL returns the URL used by this client