releasecalendar

Documentation

Index

• type Client
  • func NewAPIClient(releaseCalendarApiUrl string) *Client
  • func NewWithHealthClient(hcCli *health.Client) *Client
  • func (c *Client) Checker(ctx context.Context, check *healthcheck.CheckState) error
  • func (c *Client) GetLegacyRelease(ctx context.Context, userAccessToken, collectionID, lang, uri string) (*Release, error)
  • func (c *Client) HealthClient() *health.Client
  • func (c *Client) URL() string
• type Contact
• type Link
• type Release
  • func (r Release) Census() bool
• type ReleaseDateChange
• type ReleaseDescription

Types

type Client

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

Client is a release calendar api client which can be used to make requests to the server. It extends the generic healthcheck Client structure.

func NewAPIClient

func NewAPIClient(releaseCalendarApiUrl string) *Client

NewAPIClient creates a new instance of ReleaseCalendarAPI Client with a given release calendar api url

func NewWithHealthClient

func NewWithHealthClient(hcCli *health.Client) *Client

NewWithHealthClient creates a new instance of ReleaseCalendarAPI 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 the release calendar API health endpoint and returns a check object to the caller.

func (*Client) GetLegacyRelease

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

GetLegacyRelease returns a legacy release

func (*Client) HealthClient

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

HealthClient returns the underlying Healthcheck Client for this release calendar API client

func (*Client) URL

func (c *Client) URL() string

URL returns the URL used by this client

type Contact

type Contact struct {
	Email     string `json:"email"`
	Name      string `json:"name"`
	Telephone string `json:"telephone"`
}

Contact represents the contact details for the release

type Link

type Link struct {
	Summary string `json:"summary"`
	Title   string `json:"title"`
	URI     string `json:"uri"`
}

Link represents a link to a related resource

type Release

type Release struct {
	DateChanges               []ReleaseDateChange `json:"date_changes"`
	Description               ReleaseDescription  `json:"description"`
	Links                     []Link              `json:"links"`
	Markdown                  []string            `json:"markdown"`
	RelatedDatasets           []Link              `json:"related_datasets"`
	RelatedDocuments          []Link              `json:"related_documents"`
	RelatedMethodology        []Link              `json:"related_methodology"`
	RelatedMethodologyArticle []Link              `json:"related_methodology_article"`
	URI                       string              `json:"uri"`
}

Release represents a release

func (Release) Census

func (r Release) Census() bool

type ReleaseDateChange

type ReleaseDateChange struct {
	ChangeNotice string `json:"change_notice"`
	Date         string `json:"previous_date"`
}

ReleaseDateChange represent a date change of a release

type ReleaseDescription

type ReleaseDescription struct {
	CancellationNotice []string `json:"cancellation_notice"`
	Cancelled          bool     `json:"cancelled"`
	Contact            Contact  `json:"contact"`
	Finalised          bool     `json:"finalised"`
	NationalStatistic  bool     `json:"national_statistic"`
	WelshStatistic     bool     `json:"welsh_statistic"`
	Survey             string   `json:"survey"`
	NextRelease        string   `json:"next_release"`
	ProvisionalDate    string   `json:"provisional_date"`
	Published          bool     `json:"published"`
	ReleaseDate        string   `json:"release_date"`
	Summary            string   `json:"summary"`
	Title              string   `json:"title"`
}

ReleaseDescription represents the description of a release