github

Documentation

Overview

Package github provides a GO API for the GitHub issue tracker. See https://developer.github.com/v3/search/#search-issues.

Index

• Constants
• type Issue
• type IssuesSearchResult
  • func SearchIssues(terms []string) (*IssuesSearchResult, error)
• type User

Constants

const IssuesURL = "https://api.github.com/search/issues"

Types

type Issue

type Issue struct {
	Number    int
	HTMLURL   string `json:"html_url`
	Title     string
	State     string
	User      *User
	CreatedAt time.Time `json:"created_at"`
	Body      string    // In Markdown format
}

type IssuesSearchResult

type IssuesSearchResult struct {
	TotalCount int `json: "total_count"`
	Items      []*Issue
}

func SearchIssues

func SearchIssues(terms []string) (*IssuesSearchResult, error)

SearchIssues queries the GitHub issue tracker

type User

type User struct {
	Login   string
	HTMLURL string `json:"html_url`
}