api

package

Go to main page

Versions in this module

v0

v0.5.0

May 14, 2026

Changes in this version

+ const DefaultTimeout

+ const DownloadTimeout

+ const LongPollTimeout

+ const UploadTimeout

+ func IsDebugEnabled() bool

+ func NewDownloadHTTPClient() *http.Client

+ func NewDownloadHTTPClientWithEnvTimeout() *http.Client

+ func NewHTTPClient(timeout time.Duration) *http.Client

+ func NewHTTPClientWithRetry(timeout time.Duration, cfg RetryConfig) *http.Client

+ func NewHTTPClientWithRetryAndLogger(timeout time.Duration, cfg RetryConfig, logger func(string)) *http.Client

+ func NewUploadHTTPClient() *http.Client

+ func ParseTimeoutFromEnv() time.Duration

+ func RetryMiddleware(rt http.RoundTripper, cfg RetryConfig) http.RoundTripper

+ func RetryMiddlewareWithLogger(rt http.RoundTripper, cfg RetryConfig, logger func(string)) http.RoundTripper

+ type GitCodeUpdateReleaseOptions struct

+ Body string

+ Name string

+ ReleaseStatus string

type Issue

+ Private string

+ SecurityHole string

type IssueComment

+ func ListIssueCommentsAll(client *Client, owner, repo string, number int, opts *IssueCommentListOptions) ([]IssueComment, error)

+ type LabelListOptions struct

+ Page int

+ PerPage int

+ type MilestoneListOptions struct

+ Page int

+ PerPage int

type Release

+ func UpdateReleaseByTagDirect(client *Client, owner, repo, tag string, opts *GitCodeUpdateReleaseOptions) (*Release, error)

+ type RetryConfig struct

+ InitialWait time.Duration

+ MaxRetries int

+ MaxWait time.Duration

+ Multiplier float64

+ func DefaultRetryConfig() RetryConfig

v0.4.0

May 2, 2026

Changes in this version

+ func DeleteBranch(client *Client, owner, name, branch string) error

type APIError

+ ErrorCode int

type Issue

+ func ListRepoIssuesAll(client *Client, owner, repo string, opts *IssueListOptions) ([]Issue, error)

type PRListOptions

+ Milestone string

type PullRequest

+ Milestone *Milestone

v0.3.11

Apr 25, 2026

v0.3.10

Apr 14, 2026

Changes in this version

type CreateIssueOptions

+ CustomFields []map[string]interface{}

+ IssueSeverity string

+ IssueType string

+ SecurityHole string

+ TemplatePath string

type Repository

+ func ListOrgRepos(client *Client, org string, opts *RepoListOptions) ([]Repository, error)

v0.3.9

Apr 4, 2026

v0.3.8

Apr 2, 2026

v0.3.7

Apr 1, 2026

Changes in this version

+ func ResolveUserIDs(client *Client, usernames []string) ([]string, error)

type APIError

+ ErrorCodeName string

+ ErrorMessage string

type Client

+ func (c *Client) GetText(path string) (string, error)

+ func (c *Client) PostForm(path string, formValues url.Values, response interface{}) error

type CreateIssueOptions

+ AssigneeIDs []string

type IssueComment

+ func UpdateIssueComment(client *Client, owner, repo string, commentID string, ...) (*IssueComment, error)

+ type IssueCommentListOptions struct

+ Order string

+ Page int

+ PerPage int

+ Since string

+ type UpdateCommentOptions struct

+ Body string

type UpdateIssueOptions

+ AssigneeIDs []string

v0.3.6

Mar 28, 2026

v0.3.5

Mar 28, 2026

Changes in this version

type UpdateIssueOptions

+ SecurityHole string

v0.3.4

Mar 27, 2026

v0.3.3

Mar 26, 2026

Changes in this version

+ type FlexibleTime struct

+ func (ft *FlexibleTime) UnmarshalJSON(data []byte) error

+ func (ft FlexibleTime) Format(layout string) string

+ func (ft FlexibleTime) IsZero() bool

+ func (ft FlexibleTime) MarshalJSON() ([]byte, error)

+ func (ft FlexibleTime) String() string

v0.3.2

Mar 26, 2026

v0.3.1

Mar 26, 2026

v0.3.0

Mar 26, 2026

Changes in this version

+ func GetCommitDiff(client *Client, owner, repo, sha string) (string, error)

+ func GetCommitPatch(client *Client, owner, repo, sha string) (string, error)

+ type CommitAuthor struct

+ Date time.Time

+ Email string

+ Name string

+ type CommitComment struct

+ Body string

+ CreatedAt string

+ ID int

+ Target *Commit

+ UpdatedAt string

+ User *User

+ func CreateCommitComment(client *Client, owner, repo, sha, body string) (*CommitComment, error)

+ func GetCommitComment(client *Client, owner, repo string, id int) (*CommitComment, error)

+ func ListCommentsForCommit(client *Client, owner, repo, sha string, opts *ListOptions) ([]CommitComment, error)

+ func ListCommitComments(client *Client, owner, repo string, opts *ListOptions) ([]CommitComment, error)

+ func UpdateCommitComment(client *Client, owner, repo string, id int, body string) (*CommitComment, error)

+ type CommitCommentsBySHAOptions struct

+ Page int

+ PerPage int

+ type CommitFile struct

+ Additions int

+ Changes int

+ Deletions int

+ Filename string

+ Status string

+ type CommitInfo struct

+ Author *CommitAuthor

+ Committer *CommitAuthor

+ Message string

+ type CommitStatItem struct

+ Author string

+ Commits int

+ type CommitStatistics struct

+ Commits []CommitStatItem

+ Statistics []StatItem

+ Total int

+ func GetCommitStatistics(client *Client, owner, repo string, opts *CommitStatsOptions) (*CommitStatistics, error)

+ type CommitStats struct

+ Additions int

+ Deletions int

+ Total int

+ type CommitStatsOptions struct

+ Author string

+ BranchName string

+ OnlySelf bool

+ Since string

+ Until string

type IssueListOptions

+ Assignee string

+ CreatedAfter string

+ CreatedBefore string

+ Creator string

+ Milestone string

+ Search string

+ UpdatedAfter string

+ UpdatedBefore string

+ type ListOptions struct

+ Order string

+ Page int

+ PerPage int

+ type RepositoryCommit struct

+ Author *User

+ CommentsURL string

+ Commit *CommitInfo

+ Committer *User

+ Files []CommitFile

+ HTMLURL string

+ SHA string

+ Stats *CommitStats

+ URL string

+ func GetCommit(client *Client, owner, repo, sha string, showDiff bool) (*RepositoryCommit, error)

+ type StatItem struct

+ Additions int

+ Author string

+ Deletions int

+ Total int

v0.2.13

Mar 25, 2026

v0.2.12

Mar 25, 2026

v0.2.11

Mar 25, 2026

Changes in this version

+ type IssuePR struct

+ Assignees []*User

+ Base *PRBranch

+ Body string

+ CanMergeCheck bool

+ ClosedAt *time.Time

+ CreatedAt time.Time

+ DiffURL string

+ HTMLURL string

+ Head *PRBranch

+ ID interface{}

+ Labels []*Label

+ MergedAt *time.Time

+ Number int

+ State string

+ Testers []*User

+ Title string

+ UpdatedAt time.Time

+ User *User

+ func GetIssuePullRequests(client *Client, owner, repo string, number int, mode int) ([]IssuePR, error)

v0.2.10

Mar 25, 2026

v0.2.9

Mar 24, 2026

v0.2.8

Mar 24, 2026

v0.2.7

Mar 23, 2026

v0.2.6

Mar 23, 2026

Changes in this version

type CreatePROptions

+ ForkPath string

v0.2.5

Mar 23, 2026

Changes in this version

+ func ResolvePRComment(client *Client, owner, repo string, number int, discussionID string, ...) error

+ func ReviewPR(client *Client, owner, repo string, number int, opts *ReviewPROptions) error

+ func TestPR(client *Client, owner, repo string, number int, opts *TestPROptions) error

+ type EditPRCommentOptions struct

+ Body string

type PRComment

+ func EditPRComment(client *Client, owner, repo string, commentID int, opts *EditPRCommentOptions) (*PRComment, error)

type PullRequest

+ func EditPR(client *Client, owner, repo string, number int, opts *UpdatePROptions) (*PullRequest, error)

+ type ReplyPRCommentOptions struct

+ Body string

+ type ReplyPRCommentReply struct

+ Body string

+ ID string

+ NoteID int

+ func ReplyPRComment(client *Client, owner, repo string, number int, discussionID string, ...) (*ReplyPRCommentReply, error)

+ type ResolvePRCommentOptions struct

+ Resolved bool

+ type ReviewPROptions struct

+ Force bool

+ type TestPROptions struct

+ Force bool

type UpdatePROptions

+ CloseRelatedIssue *bool

+ Labels []string

+ MilestoneNumber int

v0.2.4

Mar 23, 2026

Changes in this version

+ func RemoveIssueLabel(client *Client, owner, repo string, number int, label string) error

type Client

+ func (c *Client) PatchForm(path string, formValues url.Values, response interface{}) error

type Label

+ func AddIssueLabels(client *Client, owner, repo string, number int, labels []string) ([]*Label, error)

type UpdateIssueOptions

+ Repo string

v0.2.3

Mar 23, 2026

v0.2.2

Mar 23, 2026

Changes in this version

+ type PRDiff struct

+ Content *PRDiffContent

+ Head *PRDiffHead

+ NewBlobID string

+ NewPath string

+ OldPath string

+ Path string

+ Statistic *PRStatistic

+ Type string

+ View int

+ type PRDiffContent struct

+ Text []*PRDiffLine

+ type PRDiffHead struct

+ Additions int

+ CommitID string

+ Deletions int

+ URL string

+ type PRDiffLine struct

+ LineContent string

+ NewLine interface{}

+ OldLine interface{}

+ Type string

+ type PRDiffRefs struct

+ BaseSHA string

+ HeadSHA string

+ StartSHA string

+ type PRFilesResponse struct

+ AddedLines int

+ Code int

+ Count int

+ DiffRefs *PRDiffRefs

+ Diffs []*PRDiff

+ RemoveLines int

+ func GetPRFiles(client *Client, owner, repo string, number int) (*PRFilesResponse, error)

+ type PRStatistic struct

+ Additions int

+ Deletions int

v0.2.1

Mar 23, 2026

Changes in this version

type PRComment

+ CommentType string

+ DiffFile string

+ DiffPosition interface{}

+ DiscussionID string

+ Resolved bool

v0.2.0

Mar 23, 2026

Changes in this version

+ const DefaultAPIVersion

+ const DefaultHost

+ var ErrInvalidReleaseID = fmtError("invalid release ID")

+ var ErrNoReleaseID = fmtError("release has no ID")

+ func BuildURL(base string, params map[string]string) string

+ func ClearIssueLabels(client *Client, owner, repo string, number int) error

+ func DefaultHTTPClient() *http.Client

+ func DeleteIssueComment(client *Client, owner, repo string, commentID int64) error

+ func DeleteLabel(client *Client, owner, repo, name string) error

+ func DeleteMilestone(client *Client, owner, repo string, number int) error

+ func DeleteRelease(client *Client, owner, repo string, id int64) error

+ func DeleteReleaseAsset(client *Client, owner, repo string, assetID int64) error

+ func DeleteReleaseByTag(client *Client, owner, repo, tag string) error

+ func DeleteRepo(client *Client, owner, name string) error

+ func GetPRDiff(client *Client, owner, repo string, number int) (string, error)

+ func RemoveLabelFromIssue(client *Client, owner, repo string, number int, label string) error

+ func UploadReleaseAssetByTag(client *Client, owner, repo, tag, filename string, content []byte, ...) error

+ type APIError struct

+ ErrorName string

+ Message string

+ StatusCode int

+ func (e *APIError) Error() string

+ type AssetUploadURL struct

+ Headers map[string]string

+ URL string

+ func GetReleaseUploadURL(client *Client, owner, repo, tag, filename string) (*AssetUploadURL, error)

+ type Client struct

+ func ClientFromToken(token string) *Client

+ func ClientFromTokenAndHost(token, host string) *Client

+ func NewClient(httpClient *http.Client, host, token string) *Client

+ func NewClientFromHTTP(httpClient *http.Client) *Client

+ func (c *Client) Delete(path string) error

+ func (c *Client) Get(path string, response interface{}) error

+ func (c *Client) Host() string

+ func (c *Client) Patch(path string, body interface{}, response interface{}) error

+ func (c *Client) Post(path string, body interface{}, response interface{}) error

+ func (c *Client) Put(path string, body interface{}, response interface{}) error

+ func (c *Client) REST(method, path string, body interface{}, response interface{}) error

+ func (c *Client) SetHost(host string)

+ func (c *Client) SetToken(token, source string)

+ func (c *Client) Token() string

+ func (c *Client) UploadAsset(path, filename string, content []byte, contentType string) (*ReleaseAsset, error)

+ func (c *Client) UploadToURL(uploadURL, filename string, content []byte, contentType string, ...) error

+ type Commit struct

+ Author *User

+ Committer *User

+ Message string

+ SHA string

+ func ListPRCommits(client *Client, owner, repo string, number int) ([]Commit, error)

+ type CreateCommentOptions struct

+ Body string

+ type CreateIssueOptions struct

+ Assignees []string

+ Body string

+ Labels []string

+ Milestone int

+ Title string

+ type CreateLabelOptions struct

+ Color string

+ Description string

+ Name string

+ type CreateMilestoneOptions struct

+ Description string

+ DueOn *time.Time

+ State string

+ Title string

+ type CreatePRCommentOptions struct

+ Body string

+ Path string

+ Position int

+ type CreatePROptions struct

+ Base string

+ Body string

+ Draft bool

+ Head string

+ Title string

+ type CreatePRReviewOptions struct

+ Body string

+ Comments []PRReviewComment

+ Event string

+ type CreateReleaseOptions struct

+ Body string

+ Draft bool

+ Name string

+ Prerelease bool

+ TagName string

+ TargetCommitish string

+ type CreateRepoOptions struct

+ AutoInit bool

+ Description string

+ GitignoreTemplate string

+ LicenseTemplate string

+ Name string

+ Private bool

+ type Issue struct

+ Assignees []*User

+ Body string

+ ClosedAt *time.Time

+ Comments int

+ CreatedAt time.Time

+ HTMLURL string

+ ID interface{}

+ Labels []*Label

+ Milestone *Milestone

+ Number string

+ State string

+ Title string

+ UpdatedAt time.Time

+ User *User

+ func CloseIssue(client *Client, owner, repo string, number int) (*Issue, error)

+ func CreateIssue(client *Client, owner, repo string, opts *CreateIssueOptions) (*Issue, error)

+ func GetIssue(client *Client, owner, repo string, number int) (*Issue, error)

+ func ListRepoIssues(client *Client, owner, repo string, opts *IssueListOptions) ([]Issue, error)

+ func ReopenIssue(client *Client, owner, repo string, number int) (*Issue, error)

+ func UpdateIssue(client *Client, owner, repo string, number int, opts *UpdateIssueOptions) (*Issue, error)

+ type IssueComment struct

+ Body string

+ CreatedAt time.Time

+ ID interface{}

+ UpdatedAt time.Time

+ User *User

+ func CreateIssueComment(client *Client, owner, repo string, number int, opts *CreateCommentOptions) (*IssueComment, error)

+ func ListIssueComments(client *Client, owner, repo string, number int) ([]IssueComment, error)

+ type IssueListOptions struct

+ Direction string

+ Labels string

+ Page int

+ PerPage int

+ Since string

+ Sort string

+ State string

+ type Label struct

+ Color string

+ Description string

+ ID interface{}

+ Name string

+ func AddLabelsToIssue(client *Client, owner, repo string, number int, labels []string) ([]Label, error)

+ func CreateLabel(client *Client, owner, repo string, opts *CreateLabelOptions) (*Label, error)

+ func GetLabel(client *Client, owner, repo, name string) (*Label, error)

+ func ListRepoLabels(client *Client, owner, repo string) ([]Label, error)

+ func SetIssueLabels(client *Client, owner, repo string, number int, labels []string) ([]Label, error)

+ func UpdateLabel(client *Client, owner, repo, name string, opts *UpdateLabelOptions) (*Label, error)

+ type MergePROptions struct

+ CommitMessage string

+ CommitTitle string

+ MergeMethod string

+ SHA string

+ type Milestone struct

+ Description string

+ DueOn *time.Time

+ ID interface{}

+ Number string

+ State string

+ Title string

+ func CloseMilestone(client *Client, owner, repo string, number int) (*Milestone, error)

+ func CreateMilestone(client *Client, owner, repo string, opts *CreateMilestoneOptions) (*Milestone, error)

+ func GetMilestone(client *Client, owner, repo string, number int) (*Milestone, error)

+ func ListRepoMilestones(client *Client, owner, repo string) ([]Milestone, error)

+ func OpenMilestone(client *Client, owner, repo string, number int) (*Milestone, error)

+ func UpdateMilestone(client *Client, owner, repo string, number int, opts *UpdateMilestoneOptions) (*Milestone, error)

+ type PRBranch struct

+ Label string

+ Ref string

+ Repo *Repository

+ SHA string

+ type PRComment struct

+ Body string

+ CreatedAt time.Time

+ ID interface{}

+ Path string

+ Position int

+ UpdatedAt time.Time

+ User *User

+ func CreatePRComment(client *Client, owner, repo string, number int, opts *CreatePRCommentOptions) (*PRComment, error)

+ func ListPRComments(client *Client, owner, repo string, number int) ([]PRComment, error)

+ type PRListOptions struct

+ Base string

+ Direction string

+ Head string

+ Page int

+ PerPage int

+ Sort string

+ State string

+ type PRReview struct

+ Body string

+ ID interface{}

+ State string

+ SubmittedAt time.Time

+ User *User

+ func CreatePRReview(client *Client, owner, repo string, number int, opts *CreatePRReviewOptions) (*PRReview, error)

+ func ListPRReviews(client *Client, owner, repo string, number int) ([]PRReview, error)

+ type PRReviewComment struct

+ Body string

+ Path string

+ Position int

+ type PullRequest struct

+ Additions int

+ Assignees []*User

+ Base *PRBranch

+ Body string

+ ChangedFiles int

+ ClosedAt *string

+ Comments int

+ Commits int

+ CreatedAt time.Time

+ Deletions int

+ DiffURL string

+ Draft bool

+ HTMLURL string

+ Head *PRBranch

+ ID interface{}

+ Labels []*Label

+ MergeState interface{}

+ Mergeable *bool

+ Merged bool

+ MergedAt *string

+ Number int

+ PatchURL string

+ Reviewers []*User

+ State string

+ Title string

+ UpdatedAt time.Time

+ User *User

+ func ClosePullRequest(client *Client, owner, repo string, number int) (*PullRequest, error)

+ func CreatePullRequest(client *Client, owner, repo string, opts *CreatePROptions) (*PullRequest, error)

+ func GetPullRequest(client *Client, owner, repo string, number int) (*PullRequest, error)

+ func ListPullRequests(client *Client, owner, repo string, opts *PRListOptions) ([]PullRequest, error)

+ func MergePullRequest(client *Client, owner, repo string, number int, opts *MergePROptions) (*PullRequest, error)

+ func ReopenPullRequest(client *Client, owner, repo string, number int) (*PullRequest, error)

+ func UpdatePullRequest(client *Client, owner, repo string, number int, opts *UpdatePROptions) (*PullRequest, error)

+ type Release struct

+ Assets []ReleaseAsset

+ AssetsURL string

+ Author *User

+ Body string

+ CreatedAt time.Time

+ Draft bool

+ HTMLURL string

+ ID interface{}

+ Name string

+ Prerelease bool

+ PublishedAt *time.Time

+ TagName string

+ TargetCommitish string

+ UploadURL string

+ func CreateRelease(client *Client, owner, repo string, opts *CreateReleaseOptions) (*Release, error)

+ func GetLatestRelease(client *Client, owner, repo string) (*Release, error)

+ func GetRelease(client *Client, owner, repo, tag string) (*Release, error)

+ func GetReleaseByID(client *Client, owner, repo string, id int64) (*Release, error)

+ func ListReleases(client *Client, owner, repo string, opts *ReleaseListOptions) ([]Release, error)

+ func UpdateRelease(client *Client, owner, repo string, id int64, opts *UpdateReleaseOptions) (*Release, error)

+ func UpdateReleaseByTag(client *Client, owner, repo, tag string, opts *UpdateReleaseOptions) (*Release, error)

+ func (r *Release) GetID() (int64, error)

+ type ReleaseAsset struct

+ BrowserDownloadURL string

+ ContentType string

+ CreatedAt time.Time

+ Downloads int

+ ID int

+ Label string

+ Name string

+ Size int

+ State string

+ URL string

+ UpdatedAt time.Time

+ func GetReleaseAsset(client *Client, owner, repo string, assetID int64) (*ReleaseAsset, error)

+ func ListReleaseAssets(client *Client, owner, repo string, releaseID int64) ([]ReleaseAsset, error)

+ func UploadReleaseAsset(client *Client, owner, repo string, releaseID int64, filename string, ...) (*ReleaseAsset, error)

+ type ReleaseListOptions struct

+ Page int

+ PerPage int

+ type RepoListOptions struct

+ Affiliation string

+ Direction string

+ Page int

+ PerPage int

+ Sort string

+ Type string

+ Visibility string

+ type Repository struct

+ CloneURL string

+ CreatedAt time.Time

+ DefaultBranch string

+ Description string

+ ForksCount int

+ FullName string

+ HTMLURL string

+ ID interface{}

+ Language string

+ Name string

+ OpenIssuesCount int

+ Owner *User

+ Private bool

+ SSHURL string

+ StargazersCount int

+ UpdatedAt time.Time

+ func CreateOrgRepo(client *Client, org string, opts *CreateRepoOptions) (*Repository, error)

+ func CreateRepo(client *Client, opts *CreateRepoOptions) (*Repository, error)

+ func ForkRepo(client *Client, owner, name string) (*Repository, error)

+ func GetRepo(client *Client, owner, name string) (*Repository, error)

+ func ListUserRepos(client *Client, opts *RepoListOptions) ([]Repository, error)

+ type UpdateIssueOptions struct

+ Assignees []string

+ Body string

+ Labels []string

+ Milestone int

+ State string

+ StateEvent string

+ Title string

+ type UpdateLabelOptions struct

+ Color string

+ Description string

+ NewName string

+ type UpdateMilestoneOptions struct

+ Description string

+ DueOn *time.Time

+ State string

+ Title string

+ type UpdatePROptions struct

+ Base string

+ Body string

+ Draft *bool

+ State string

+ StateEvent string

+ Title string

+ type UpdateReleaseOptions struct

+ Body string

+ Draft *bool

+ Name string

+ Prerelease *bool

+ TagName string

+ TargetCommitish string

+ type User struct

+ AvatarURL string

+ CreatedAt string

+ Email string

+ HTMLURL string

+ ID interface{}

+ Login string

+ Name string

+ func CurrentUser(client *Client) (*User, error)

+ func GetUser(client *Client, username string) (*User, error)

+ func VerifyToken(httpClient *http.Client, host, token string) (*User, error)

+ func (u *User) Username() string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL