api

package

Go to main page

Versions in this module

v1

v1.2.16

Jul 14, 2026

Changes in this version

type JobAPI

+ func (a *JobAPI) Play(ctx context.Context, projectID string, jobID int, vars []JobVariable) (*Job, error)

+ type JobVariable struct

+ Key string

+ Value string

v1.2.15

Jul 8, 2026

v1.2.14

Jul 2, 2026

v1.2.13

Jun 29, 2026

v1.2.12

Jun 25, 2026

v1.2.11

Jun 25, 2026

v1.2.10

Jun 22, 2026

v1.2.9

Jun 21, 2026

v1.2.8

Jun 16, 2026

Changes in this version

type Commit

+ Stats *CommitStats

+ type CommitDiffFile struct

+ DeletedFile bool

+ Diff string

+ NewFile bool

+ NewPath string

+ OldPath string

+ RenamedFile bool

type CommitListOpts

+ AllBranches bool

+ Author string

+ WithStats bool

+ type CommitStats struct

+ Additions int

+ Deletions int

+ Total int

type ProjectAPI

+ func (a *ProjectAPI) ListGroupProjects(ctx context.Context, groupID string, limit int) ([]Project, error)

type RepoAPI

+ func (a *RepoAPI) GetCommitDiff(ctx context.Context, projectID, sha string) ([]CommitDiffFile, error)

v1.2.7

Jun 16, 2026

v1.2.6

Jun 16, 2026

v1.2.5

Jun 16, 2026

Changes in this version

+ type DiffPosition struct

+ BaseSHA string

+ HeadSHA string

+ NewLine *int

+ NewPath string

+ OldLine *int

+ OldPath string

+ PositionType string

+ StartSHA string

+ type DiffRefs struct

+ BaseSHA string

+ HeadSHA string

+ StartSHA string

type MergeRequest

+ DiffRefs *DiffRefs

type MergeRequestAPI

+ func (a *MergeRequestAPI) CreateDiscussion(ctx context.Context, projectID string, iid int, body string, ...) (*MergeRequestDiscussion, error)

+ func (a *MergeRequestAPI) ResolveDiscussion(ctx context.Context, projectID string, iid int, discussionID string, ...) (*MergeRequestDiscussion, error)

type MergeRequestNote

+ Resolvable bool

+ Resolved bool

v1.2.4

Jun 15, 2026

Changes in this version

+ type CommitAction struct

+ Action string

+ Content string

+ Encoding string

+ FilePath string

+ LastCommitID string

+ PreviousPath string

+ type CommitCreateOpts struct

+ Actions []CommitAction

+ Branch string

+ CommitMessage string

+ StartBranch string

type RepoAPI

+ func (a *RepoAPI) CreateCommit(ctx context.Context, projectID string, opts CommitCreateOpts) (*Commit, error)

v1.2.3

Jun 14, 2026

Changes in this version

+ func WithIdempotencyKey(ctx context.Context, key string) context.Context

type FileWriteBody

+ LastCommitID string

type JobAPI

+ func (a *JobAPI) LogStreamFunc(ctx context.Context, projectID string, jobID int, interval time.Duration, ...) error

+ func (a *JobAPI) LogStreamStatus(ctx context.Context, projectID string, jobID int, interval time.Duration, ...) (string, error)

+ type LogChunkFunc func(chunk []byte, offset int) error

type MergeRequestAPI

+ func (a *MergeRequestAPI) ListDiscussions(ctx context.Context, projectID string, iid, limit int) ([]MergeRequestDiscussion, error)

+ func (a *MergeRequestAPI) ReplyDiscussion(ctx context.Context, projectID string, iid int, discussionID, body string) (*MergeRequestNote, error)

+ type MergeRequestDiscussion struct

+ ID string

+ IndividualNote bool

+ Notes []MergeRequestNote

type ProjectAPI

+ func (a *ProjectAPI) Create(ctx context.Context, req *ProjectCreateRequest) (*Project, error)

+ type ProjectCreateRequest struct

+ Description string

+ Name string

+ NamespaceID int

+ Path string

+ Visibility string

v1.2.2

Jun 14, 2026

v1.2.1

Jun 12, 2026

v1.2.0

Jun 6, 2026

v1.1.1

Jun 5, 2026

v1.1.0

May 25, 2026

v1.0.0

May 24, 2026

Changes in this version

+ const APIBasePath

+ func EncodeProjectPath(projectPath string) string

+ type APIError struct

+ ErrorMessages []string

+ Errors map[string]string

+ StatusCode int

+ func (e *APIError) Error() string

+ type Branch struct

+ CanPush bool

+ Commit *Commit

+ Default bool

+ DevelopersCanMerge bool

+ DevelopersCanPush bool

+ Merged bool

+ Name string

+ Protected bool

+ WebURL string

+ type BranchListOpts struct

+ Limit int

+ Search string

+ type Client struct

+ DownloadClient *http.Client

+ Issues *IssueAPI

+ Jobs *JobAPI

+ Labels *LabelAPI

+ MergeRequests *MergeRequestAPI

+ Milestones *MilestoneAPI

+ Pipelines *PipelineAPI

+ Projects *ProjectAPI

+ Releases *ReleaseAPI

+ Repos *RepoAPI

+ Search *SearchAPI

+ Users *UserAPI

+ Variables *VariableAPI

+ func NewClient(cfg *config.Config) *Client

+ func (c *Client) APIPath(resource string) string

+ func (c *Client) Delete(ctx context.Context, path string) error

+ func (c *Client) DeleteWithBody(ctx context.Context, path string, body any) error

+ func (c *Client) DownloadTo(ctx context.Context, path string, w io.Writer) error

+ func (c *Client) Get(ctx context.Context, path string) ([]byte, error)

+ func (c *Client) GetWithPagination(ctx context.Context, path string) ([]byte, Pagination, error)

+ func (c *Client) Host() string

+ func (c *Client) Post(ctx context.Context, path string, body any) ([]byte, error)

+ func (c *Client) Put(ctx context.Context, path string, body any) ([]byte, error)

+ func (c *Client) RawGet(ctx context.Context, path string, headers map[string]string) (int, []byte, error)

+ func (c *Client) Upload(ctx context.Context, path, fieldName, filePath string) ([]byte, error)

+ type Commit struct

+ AuthorEmail string

+ AuthorName string

+ AuthoredDate string

+ CommittedDate string

+ CommitterEmail string

+ CommitterName string

+ ID string

+ Message string

+ ParentIDs []string

+ ShortID string

+ Title string

+ WebURL string

+ type CommitListOpts struct

+ Limit int

+ Path string

+ RefName string

+ Since string

+ Until string

+ type FileWriteBody struct

+ Branch string

+ CommitMessage string

+ Content string

+ Encoding string

+ type Issue struct

+ Assignee *User

+ Author *User

+ Confidential bool

+ CreatedAt string

+ Description string

+ ID int

+ IID int

+ Labels []string

+ Milestone ...

+ State string

+ Title string

+ UpdatedAt string

+ WebURL string

+ type IssueAPI struct

+ func (a *IssueAPI) AddNote(ctx context.Context, projectID string, iid int, body string) (*IssueNote, error)

+ func (a *IssueAPI) Create(ctx context.Context, projectID string, opts IssueCreateOpts) (*Issue, error)

+ func (a *IssueAPI) DeleteNote(ctx context.Context, projectID string, iid, noteID int) error

+ func (a *IssueAPI) Get(ctx context.Context, projectID string, iid int) (*Issue, error)

+ func (a *IssueAPI) List(ctx context.Context, projectID string, opts *IssueListOpts) ([]Issue, error)

+ func (a *IssueAPI) ListNotes(ctx context.Context, projectID string, iid, limit int) ([]IssueNote, error)

+ func (a *IssueAPI) Update(ctx context.Context, projectID string, iid int, opts IssueUpdateOpts) (*Issue, error)

+ type IssueCreateOpts struct

+ AssigneeIDs []int

+ Confidential bool

+ Description string

+ Labels string

+ MilestoneID int

+ Title string

+ type IssueListOpts struct

+ AssigneeUsername string

+ AuthorUsername string

+ Labels string

+ Limit int

+ Milestone string

+ Search string

+ State string

+ type IssueNote struct

+ Author *User

+ Body string

+ CreatedAt string

+ ID int

+ System bool

+ UpdatedAt string

+ type IssueUpdateOpts struct

+ AddLabels string

+ AssigneeIDs []int

+ Description string

+ MilestoneID int

+ RemoveLabels string

+ StateEvent string

+ Title string

+ type Job struct

+ CreatedAt string

+ Duration float64

+ FinishedAt string

+ ID int

+ Name string

+ Pipeline *Pipeline

+ Ref string

+ Stage string

+ StartedAt string

+ Status string

+ User *User

+ WebURL string

+ type JobAPI struct

+ func (a *JobAPI) Artifacts(ctx context.Context, projectID string, jobID int) ([]byte, error)

+ func (a *JobAPI) ArtifactsTo(ctx context.Context, projectID string, jobID int, w io.Writer) error

+ func (a *JobAPI) Cancel(ctx context.Context, projectID string, jobID int) (*Job, error)

+ func (a *JobAPI) Get(ctx context.Context, projectID string, jobID int) (*Job, error)

+ func (a *JobAPI) Log(ctx context.Context, projectID string, jobID int) ([]byte, error)

+ func (a *JobAPI) LogStream(ctx context.Context, projectID string, jobID int, w io.Writer, ...) error

+ func (a *JobAPI) Retry(ctx context.Context, projectID string, jobID int) (*Job, error)

+ type Label struct

+ Color string

+ Description string

+ ID int

+ Name string

+ Priority *int

+ type LabelAPI struct

+ func (a *LabelAPI) Create(ctx context.Context, projectID string, opts LabelCreateOpts) (*Label, error)

+ func (a *LabelAPI) Delete(ctx context.Context, projectID string, labelID int) error

+ func (a *LabelAPI) List(ctx context.Context, projectID string, limit int) ([]Label, error)

+ func (a *LabelAPI) Update(ctx context.Context, projectID string, labelID int, opts LabelUpdateOpts) (*Label, error)

+ type LabelCreateOpts struct

+ Color string

+ Description string

+ Name string

+ Priority *int

+ type LabelUpdateOpts struct

+ Color string

+ Description string

+ NewName string

+ Priority *int

+ type MergeRequest struct

+ Assignee *User

+ Author *User

+ CreatedAt string

+ Description string

+ Draft bool

+ IID int

+ Labels []string

+ MergeStatus string

+ SHA string

+ SourceBranch string

+ Squash bool

+ State string

+ TargetBranch string

+ Title string

+ UpdatedAt string

+ WebURL string

+ type MergeRequestAPI struct

+ func (a *MergeRequestAPI) AddNote(ctx context.Context, projectID string, iid int, body string) (*MergeRequestNote, error)

+ func (a *MergeRequestAPI) Approve(ctx context.Context, projectID string, iid int) error

+ func (a *MergeRequestAPI) Close(ctx context.Context, projectID string, iid int) (*MergeRequest, error)

+ func (a *MergeRequestAPI) Create(ctx context.Context, projectID string, req *MergeRequestCreateRequest) (*MergeRequest, error)

+ func (a *MergeRequestAPI) DeleteNote(ctx context.Context, projectID string, iid, noteID int) error

+ func (a *MergeRequestAPI) Get(ctx context.Context, projectID string, iid int) (*MergeRequest, error)

+ func (a *MergeRequestAPI) GetRawDiff(ctx context.Context, projectID string, iid int) (string, error)

+ func (a *MergeRequestAPI) List(ctx context.Context, projectID string, opts *MergeRequestListOpts) ([]MergeRequest, error)

+ func (a *MergeRequestAPI) ListNotes(ctx context.Context, projectID string, iid, limit int) ([]MergeRequestNote, error)

+ func (a *MergeRequestAPI) Merge(ctx context.Context, projectID string, iid int, req *MergeRequestMergeRequest) (*MergeRequest, error)

+ func (a *MergeRequestAPI) Reopen(ctx context.Context, projectID string, iid int) (*MergeRequest, error)

+ func (a *MergeRequestAPI) Unapprove(ctx context.Context, projectID string, iid int) error

+ func (a *MergeRequestAPI) Update(ctx context.Context, projectID string, iid int, req *MergeRequestUpdateRequest) (*MergeRequest, error)

+ type MergeRequestCreateRequest struct

+ AssigneeID int

+ Description string

+ Draft bool

+ Labels string

+ RemoveSourceBranch bool

+ SourceBranch string

+ Squash bool

+ TargetBranch string

+ Title string

+ type MergeRequestListOpts struct

+ AssigneeUser string

+ AuthorUser string

+ Labels string

+ Limit int

+ Search string

+ SourceBranch string

+ State string

+ TargetBranch string

+ type MergeRequestMergeRequest struct

+ MergeCommitMessage string

+ SHA string

+ ShouldRemoveSourceBranch bool

+ Squash bool

+ type MergeRequestNote struct

+ Author *User

+ Body string

+ CreatedAt string

+ ID int

+ System bool

+ UpdatedAt string

+ type MergeRequestUpdateRequest struct

+ AddLabels string

+ AssigneeIDs []int

+ Description string

+ RemoveLabels string

+ StateEvent string

+ TargetBranch string

+ Title string

+ type Milestone struct

+ CreatedAt string

+ Description string

+ DueDate string

+ ID int

+ IID int

+ StartDate string

+ State string

+ Title string

+ UpdatedAt string

+ WebURL string

+ type MilestoneAPI struct

+ func (a *MilestoneAPI) Create(ctx context.Context, projectID string, opts MilestoneCreateOpts) (*Milestone, error)

+ func (a *MilestoneAPI) Delete(ctx context.Context, projectID string, milestoneID int) error

+ func (a *MilestoneAPI) GetByID(ctx context.Context, projectID string, milestoneID int) (*Milestone, error)

+ func (a *MilestoneAPI) List(ctx context.Context, projectID string, opts *MilestoneListOpts) ([]Milestone, error)

+ func (a *MilestoneAPI) Update(ctx context.Context, projectID string, milestoneID int, ...) (*Milestone, error)

+ type MilestoneCreateOpts struct

+ Description string

+ DueDate string

+ StartDate string

+ Title string

+ type MilestoneListOpts struct

+ Limit int

+ State string

+ type MilestoneUpdateOpts struct

+ Description string

+ DueDate string

+ StartDate string

+ StateEvent string

+ Title string

+ type Pagination struct

+ Link string

+ NextPage int

+ Page int

+ PerPage int

+ PrevPage int

+ Total int

+ TotalPages int

+ func PaginateGET(ctx context.Context, c *Client, path string, limit int) ([]byte, Pagination, error)

+ type Pipeline struct

+ CreatedAt string

+ ID int

+ IID int

+ ProjectID int

+ Ref string

+ SHA string

+ Source string

+ Status string

+ UpdatedAt string

+ User *User

+ WebURL string

+ type PipelineAPI struct

+ func (a *PipelineAPI) Cancel(ctx context.Context, projectID string, pipelineID int) (*Pipeline, error)

+ func (a *PipelineAPI) Create(ctx context.Context, projectID string, body PipelineCreateBody) (*Pipeline, error)

+ func (a *PipelineAPI) Get(ctx context.Context, projectID string, pipelineID int) (*Pipeline, error)

+ func (a *PipelineAPI) Jobs(ctx context.Context, projectID string, pipelineID int, scope []string) ([]Job, error)

+ func (a *PipelineAPI) List(ctx context.Context, projectID string, opts *PipelineListOpts) ([]Pipeline, error)

+ func (a *PipelineAPI) Retry(ctx context.Context, projectID string, pipelineID int) (*Pipeline, error)

+ type PipelineCreateBody struct

+ Ref string

+ Variables []PipelineVariable

+ type PipelineListOpts struct

+ Limit int

+ Ref string

+ Status string

+ Username string

+ type PipelineVariable struct

+ Key string

+ Value string

+ type Project struct

+ CreatedAt string

+ DefaultBranch string

+ Description string

+ ForksCount int

+ HTTPURLToRepo string

+ ID int

+ LastActivityAt string

+ Name string

+ PathWithNamespace string

+ SSHURLToRepo string

+ StarCount int

+ Visibility string

+ WebURL string

+ type ProjectAPI struct

+ func (a *ProjectAPI) Get(ctx context.Context, idOrPath string) (*Project, error)

+ func (a *ProjectAPI) List(ctx context.Context, opts *ProjectListOpts) ([]Project, error)

+ func (a *ProjectAPI) Members(ctx context.Context, idOrPath, query string, limit int) ([]ProjectMember, error)

+ type ProjectListOpts struct

+ Limit int

+ Membership bool

+ Owned bool

+ Search string

+ Visibility string

+ type ProjectMember struct

+ AccessLevel int

+ ID int

+ Name string

+ State string

+ Username string

+ WebURL string

+ type Release struct

+ Assets *ReleaseAssets

+ Author *User

+ Commit *Commit

+ CommitPath string

+ CreatedAt string

+ Description string

+ DescriptionHTML string

+ Milestones []interface{}

+ Name string

+ ReleasedAt string

+ TagName string

+ TagPath string

+ type ReleaseAPI struct

+ func (a *ReleaseAPI) Create(ctx context.Context, projectID string, body ReleaseCreateBody) (*Release, error)

+ func (a *ReleaseAPI) Delete(ctx context.Context, projectID, tagName string) error

+ func (a *ReleaseAPI) Get(ctx context.Context, projectID, tagName string) (*Release, error)

+ func (a *ReleaseAPI) List(ctx context.Context, projectID string, limit int) ([]Release, error)

+ func (a *ReleaseAPI) Update(ctx context.Context, projectID, tagName string, body ReleaseUpdateBody) (*Release, error)

+ type ReleaseAssets struct

+ Count int

+ Sources []struct{ ... }

+ type ReleaseCreateBody struct

+ Description string

+ Milestones []string

+ Name string

+ Ref string

+ TagName string

+ type ReleaseUpdateBody struct

+ Description string

+ Milestones []string

+ Name string

+ type RepoAPI struct

+ func (a *RepoAPI) CreateBranch(ctx context.Context, projectID, name, ref string) (*Branch, error)

+ func (a *RepoAPI) CreateFile(ctx context.Context, projectID, filePath string, body FileWriteBody) error

+ func (a *RepoAPI) DeleteBranch(ctx context.Context, projectID, name string) error

+ func (a *RepoAPI) DeleteFile(ctx context.Context, projectID, filePath, branch, commitMessage string) error

+ func (a *RepoAPI) GetCommit(ctx context.Context, projectID, sha string) (*Commit, error)

+ func (a *RepoAPI) GetFile(ctx context.Context, projectID, filePath, ref string) (*RepoFile, error)

+ func (a *RepoAPI) GetFileRaw(ctx context.Context, projectID, filePath, ref string) ([]byte, error)

+ func (a *RepoAPI) ListBranches(ctx context.Context, projectID string, opts *BranchListOpts) ([]Branch, error)

+ func (a *RepoAPI) ListCommits(ctx context.Context, projectID string, opts *CommitListOpts) ([]Commit, error)

+ func (a *RepoAPI) ListTree(ctx context.Context, projectID string, opts *TreeOpts) ([]TreeEntry, error)

+ func (a *RepoAPI) UpdateFile(ctx context.Context, projectID, filePath string, body FileWriteBody) error

+ type RepoFile struct

+ BlobID string

+ CommitID string

+ Content string

+ ContentSHA256 string

+ Encoding string

+ FileName string

+ FilePath string

+ LastCommitID string

+ Ref string

+ Size int

+ type SearchAPI struct

+ func (a *SearchAPI) Code(ctx context.Context, query, project string, limit int) ([]SearchBlob, error)

+ func (a *SearchAPI) Commits(ctx context.Context, query, project string, limit int) ([]SearchCommit, error)

+ func (a *SearchAPI) Issues(ctx context.Context, query, project string, limit int) ([]SearchIssue, error)

+ func (a *SearchAPI) MergeRequests(ctx context.Context, query, project string, limit int) ([]SearchMR, error)

+ func (a *SearchAPI) Projects(ctx context.Context, query string, limit int) ([]SearchProject, error)

+ type SearchBlob struct

+ Basename string

+ Data string

+ Filename string

+ Path string

+ ProjectID int

+ Ref string

+ StartLine int

+ type SearchCommit struct

+ AuthorName string

+ CreatedAt string

+ ID string

+ ProjectID int

+ ShortID string

+ Title string

+ WebURL string

+ type SearchIssue struct

+ ID int

+ IID int

+ ProjectID int

+ State string

+ Title string

+ WebURL string

+ type SearchMR struct

+ ID int

+ IID int

+ ProjectID int

+ State string

+ Title string

+ WebURL string

+ type SearchProject struct

+ DefaultBranch string

+ ID int

+ Name string

+ PathWithNamespace string

+ Visibility string

+ WebURL string

+ type TreeEntry struct

+ ID string

+ Mode string

+ Name string

+ Path string

+ Type string

+ type TreeOpts struct

+ Limit int

+ Path string

+ Recursive bool

+ Ref string

+ type User struct

+ AvatarURL string

+ Bot bool

+ Email string

+ ID int

+ Name string

+ State string

+ Username string

+ WebURL string

+ type UserAPI struct

+ func (a *UserAPI) GetByUsername(ctx context.Context, username string) (*User, error)

+ func (a *UserAPI) Me(ctx context.Context) (*User, error)

+ func (a *UserAPI) Search(ctx context.Context, query string, limit int) ([]User, error)

+ type Variable struct

+ Description string

+ EnvironmentScope string

+ Key string

+ Masked bool

+ Protected bool

+ Raw bool

+ Value string

+ VariableType string

+ type VariableAPI struct

+ func (a *VariableAPI) Create(ctx context.Context, projectID string, opts *VariableCreateOpts) (*Variable, error)

+ func (a *VariableAPI) Delete(ctx context.Context, projectID, key, envScope string) error

+ func (a *VariableAPI) Get(ctx context.Context, projectID, key, envScope string) (*Variable, error)

+ func (a *VariableAPI) List(ctx context.Context, projectID string, limit int) ([]Variable, error)

+ func (a *VariableAPI) Update(ctx context.Context, projectID, key, envScope string, opts *VariableUpdateOpts) (*Variable, error)

+ type VariableCreateOpts struct

+ Description string

+ EnvironmentScope string

+ Key string

+ Masked bool

+ Protected bool

+ Raw bool

+ Value string

+ VariableType string

+ type VariableUpdateOpts struct

+ Description string

+ EnvironmentScope string

+ Masked *bool

+ Protected *bool

+ Raw *bool

+ Value string

+ VariableType string

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