docs_builder

Documentation

Index

• type Client
  • func NewClient(httpClient d8http.Client) *Client
  • func (c *Client) BuildDocumentation(ctx context.Context, docsBuilderBasePath string) error
  • func (c *Client) CheckBuilderHealth(ctx context.Context, baseAddr string) error
  • func (c *Client) DeleteDocumentation(ctx context.Context, baseAddr string, moduleName string) error
  • func (c *Client) SendDocumentation(ctx context.Context, baseAddr string, moduleName, moduleVersion string, ...) error

Types

type Client

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

func NewClient

func NewClient(httpClient d8http.Client) *Client

func (*Client) BuildDocumentation

func (c *Client) BuildDocumentation(ctx context.Context, docsBuilderBasePath string) error

func (*Client) CheckBuilderHealth

func (c *Client) CheckBuilderHealth(ctx context.Context, baseAddr string) error

func (*Client) DeleteDocumentation

func (c *Client) DeleteDocumentation(ctx context.Context, baseAddr string, moduleName string) error

func (*Client) SendDocumentation

func (c *Client) SendDocumentation(ctx context.Context, baseAddr string, moduleName, moduleVersion string, docsArchive io.Reader) error