Documentation
¶
Index ¶
- func GetHeaders(tr authorisation.TokenRetriever, useStableAPI bool, etag, lastModified string) (map[string]string, error)
- func PostHeaders(tr authorisation.TokenRetriever, useStableAPI bool) (map[string]string, error)
- type GithubPageIterator
- type IGithubClient
- type Page
- type PageGetter
- type PageIterator
- type Payload
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GetHeaders ¶
func GetHeaders( tr authorisation.TokenRetriever, useStableAPI bool, etag, lastModified string, ) (map[string]string, error)
GetHeaders gets the headers required for a GET request
func PostHeaders ¶
func PostHeaders(tr authorisation.TokenRetriever, useStableAPI bool) (map[string]string, error)
PostHeaders gets the headers required for a POST request
Types ¶
type GithubPageIterator ¶
type GithubPageIterator struct {
StartURL string
Current *Page
// contains filtered or unexported fields
}
GithubPageIterator is an iterator over Github results pages
func NewGithubPageIterator ¶
func NewGithubPageIterator(startURL string, pageGetter PageGetter) *GithubPageIterator
NewGithubPageIterator creates a new PageIterator type for iterating over Github pages of results
func (*GithubPageIterator) Error ¶
func (i *GithubPageIterator) Error() error
func (*GithubPageIterator) Next ¶
func (i *GithubPageIterator) Next() *Page
func (*GithubPageIterator) NextWithContext ¶
func (i *GithubPageIterator) NextWithContext(ctx context.Context) *Page
NextWithContext will return the next page in the results, and a boolean to indicate if there is a subsequent page
type IGithubClient ¶
type IGithubClient interface {
Post(string, bool, map[string]string) int
Patch(string, bool, map[string]string) int
PageGetter
}
IGithubClient provides a Github client interface
type Page ¶
Page holds links to the current, next and last pages of results Github results
type PageGetter ¶
type PageGetter interface {
Get(string, bool) *Page
GetWithContext(context.Context, string, bool) *Page
}
PageGetter defines an interface for retrieving Github results pages
type PageIterator ¶
PageIterator defines the interface for iterating over multi-page results from an HTTP GET