gitwiki

Documentation

Overview

Package gitwiki provides a GitLab wiki API client for changelog accumulation.

Index

• type Client
  • func NewClient(cfg Config) *Client
  • func (c *Client) AccumulatePage(ctx context.Context, title, newContent string) (*Page, bool, error)
  • func (c *Client) Configured() bool
  • func (c *Client) CreatePage(ctx context.Context, title, content string) (*Page, error)
  • func (c *Client) GetPage(ctx context.Context, slug string) (*Page, error)
  • func (c *Client) UpdatePage(ctx context.Context, slug, title, content string) (*Page, error)
• type Config
• type Page

Types

type Client

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

func NewClient

func NewClient(cfg Config) *Client

func (*Client) AccumulatePage

func (c *Client) AccumulatePage(ctx context.Context, title, newContent string) (*Page, bool, error)

func (*Client) Configured

func (c *Client) Configured() bool

func (*Client) CreatePage

func (c *Client) CreatePage(ctx context.Context, title, content string) (*Page, error)

func (*Client) GetPage

func (c *Client) GetPage(ctx context.Context, slug string) (*Page, error)

func (*Client) UpdatePage

func (c *Client) UpdatePage(ctx context.Context, slug, title, content string) (*Page, error)

type Config

type Config struct {
	Token   string
	Repo    string
	BaseURL string
	Slug    string
}

type Page

type Page struct {
	Slug    string `json:"slug"`
	Title   string `json:"title"`
	Content string `json:"content"`
	URL     string `json:"web_url"`
}