import "code.gitea.io/sdk/gitea"
admin_org.go admin_repo.go admin_user.go attachment.go client.go doc.go fork.go git_hook.go hook.go issue.go issue_comment.go issue_label.go issue_milestone.go issue_tracked_time.go miscellaneous.go org.go org_member.go org_team.go org_type.go pull.go release.go repo.go repo_branch.go repo_collaborator.go repo_commit.go repo_file.go repo_key.go repo_refs.go repo_tag.go repo_tree.go repo_watch.go status.go user.go user_app.go user_email.go user_follow.go user_gpgkey.go user_key.go user_search.go
BasicAuthEncode generate base64 of basic auth head
func ExtractKeysFromMapString(in map[string]VisibleType) (keys []string)
ExtractKeysFromMapString provides a slice of keys from map
Version return the library version
type AccessToken struct {
ID int64 `json:"id"`
Name string `json:"name"`
Token string `json:"sha1"`
TokenLastEight string `json:"token_last_eight"`
}AccessToken represents an API access token.
AddCollaboratorOption options when adding a user as a collaborator of a repository
AddOrgMembershipOption add user to organization options
AddTimeOption options for adding time to an issue
type Attachment struct {
ID int64 `json:"id"`
Name string `json:"name"`
Size int64 `json:"size"`
DownloadCount int64 `json:"download_count"`
Created time.Time `json:"created_at"`
UUID string `json:"uuid"`
DownloadURL string `json:"browser_download_url"`
}Attachment a generic attachment
type Branch struct {
Name string `json:"name"`
Commit *PayloadCommit `json:"commit"`
}Branch represents a repository branch
type Client struct {
// contains filtered or unexported fields
}Client represents a Gogs API client.
NewClient initializes and returns a API client.
NewClientWithHTTP creates an API client with a custom http client
func (c *Client) AddCollaborator(user, repo, collaborator string, opt AddCollaboratorOption) error
AddCollaborator add some user as a collaborator of a repository
func (c *Client) AddEmail(opt CreateEmailOption) ([]*Email, error)
AddEmail add one email to current user with options
func (c *Client) AddIssueLabels(owner, repo string, index int64, opt IssueLabelsOption) ([]*Label, error)
AddIssueLabels add one or more labels to one issue
func (c *Client) AddOrgMembership(org, user string, opt AddOrgMembershipOption) error
AddOrgMembership add some one to an organization's member
AddTeamMember adds a member to a team
AddTeamRepository adds a repository to a team
func (c *Client) AddTime(owner, repo string, index int64, opt AddTimeOption) (*TrackedTime, error)
AddTime adds time to issue with the given index
func (c *Client) AdminCreateOrg(user string, opt CreateOrgOption) (*Organization, error)
AdminCreateOrg create an organization
func (c *Client) AdminCreateRepo(user string, opt CreateRepoOption) (*Repository, error)
AdminCreateRepo create a repo
func (c *Client) AdminCreateUser(opt CreateUserOption) (*User, error)
AdminCreateUser create a user
AdminCreateUserPublicKey adds a public key for the user
AdminDeleteUser delete one user according name
AdminDeleteUserPublicKey deletes a user's public key
func (c *Client) AdminEditUser(user string, opt EditUserOption) error
AdminEditUser modify user informations
func (c *Client) AdminListOrgs() ([]*Organization, error)
AdminListOrgs lists all orgs
AdminListUsers lists all users
ClearIssueLabels delete all the labels of one issue.
func (c *Client) CreateAccessToken(user, pass string, opt CreateAccessTokenOption) (*AccessToken, error)
CreateAccessToken create one access token with options
CreateDeployKey options when create one deploy key
func (c *Client) CreateFork(user, repo string, form CreateForkOption) (*Repository, error)
CreateFork create a fork of a repository
func (c *Client) CreateGPGKey(opt CreateGPGKeyOption) (*GPGKey, error)
CreateGPGKey create GPG key with options
CreateIssue create a new issue for a given repository
func (c *Client) CreateIssueComment(owner, repo string, index int64, opt CreateIssueCommentOption) (*Comment, error)
CreateIssueComment create comment on an issue.
CreateLabel create one label of repository
func (c *Client) CreateMilestone(owner, repo string, opt CreateMilestoneOption) (*Milestone, error)
CreateMilestone create one milestone with options
func (c *Client) CreateOrg(opt CreateOrgOption) (*Organization, error)
CreateOrg creates an organization
CreateOrgHook create one hook for an organization, with options
func (c *Client) CreateOrgRepo(org string, opt CreateRepoOption) (*Repository, error)
CreateOrgRepo creates an organization repository for authenticated user.
func (c *Client) CreatePublicKey(opt CreateKeyOption) (*PublicKey, error)
CreatePublicKey create public key with options
func (c *Client) CreatePullRequest(owner, repo string, opt CreatePullRequestOption) (*PullRequest, error)
CreatePullRequest create pull request with options
CreateRelease create a release
func (c *Client) CreateReleaseAttachment(user, repo string, release int64, file io.Reader, filename string) (*Attachment, error)
CreateReleaseAttachment creates an attachment for the given release
func (c *Client) CreateRepo(opt CreateRepoOption) (*Repository, error)
CreateRepo creates a repository for authenticated user.
CreateRepoHook create one hook for a repository, with options
CreateStatus creates a new Status for a given Commit
POST /repos/:owner/:repo/statuses/:sha
CreateTeam creates a team for an organization
DeleteAccessToken delete token with key id
DeleteCollaborator remove a collaborator from a repository
DeleteDeployKey delete deploy key with key id
func (c *Client) DeleteEmail(opt DeleteEmailOption) error
DeleteEmail delete one email of current users'
DeleteGPGKey delete GPG key with key id
DeleteIssueComment deletes an issue comment.
DeleteIssueLabel delete one label of one issue by issue id and label id TODO: maybe we need delete by label name and issue id
DeleteLabel delete one label of repository by id TODO: maybe we need delete by name
DeleteMilestone delete one milestone by milestone id
DeleteOrg deletes an organization
DeleteOrgHook delete one hook from an organization, with hook id
DeletePublicKey delete public key with key id
DeleteRelease delete a release from a repository
DeleteReleaseAttachment deletes the given attachment including the uploaded file
DeleteRepo deletes a repository of user or organization.
DeleteRepoGitHook delete one Git hook from a repository
DeleteRepoHook delete one hook from a repository, with hook id
DeleteTeam deletes a team of an organization
EditIssue modify an existing issue for a given repository
func (c *Client) EditIssueComment(owner, repo string, commentID int64, opt EditIssueCommentOption) (*Comment, error)
EditIssueComment edits an issue comment.
EditLabel modify one label with options
func (c *Client) EditMilestone(owner, repo string, id int64, opt EditMilestoneOption) (*Milestone, error)
EditMilestone modify milestone with options
func (c *Client) EditOrg(orgname string, opt EditOrgOption) error
EditOrg modify one organization via options
EditOrgHook modify one hook of an organization, with hook id and options
func (c *Client) EditPullRequest(owner, repo string, index int64, opt EditPullRequestOption) (*PullRequest, error)
EditPullRequest modify pull request with PR id and options
func (c *Client) EditRelease(user, repo string, id int64, form EditReleaseOption) (*Release, error)
EditRelease edit a release
func (c *Client) EditReleaseAttachment(user, repo string, release int64, attachment int64, form EditAttachmentOptions) (*Attachment, error)
EditReleaseAttachment updates the given attachment with the given options
func (c *Client) EditRepo(owner, reponame string, opt EditRepoOption) (*Repository, error)
EditRepo edit the properties of a repository
func (c *Client) EditRepoGitHook(user, repo, id string, opt EditGitHookOption) error
EditRepoGitHook modify one Git hook of a repository
EditRepoHook modify one hook of a repository, with hook id and options
func (c *Client) EditTeam(id int64, opt EditTeamOption) error
EditTeam edits a team of an organization
Follow set current user follow the target
func (c *Client) GetCombinedStatus(owner, repo, sha string) (*CombinedStatus, error)
GetCombinedStatus returns the CombinedStatus for a given Commit
GET /repos/:owner/:repo/commits/:ref/status
GetDeployKey get one deploy key with key id
GetFile downloads a file of repository, ref can be branch/tag/commit. e.g.: ref -> master, tree -> macaron.go(no leading slash)
GetGPGKey get current user's GPG key by key id
GetIssue returns a single issue for a given repository
GetIssueLabels get labels of one issue via issue id
GetMilestone get one milestone by repo name and milestone id
func (c *Client) GetMyTrackedTimes() ([]*TrackedTime, error)
GetMyTrackedTimes list tracked times of the current user
GetMyUserInfo get user info of current user
func (c *Client) GetOrg(orgname string) (*Organization, error)
GetOrg get one organization by name
GetOrgHook get a hook of an organization
GetPublicKey get current user's public key by key id
GetPullRequest get information of one PR
GetRelease get a release of a repository
func (c *Client) GetReleaseAttachment(user, repo string, release int64, id int64) (*Attachment, error)
GetReleaseAttachment returns the requested attachment
func (c *Client) GetRepo(owner, reponame string) (*Repository, error)
GetRepo returns information of a repository of given owner.
GetRepoBranch get one branch's information of one repository
GetRepoGitHook get a Git hook of a repository
GetRepoHook get a hook of a repository
GetRepoLabel get one label of repository by repo it TODO: maybe we need get a label by name
GetRepoRef get one ref's information of one repository
GetRepoRefs get list of ref's information of one repository
func (c *Client) GetRepoTrackedTimes(owner, repo string) ([]*TrackedTime, error)
GetRepoTrackedTimes list tracked times of a repository
GetSingleCommit returns a single commit
GetTeam gets a team by ID
GetTeamMember gets a member of a team
GetTrees downloads a file of repository, ref can be branch/tag/commit. e.g.: ref -> master, tree -> macaron.go(no leading slash)
GetUserInfo get user info by user's name
func (c *Client) GetUserTrackedTimes(owner, repo, user string) ([]*TrackedTime, error)
GetUserTrackedTimes list tracked times of a user
func (c *Client) GetWatchedRepos(user, pass string) ([]*Repository, error)
GetWatchedRepos list all the watched repos of user
IsCollaborator check if a user is a collaborator of a repository
IsFollowing if current user followed the target
IsPullRequestMerged test if one PR is merged to one repository
IsUserFollowing if the user followed the target
func (c *Client) ListAccessTokens(user, pass string) ([]*AccessToken, error)
ListAccessTokens lista all the access tokens of user
ListCollaborators list a repository's collaborators
ListDeployKeys list all the deploy keys of one repository
ListEmails all the email addresses of user
ListFollowers list all the followers of one user
ListFollowing list all the users the user followed
func (c *Client) ListForks(user, repo string) ([]*Repository, error)
ListForks list a repository's forks
ListGPGKeys list all the GPG keys of the user
ListIssueComments list comments on an issue.
func (c *Client) ListIssues(opt ListIssueOption) ([]*Issue, error)
ListIssues returns all issues assigned the authenticated user
ListMyFollowers list all the followers of current user
ListMyFollowing list all the users current user followed
ListMyGPGKeys list all the GPG keys of current user
func (c *Client) ListMyOrgs() ([]*Organization, error)
ListMyOrgs list all of current user's organizations
ListMyPublicKeys list all the public keys of current user
func (c *Client) ListMyRepos() ([]*Repository, error)
ListMyRepos lists all repositories for the authenticated user that has access to.
ListMyTeams lists all the teams of the current user
ListOrgHooks list all the hooks of one organization
func (c *Client) ListOrgRepos(org string) ([]*Repository, error)
ListOrgRepos list all repositories of one organization by organization's name
ListOrgTeams lists all teams of an organization
ListPublicKeys list all the public keys of the user
ListReleaseAttachments list release's attachments
ListReleases list releases of a repository
ListRepoBranches list all the branches of one repository
ListRepoGitHooks list all the Git hooks of one repository
ListRepoHooks list all the hooks of one repository
ListRepoIssueComments list comments for a given repo.
ListRepoIssues returns all issues for a given repository
ListRepoLabels list labels of one repository
ListRepoMilestones list all the milestones of one repository
func (c *Client) ListRepoPullRequests(owner, repo string, opt ListPullRequestsOptions) ([]*PullRequest, error)
ListRepoPullRequests list PRs of one repository
ListRepoTags list all the branches of one repository
ListStatuses returns all statuses for a given Commit
GET /repos/:owner/:repo/commits/:ref/statuses
ListTeamMembers lists all members of a team
func (c *Client) ListTeamRepositories(id int64) ([]*Repository, error)
ListTeamRepositories lists all repositories of a team
ListTrackedTimes get tracked times of one issue via issue id
func (c *Client) ListUserIssues(opt ListIssueOption) ([]*Issue, error)
ListUserIssues returns all issues assigned to the authenticated user
func (c *Client) ListUserOrgs(user string) ([]*Organization, error)
ListUserOrgs list all of some user's organizations
func (c *Client) ListUserRepos(user string) ([]*Repository, error)
ListUserRepos list all repositories of one user by user's name
MergePullRequest merge a PR to repository by PR id
func (c *Client) MigrateRepo(opt MigrateRepoOption) (*Repository, error)
MigrateRepo migrates a repository from other Git hosting sources for the authenticated user.
To migrate a repository for a organization, the authenticated user must be a owner of the specified organization.
MirrorSync adds a mirrored repository to the mirror sync queue.
RemoveTeamMember removes a member from a team
RemoveTeamRepository removes a repository from a team
func (c *Client) ReplaceIssueLabels(owner, repo string, index int64, opt IssueLabelsOption) ([]*Label, error)
ReplaceIssueLabels replace old labels of issue with new labels
SearchUsers finds users by query
ServerVersion returns the version of the server
SetHTTPClient replaces default http.Client with user given one.
SetSudo sets username to impersonate.
StartIssueStopWatch starts a stopwatch for an existing issue for a given repository
StopIssueStopWatch stops an existing stopwatch for an issue in a given repository
UnWatchRepo start to watch a repository
Unfollow set current user unfollow the target
WatchRepo start to watch a repository
type CombinedStatus struct {
State StatusState `json:"state"`
SHA string `json:"sha"`
TotalCount int `json:"total_count"`
Statuses []*Status `json:"statuses"`
Repository *Repository `json:"repository"`
CommitURL string `json:"commit_url"`
URL string `json:"url"`
}CombinedStatus holds the combined state of several statuses for a single commit
type Comment struct {
ID int64 `json:"id"`
HTMLURL string `json:"html_url"`
PRURL string `json:"pull_request_url"`
IssueURL string `json:"issue_url"`
Poster *User `json:"user"`
OriginalAuthor string `json:"original_author"`
OriginalAuthorID int64 `json:"original_author_id"`
Body string `json:"body"`
Created time.Time `json:"created_at"`
Updated time.Time `json:"updated_at"`
}Comment represents a comment on a commit or issue
type Commit struct {
*CommitMeta
HTMLURL string `json:"html_url"`
RepoCommit *RepoCommit `json:"commit"`
Author *User `json:"author"`
Committer *User `json:"committer"`
Parents []*CommitMeta `json:"parents"`
}Commit contains information generated from a Git commit.
CommitMeta contains meta information of a commit in terms of API.
CommitUser contains information of a user in the context of a commit.
CreateAccessTokenOption options when create access token
CreateEmailOption options when creating email addresses
type CreateForkOption struct {
// organization name, if forking into an organization
Organization *string `json:"organization"`
}CreateForkOption options for creating a fork
type CreateGPGKeyOption struct {
// An armored GPG key to add
//
ArmoredKey string `json:"armored_public_key"`
}CreateGPGKeyOption options create user GPG key
type CreateHookOption struct {
Type string `json:"type"`
Config map[string]string `json:"config"`
Events []string `json:"events"`
BranchFilter string `json:"branch_filter"`
Active bool `json:"active"`
}CreateHookOption options when create a hook
CreateIssueCommentOption options for creating a comment on an issue
type CreateIssueOption struct {
Title string `json:"title"`
Body string `json:"body"`
// username of assignee
Assignee string `json:"assignee"`
Assignees []string `json:"assignees"`
Deadline *time.Time `json:"due_date"`
// milestone id
Milestone int64 `json:"milestone"`
// list of label ids
Labels []int64 `json:"labels"`
Closed bool `json:"closed"`
}CreateIssueOption options to create one issue
type CreateKeyOption struct {
// Title of the key to add
Title string `json:"title"`
// An armored SSH key to add
Key string `json:"key"`
// Describe if the key has only read access or read/write
ReadOnly bool `json:"read_only"`
}CreateKeyOption options when creating a key
type CreateLabelOption struct {
Name string `json:"name"`
// example: #00aabb
Color string `json:"color"`
Description string `json:"description"`
}CreateLabelOption options for creating a label
type CreateMilestoneOption struct {
Title string `json:"title"`
Description string `json:"description"`
Deadline *time.Time `json:"due_on"`
}CreateMilestoneOption options for creating a milestone
type CreateOrgOption struct {
UserName string `json:"username"`
FullName string `json:"full_name"`
Description string `json:"description"`
Website string `json:"website"`
Location string `json:"location"`
// possible values are `public` (default), `limited` or `private`
// enum: public,limited,private
Visibility string `json:"visibility"`
}CreateOrgOption options for creating an organization
type CreatePullRequestOption struct {
Head string `json:"head"`
Base string `json:"base"`
Title string `json:"title"`
Body string `json:"body"`
Assignee string `json:"assignee"`
Assignees []string `json:"assignees"`
Milestone int64 `json:"milestone"`
Labels []int64 `json:"labels"`
Deadline *time.Time `json:"due_date"`
}CreatePullRequestOption options when creating a pull request
type CreateReleaseOption struct {
TagName string `json:"tag_name"`
Target string `json:"target_commitish"`
Title string `json:"name"`
Note string `json:"body"`
IsDraft bool `json:"draft"`
IsPrerelease bool `json:"prerelease"`
}CreateReleaseOption options when creating a release
type CreateRepoOption struct {
// Name of the repository to create
//
Name string `json:"name"`
// Description of the repository to create
Description string `json:"description"`
// Whether the repository is private
Private bool `json:"private"`
// Issue Label set to use
IssueLabels string `json:"issue_labels"`
// Whether the repository should be auto-intialized?
AutoInit bool `json:"auto_init"`
// Gitignores to use
Gitignores string `json:"gitignores"`
// License to use
License string `json:"license"`
// Readme of the repository to create
Readme string `json:"readme"`
}CreateRepoOption options when creating repository
type CreateStatusOption struct {
State StatusState `json:"state"`
TargetURL string `json:"target_url"`
Description string `json:"description"`
Context string `json:"context"`
}CreateStatusOption holds the information needed to create a new Status for a Commit
type CreateTeamOption struct {
Name string `json:"name"`
Description string `json:"description"`
// enum: read,write,admin
Permission string `json:"permission"`
// example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
Units []string `json:"units"`
}CreateTeamOption options for creating a team
type CreateUserOption struct {
SourceID int64 `json:"source_id"`
LoginName string `json:"login_name"`
Username string `json:"username"`
FullName string `json:"full_name"`
Email string `json:"email"`
Password string `json:"password"`
MustChangePassword *bool `json:"must_change_password"`
SendNotify bool `json:"send_notify"`
}CreateUserOption create user options
DeleteEmailOption options when deleting email addresses
type DeployKey struct {
ID int64 `json:"id"`
KeyID int64 `json:"key_id"`
Key string `json:"key"`
URL string `json:"url"`
Title string `json:"title"`
Fingerprint string `json:"fingerprint"`
Created time.Time `json:"created_at"`
ReadOnly bool `json:"read_only"`
Repository *Repository `json:"repository,omitempty"`
}DeployKey a deploy key
EditAttachmentOptions options for editing attachments
EditGitHookOption options when modifying one Git hook
type EditHookOption struct {
Config map[string]string `json:"config"`
Events []string `json:"events"`
BranchFilter string `json:"branch_filter"`
Active *bool `json:"active"`
}EditHookOption options when modify one hook
EditIssueCommentOption options for editing a comment
type EditIssueOption struct {
Title string `json:"title"`
Body *string `json:"body"`
Assignee *string `json:"assignee"`
Assignees []string `json:"assignees"`
Milestone *int64 `json:"milestone"`
State *string `json:"state"`
Deadline *time.Time `json:"due_date"`
}EditIssueOption options for editing an issue
type EditLabelOption struct {
Name *string `json:"name"`
Color *string `json:"color"`
Description *string `json:"description"`
}EditLabelOption options for editing a label
type EditMilestoneOption struct {
Title string `json:"title"`
Description *string `json:"description"`
State *string `json:"state"`
Deadline *time.Time `json:"due_on"`
}EditMilestoneOption options for editing a milestone
type EditOrgOption struct {
FullName string `json:"full_name"`
Description string `json:"description"`
Website string `json:"website"`
Location string `json:"location"`
// possible values are `public`, `limited` or `private`
// enum: public,limited,private
Visibility string `json:"visibility"`
}EditOrgOption options for editing an organization
type EditPullRequestOption struct {
Title string `json:"title"`
Body string `json:"body"`
Assignee string `json:"assignee"`
Assignees []string `json:"assignees"`
Milestone int64 `json:"milestone"`
Labels []int64 `json:"labels"`
State *string `json:"state"`
Deadline *time.Time `json:"due_date"`
}EditPullRequestOption options when modify pull request
type EditReleaseOption struct {
TagName string `json:"tag_name"`
Target string `json:"target_commitish"`
Title string `json:"name"`
Note string `json:"body"`
IsDraft *bool `json:"draft"`
IsPrerelease *bool `json:"prerelease"`
}EditReleaseOption options when editing a release
type EditRepoOption struct {
// name of the repository
Name *string `json:"name,omitempty"`
// a short description of the repository.
Description *string `json:"description,omitempty"`
// a URL with more information about the repository.
Website *string `json:"website,omitempty"`
// either `true` to make the repository private or `false` to make it public.
// Note: you will get a 422 error if the organization restricts changing repository visibility to organization
// owners and a non-owner tries to change the value of private.
Private *bool `json:"private,omitempty"`
// either `true` to enable issues for this repository or `false` to disable them.
HasIssues *bool `json:"has_issues,omitempty"`
// either `true` to enable the wiki for this repository or `false` to disable it.
HasWiki *bool `json:"has_wiki,omitempty"`
// sets the default branch for this repository.
DefaultBranch *string `json:"default_branch,omitempty"`
// either `true` to allow pull requests, or `false` to prevent pull request.
HasPullRequests *bool `json:"has_pull_requests,omitempty"`
// either `true` to ignore whitespace for conflicts, or `false` to not ignore whitespace. `has_pull_requests` must be `true`.
IgnoreWhitespaceConflicts *bool `json:"ignore_whitespace_conflicts,omitempty"`
// either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. `has_pull_requests` must be `true`.
AllowMerge *bool `json:"allow_merge_commits,omitempty"`
// either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging. `has_pull_requests` must be `true`.
AllowRebase *bool `json:"allow_rebase,omitempty"`
// either `true` to allow rebase with explicit merge commits (--no-ff), or `false` to prevent rebase with explicit merge commits. `has_pull_requests` must be `true`.
AllowRebaseMerge *bool `json:"allow_rebase_explicit,omitempty"`
// either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging. `has_pull_requests` must be `true`.
AllowSquash *bool `json:"allow_squash_merge,omitempty"`
// set to `true` to archive this repository.
Archived *bool `json:"archived,omitempty"`
}EditRepoOption options when editing a repository's properties
type EditTeamOption struct {
Name string `json:"name"`
Description string `json:"description"`
// enum: read,write,admin
Permission string `json:"permission"`
// example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
Units []string `json:"units"`
}EditTeamOption options for editing a team
type EditUserOption struct {
SourceID int64 `json:"source_id"`
LoginName string `json:"login_name"`
FullName string `json:"full_name"`
Email string `json:"email"`
Password string `json:"password"`
MustChangePassword *bool `json:"must_change_password"`
Website string `json:"website"`
Location string `json:"location"`
Active *bool `json:"active"`
Admin *bool `json:"admin"`
AllowGitHook *bool `json:"allow_git_hook"`
AllowImportLocal *bool `json:"allow_import_local"`
MaxRepoCreation *int `json:"max_repo_creation"`
ProhibitLogin *bool `json:"prohibit_login"`
AllowCreateOrganization *bool `json:"allow_create_organization"`
}EditUserOption edit user options
type Email struct {
Email string `json:"email"`
Verified bool `json:"verified"`
Primary bool `json:"primary"`
}Email an email address belonging to a user
type GPGKey struct {
ID int64 `json:"id"`
PrimaryKeyID string `json:"primary_key_id"`
KeyID string `json:"key_id"`
PublicKey string `json:"public_key"`
Emails []*GPGKeyEmail `json:"emails"`
SubsKey []*GPGKey `json:"subkeys"`
CanSign bool `json:"can_sign"`
CanEncryptComms bool `json:"can_encrypt_comms"`
CanEncryptStorage bool `json:"can_encrypt_storage"`
CanCertify bool `json:"can_certify"`
Created time.Time `json:"created_at,omitempty"`
Expires time.Time `json:"expires_at,omitempty"`
}GPGKey a user GPG key to sign commit and tag in repository
GPGKeyEmail an email attached to a GPGKey
type GitEntry struct {
Path string `json:"path"`
Mode string `json:"mode"`
Type string `json:"type"`
Size int64 `json:"size"`
SHA string `json:"sha"`
URL string `json:"url"`
}GitEntry represents a git tree
type GitHook struct {
Name string `json:"name"`
IsActive bool `json:"is_active"`
Content string `json:"content,omitempty"`
}GitHook represents a Git repository hook
type GitObject struct {
Type string `json:"type"`
SHA string `json:"sha"`
URL string `json:"url"`
}GitObject represents a Git object.
type GitTreeResponse struct {
SHA string `json:"sha"`
URL string `json:"url"`
Entries []GitEntry `json:"tree"`
Truncated bool `json:"truncated"`
Page int `json:"page"`
TotalCount int `json:"total_count"`
}GitTreeResponse returns a git tree
type Hook struct {
ID int64 `json:"id"`
Type string `json:"type"`
URL string `json:"-"`
Config map[string]string `json:"config"`
Events []string `json:"events"`
Active bool `json:"active"`
Updated time.Time `json:"updated_at"`
Created time.Time `json:"created_at"`
}Hook a hook is a web hook when one repository changed
Identity for a person's identity like an author or committer
type Issue struct {
ID int64 `json:"id"`
URL string `json:"url"`
Index int64 `json:"number"`
Poster *User `json:"user"`
OriginalAuthor string `json:"original_author"`
OriginalAuthorID int64 `json:"original_author_id"`
Title string `json:"title"`
Body string `json:"body"`
Labels []*Label `json:"labels"`
Milestone *Milestone `json:"milestone"`
Assignee *User `json:"assignee"`
Assignees []*User `json:"assignees"`
// Whether the issue is open or closed
State StateType `json:"state"`
Comments int `json:"comments"`
Created time.Time `json:"created_at"`
Updated time.Time `json:"updated_at"`
Closed *time.Time `json:"closed_at"`
Deadline *time.Time `json:"due_date"`
PullRequest *PullRequestMeta `json:"pull_request"`
}Issue represents an issue in a repository
IssueLabelsOption a collection of labels
type Label struct {
ID int64 `json:"id"`
Name string `json:"name"`
// example: 00aabb
Color string `json:"color"`
Description string `json:"description"`
URL string `json:"url"`
}Label a label to an issue or a pr
ListIssueOption list issue options
ListPullRequestsOptions options for listing pull requests
ListStatusesOption holds pagination information
type MigrateRepoOption struct {
CloneAddr string `json:"clone_addr"`
AuthUsername string `json:"auth_username"`
AuthPassword string `json:"auth_password"`
UID int `json:"uid"`
RepoName string `json:"repo_name"`
Mirror bool `json:"mirror"`
Private bool `json:"private"`
Description string `json:"description"`
}MigrateRepoOption options for migrating a repository from an external service
type Milestone struct {
ID int64 `json:"id"`
Title string `json:"title"`
Description string `json:"description"`
State StateType `json:"state"`
OpenIssues int `json:"open_issues"`
ClosedIssues int `json:"closed_issues"`
Closed *time.Time `json:"closed_at"`
Deadline *time.Time `json:"due_on"`
}Milestone milestone is a collection of issues on one repository
type Organization struct {
ID int64 `json:"id"`
UserName string `json:"username"`
FullName string `json:"full_name"`
AvatarURL string `json:"avatar_url"`
Description string `json:"description"`
Website string `json:"website"`
Location string `json:"location"`
Visibility string `json:"visibility"`
}Organization represents an organization
type PRBranchInfo struct {
Name string `json:"label"`
Ref string `json:"ref"`
Sha string `json:"sha"`
RepoID int64 `json:"repo_id"`
Repository *Repository `json:"repo"`
}PRBranchInfo information about a branch
type PayloadCommit struct {
// sha1 hash of the commit
ID string `json:"id"`
Message string `json:"message"`
URL string `json:"url"`
Author *PayloadUser `json:"author"`
Committer *PayloadUser `json:"committer"`
Verification *PayloadCommitVerification `json:"verification"`
Timestamp time.Time `json:"timestamp"`
Added []string `json:"added"`
Removed []string `json:"removed"`
Modified []string `json:"modified"`
}PayloadCommit represents a commit
type PayloadCommitVerification struct {
Verified bool `json:"verified"`
Reason string `json:"reason"`
Signature string `json:"signature"`
Payload string `json:"payload"`
}PayloadCommitVerification represents the GPG verification of a commit
type PayloadUser struct {
// Full name of the commit author
Name string `json:"name"`
Email string `json:"email"`
UserName string `json:"username"`
}PayloadUser represents the author or committer of a commit
type Permission struct {
Admin bool `json:"admin"`
Push bool `json:"push"`
Pull bool `json:"pull"`
}Permission represents a set of permissions
type PublicKey struct {
ID int64 `json:"id"`
Key string `json:"key"`
URL string `json:"url,omitempty"`
Title string `json:"title,omitempty"`
Fingerprint string `json:"fingerprint,omitempty"`
Created time.Time `json:"created_at,omitempty"`
Owner *User `json:"user,omitempty"`
ReadOnly bool `json:"read_only,omitempty"`
KeyType string `json:"key_type,omitempty"`
}PublicKey publickey is a user key to push code to repository
type PullRequest struct {
ID int64 `json:"id"`
URL string `json:"url"`
Index int64 `json:"number"`
Poster *User `json:"user"`
Title string `json:"title"`
Body string `json:"body"`
Labels []*Label `json:"labels"`
Milestone *Milestone `json:"milestone"`
Assignee *User `json:"assignee"`
Assignees []*User `json:"assignees"`
State StateType `json:"state"`
Comments int `json:"comments"`
HTMLURL string `json:"html_url"`
DiffURL string `json:"diff_url"`
PatchURL string `json:"patch_url"`
Mergeable bool `json:"mergeable"`
HasMerged bool `json:"merged"`
Merged *time.Time `json:"merged_at"`
MergedCommitID *string `json:"merge_commit_sha"`
MergedBy *User `json:"merged_by"`
Base *PRBranchInfo `json:"base"`
Head *PRBranchInfo `json:"head"`
MergeBase string `json:"merge_base"`
Deadline *time.Time `json:"due_date"`
Created *time.Time `json:"created_at"`
Updated *time.Time `json:"updated_at"`
Closed *time.Time `json:"closed_at"`
}PullRequest represents a pull request
type PullRequestMeta struct {
HasMerged bool `json:"merged"`
Merged *time.Time `json:"merged_at"`
}PullRequestMeta PR info if an issue is a PR
type Reference struct {
Ref string `json:"ref"`
URL string `json:"url"`
Object *GitObject `json:"object"`
}Reference represents a Git reference.
type Release struct {
ID int64 `json:"id"`
TagName string `json:"tag_name"`
Target string `json:"target_commitish"`
Title string `json:"name"`
Note string `json:"body"`
URL string `json:"url"`
TarURL string `json:"tarball_url"`
ZipURL string `json:"zipball_url"`
IsDraft bool `json:"draft"`
IsPrerelease bool `json:"prerelease"`
CreatedAt time.Time `json:"created_at"`
PublishedAt time.Time `json:"published_at"`
Publisher *User `json:"author"`
Attachments []*Attachment `json:"assets"`
}Release represents a repository release
type RepoCommit struct {
URL string `json:"url"`
Author *CommitUser `json:"author"`
Committer *CommitUser `json:"committer"`
Message string `json:"message"`
Tree *CommitMeta `json:"tree"`
}RepoCommit contains information of a commit in the context of a repository.
type Repository struct {
ID int64 `json:"id"`
Owner *User `json:"owner"`
Name string `json:"name"`
FullName string `json:"full_name"`
Description string `json:"description"`
Empty bool `json:"empty"`
Private bool `json:"private"`
Fork bool `json:"fork"`
Parent *Repository `json:"parent"`
Mirror bool `json:"mirror"`
Size int `json:"size"`
HTMLURL string `json:"html_url"`
SSHURL string `json:"ssh_url"`
CloneURL string `json:"clone_url"`
OriginalURL string `json:"original_url"`
Website string `json:"website"`
Stars int `json:"stars_count"`
Forks int `json:"forks_count"`
Watchers int `json:"watchers_count"`
OpenIssues int `json:"open_issues_count"`
DefaultBranch string `json:"default_branch"`
Archived bool `json:"archived"`
Created time.Time `json:"created_at"`
Updated time.Time `json:"updated_at"`
Permissions *Permission `json:"permissions,omitempty"`
HasIssues bool `json:"has_issues"`
HasWiki bool `json:"has_wiki"`
HasPullRequests bool `json:"has_pull_requests"`
IgnoreWhitespaceConflicts bool `json:"ignore_whitespace_conflicts"`
AllowMerge bool `json:"allow_merge_commits"`
AllowRebase bool `json:"allow_rebase"`
AllowRebaseMerge bool `json:"allow_rebase_explicit"`
AllowSquash bool `json:"allow_squash_merge"`
AvatarURL string `json:"avatar_url"`
}Repository represents a repository
StateType issue state type
const (
// StateOpen pr is opend
StateOpen StateType = "open"
// StateClosed pr is closed
StateClosed StateType = "closed"
// StateAll is all
StateAll StateType = "all"
)type Status struct {
ID int64 `json:"id"`
State StatusState `json:"status"`
TargetURL string `json:"target_url"`
Description string `json:"description"`
URL string `json:"url"`
Context string `json:"context"`
Creator *User `json:"creator"`
Created time.Time `json:"created_at"`
Updated time.Time `json:"updated_at"`
}Status holds a single Status of a single Commit
StatusState holds the state of a Status It can be "pending", "success", "error", "failure", and "warning"
const (
// StatusPending is for when the Status is Pending
StatusPending StatusState = "pending"
// StatusSuccess is for when the Status is Success
StatusSuccess StatusState = "success"
// StatusError is for when the Status is Error
StatusError StatusState = "error"
// StatusFailure is for when the Status is Failure
StatusFailure StatusState = "failure"
// StatusWarning is for when the Status is Warning
StatusWarning StatusState = "warning"
)type Tag struct {
Name string `json:"name"`
ID string `json:"id"`
Commit *CommitMeta `json:"commit"`
ZipballURL string `json:"zipball_url"`
TarballURL string `json:"tarball_url"`
}Tag represents a repository tag
type Team struct {
ID int64 `json:"id"`
Name string `json:"name"`
Description string `json:"description"`
Organization *Organization `json:"organization"`
// enum: none,read,write,admin,owner
Permission string `json:"permission"`
// example: ["repo.code","repo.issues","repo.ext_issues","repo.wiki","repo.pulls","repo.releases","repo.ext_wiki"]
Units []string `json:"units"`
}Team represents a team in an organization
type TrackedTime struct {
ID int64 `json:"id"`
Created time.Time `json:"created"`
// Time in seconds
Time int64 `json:"time"`
UserID int64 `json:"user_id"`
IssueID int64 `json:"issue_id"`
}TrackedTime worked time for an issue / pr
type User struct {
// the user's id
ID int64 `json:"id"`
// the user's username
UserName string `json:"login"`
// the user's full name
FullName string `json:"full_name"`
Email string `json:"email"`
// URL to the user's avatar
AvatarURL string `json:"avatar_url"`
// User locale
Language string `json:"language"`
// Is the user an administrator
IsAdmin bool `json:"is_admin"`
LastLogin time.Time `json:"last_login,omitempty"`
Created time.Time `json:"created,omitempty"`
}User represents a user
VisibleType defines the visibility (Organization only)
const (
// VisibleTypePublic Visible for everyone
VisibleTypePublic VisibleType = iota
// VisibleTypeLimited Visible for every connected user
VisibleTypeLimited
// VisibleTypePrivate Visible only for organization's members
VisibleTypePrivate
)type WatchInfo struct {
Subscribed bool `json:"subscribed"`
Ignored bool `json:"ignored"`
Reason interface{} `json:"reason"`
CreatedAt time.Time `json:"created_at"`
URL string `json:"url"`
RepositoryURL string `json:"repository_url"`
}WatchInfo represents an API watch status of one repository
Package gitea imports 11 packages (graph) and is imported by 47 packages. Updated 2019-11-24. Refresh now. Tools for package owners.