raw

Documentation

Overview

Package raw provides a client for interacting with the GitHub raw file API

Index

• Variables
• type Client
  • func NewClient(client *gogithub.Client, rawURL *url.URL) *Client
  • func (c *Client) GetRawContent(ctx context.Context, owner, repo, path string, opts *ContentOpts) (*http.Response, error)
  • func (c *Client) URLFromOpts(opts *ContentOpts, owner, repo, path string) string
• type ContentOpts
• type GetRawClientFn

Variables

var GetRawReposContentsByOwnerByRepoByBranchByPath mock.EndpointPattern = mock.EndpointPattern{
	Pattern: "/{owner}/{repo}/refs/heads/{branch}/{path:.*}",
	Method:  "GET",
}

var GetRawReposContentsByOwnerByRepoByPath mock.EndpointPattern = mock.EndpointPattern{
	Pattern: "/{owner}/{repo}/HEAD/{path:.*}",
	Method:  "GET",
}

var GetRawReposContentsByOwnerByRepoBySHAByPath mock.EndpointPattern = mock.EndpointPattern{
	Pattern: "/{owner}/{repo}/{sha}/{path:.*}",
	Method:  "GET",
}

var GetRawReposContentsByOwnerByRepoByTagByPath mock.EndpointPattern = mock.EndpointPattern{
	Pattern: "/{owner}/{repo}/refs/tags/{tag}/{path:.*}",
	Method:  "GET",
}

Types

type Client

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

Client is a client for interacting with the GitHub raw content API.

func NewClient

func NewClient(client *gogithub.Client, rawURL *url.URL) *Client

NewClient creates a new instance of the raw API Client with the provided GitHub client and provided URL.

func (*Client) GetRawContent

func (c *Client) GetRawContent(ctx context.Context, owner, repo, path string, opts *ContentOpts) (*http.Response, error)

GetRawContent fetches the raw content of a file from a GitHub repository.

func (*Client) URLFromOpts

func (c *Client) URLFromOpts(opts *ContentOpts, owner, repo, path string) string

type ContentOpts

type ContentOpts struct {
	Ref string
	SHA string
}

type GetRawClientFn

type GetRawClientFn func(context.Context) (*Client, error)

GetRawClientFn is a function type that returns a RawClient instance.