ghrest

Documentation

Overview

Package ghrest provides a wrapper around the go-github client that implements the internal REST API

Index

• type GhRest
  • func NewGhRest(token string) *GhRest
  • func (c *GhRest) Do(ctx context.Context, req *http.Request) (*http.Response, error)
  • func (c *GhRest) NewRequest(method, requestUrl string, body any) (*http.Request, error)

Types

type GhRest

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

GhRest is the struct that contains the GitHub REST API client this struct implements the REST API

func NewGhRest

func NewGhRest(token string) *GhRest

NewGhRest creates a new instance of GhRest

func (*GhRest) Do

func (c *GhRest) Do(ctx context.Context, req *http.Request) (*http.Response, error)

Do sends an API request and returns the API response.

func (*GhRest) NewRequest

func (c *GhRest) NewRequest(method, requestUrl string, body any) (*http.Request, error)

NewRequest creates an API request. A relative URL can be provided in urlStr, which will be resolved to the BaseURL of the Client. Relative URLS should always be specified without a preceding slash. If specified, the value pointed to by body is JSON encoded and included as the request body.