Categorygithub.com/weeyum/go-gitlab
modulepackage
0.31.0
Repository: https://github.com/weeyum/go-gitlab.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
22
Dependents
0
Files
16.6k SLOC

# README

go-gitlab

A GitLab API client enabling Go programs to interact with GitLab in a simple and uniform way

Build Status GitHub license Sourcegraph GoDoc Go Report Card GitHub issues

NOTE

Release v0.6.0 (released on 25-08-2017) no longer supports the older V3 Gitlab API. If you need V3 support, please use the f-api-v3 branch. This release contains some backwards incompatible changes that were needed to fully support the V4 Gitlab API.

Coverage

This API client package covers most of the existing Gitlab API calls and is updated regularly to add new and/or missing endpoints. Currently the following services are supported:

  • Award Emojis
  • Branches
  • Broadcast Messages
  • Commits
  • Container Registry
  • Custom Attributes
  • Deploy Keys
  • Deployments
  • Discussions (threaded comments)
  • Environments
  • Epic Issues
  • Epics
  • Events
  • Feature Flags
  • Geo Nodes
  • GitLab CI Config Templates
  • Gitignores Templates
  • Group Access Requests
  • Group Issue Boards
  • Group Members
  • Group Milestones
  • Group-Level Variables
  • Groups
  • Issue Boards
  • Issues
  • Jobs
  • Keys
  • Labels
  • License
  • Merge Request Approvals
  • Merge Requests
  • Namespaces
  • Notes (comments)
  • Notification Settings
  • Open Source License Templates
  • Pages Domains
  • Pipeline Schedules
  • Pipeline Triggers
  • Pipelines
  • Project Access Requests
  • Project Badges
  • Project Clusters
  • Project Import/export
  • Project Members
  • Project Milestones
  • Project Snippets
  • Project-Level Variables
  • Projects (including setting Webhooks)
  • Protected Branches
  • Protected Tags
  • Repositories
  • Repository Files
  • Runners
  • Search
  • Services
  • Settings
  • Sidekiq Metrics
  • System Hooks
  • Tags
  • Todos
  • Users
  • Validate CI Configuration
  • Version
  • Wikis

Usage

import "github.com/xanzy/go-gitlab"

Construct a new GitLab client, then use the various services on the client to access different parts of the GitLab API. For example, to list all users:

git := gitlab.NewClient(nil, "yourtokengoeshere")
//git.SetBaseURL("https://git.mydomain.com/api/v4")
users, _, err := git.Users.ListUsers(&gitlab.ListUsersOptions{})

Some API methods have optional parameters that can be passed. For example, to list all projects for user "svanharmelen":

git := gitlab.NewClient(nil)
opt := &ListProjectsOptions{Search: gitlab.String("svanharmelen")}
projects, _, err := git.Projects.ListProjects(opt)

Examples

The examples directory contains a couple for clear examples, of which one is partially listed here as well:

package main

import (
	"log"

	"github.com/xanzy/go-gitlab"
)

func main() {
	git := gitlab.NewClient(nil, "yourtokengoeshere")

	// Create new project
	p := &gitlab.CreateProjectOptions{
		Name:                 gitlab.String("My Project"),
		Description:          gitlab.String("Just a test project to play with"),
		MergeRequestsEnabled: gitlab.Bool(true),
		SnippetsEnabled:      gitlab.Bool(true),
		Visibility:           gitlab.Visibility(gitlab.PublicVisibility),
	}
	project, _, err := git.Projects.CreateProject(p)
	if err != nil {
		log.Fatal(err)
	}

	// Add a new snippet
	s := &gitlab.CreateProjectSnippetOptions{
		Title:           gitlab.String("Dummy Snippet"),
		FileName:        gitlab.String("snippet.go"),
		Code:            gitlab.String("package main...."),
		Visibility:      gitlab.Visibility(gitlab.PublicVisibility),
	}
	_, _, err = git.ProjectSnippets.CreateSnippet(project.ID, s)
	if err != nil {
		log.Fatal(err)
	}
}

For complete usage of go-gitlab, see the full package docs.

ToDo

  • The biggest thing this package still needs is tests :disappointed:

Issues

Author

Sander van Harmelen ([email protected])

License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

# Packages

No description provided by the author

# Functions

AccessLevel is a helper routine that allocates a new AccessLevelValue to store v and returns a pointer to it.
Bool is a helper routine that allocates a new bool value to store v and returns a pointer to it.
BuildState is a helper routine that allocates a new BuildStateValue to store v and returns a pointer to it.
CheckResponse checks the API response for errors, and returns them if present.
DeploymentStatus is a helper routine that allocates a new DeploymentStatusValue to store v and returns a pointer to it.
HookEventType returns the event type for the given request.
Int is a helper routine that allocates a new int32 value to store v and returns a pointer to it, but unlike Int32 its argument value is an int.
MergeMethod is a helper routine that allocates a new MergeMethod to sotre v and returns a pointer to it.
NewBasicAuthClient returns a new GitLab API client.
NewClient returns a new GitLab API client.
NewOAuthClient returns a new GitLab API client.
NotificationLevel is a helper routine that allocates a new NotificationLevelValue to store v and returns a pointer to it.
ParseHook tries to parse both web- and system hooks.
ParseSystemhook parses the event payload.
ParseWebhook parses the event payload.
ProjectCreationLevel is a helper routine that allocates a new ProjectCreationLevelValue to store v and returns a pointer to it.
String is a helper routine that allocates a new string value to store v and returns a pointer to it.
Stringify attempts to create a reasonable string representation of types in the GitHub library.
SubGroupCreationLevel is a helper routine that allocates a new SubGroupCreationLevelValue to store v and returns a pointer to it.
Time is a helper routine that allocates a new time.Time value to store v and returns a pointer to it.
VariableType is a helper routine that allocates a new VariableTypeValue to store v and returns a pointer to it.
Visibility is a helper routine that allocates a new VisibilityValue to store v and returns a pointer to it.
WebhookEventType returns the event type for the given request.
WithContext runs the request with the provided context.
WithSudo takes either a username or user ID and sets the SUDO request header.

# Constants

These constants represent all valid build states.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
These constants represent all valid build states.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of valid notification levels.
These constants represent all valid deployment statuses.
These constants represent all valid deployment statuses.
These constants represent all valid deployment statuses.
These constants represent all valid deployment statuses.
These constants represent all valid deployment statuses.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available project creation levels.
List of valid notification levels.
List of available variable types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available event types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
These constants represent all valid build states.
List of available merge type GitLab API docs: https://docs.gitlab.com/ce/api/projects.html#project-merge-method.
The available file actions.
The available file actions.
The available file actions.
The available file actions.
List of available variable types.
List of valid notification levels.
all possible values Badge Kind.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available visibility levels.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available project creation levels.
List of available sub group creation levels.
These constants represent all valid build states.
These are deprecated and should be removed in a future version.
List of valid notification levels.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of available merge type GitLab API docs: https://docs.gitlab.com/ce/api/projects.html#project-merge-method.
List of available project creation levels.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
List of available sub group creation levels.
List of valid notification levels.
These constants represent all valid build states.
List of available visibility levels.
all possible values Badge Kind.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of available visibility levels.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available merge type GitLab API docs: https://docs.gitlab.com/ce/api/projects.html#project-merge-method.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available access levels GitLab API docs: https://docs.gitlab.com/ce/permissions/permissions.html.
These constants represent all valid build states.
These constants represent all valid build states.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
These constants represent all valid build states.
The available todo actions.
The available todo actions.
The available todo actions.
The available todo actions.
The available todo actions.
The available todo actions.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#action-types.
List of available action type GitLab API docs: https://docs.gitlab.com/ce/api/events.html#target-types.
List of valid notification levels.
The available wiki formats.
The available wiki formats.
The available wiki formats.

# Variables

List a couple of standard errors.
List a couple of standard errors.
List a couple of standard errors.
List a couple of standard errors.
List a couple of standard errors.

# Structs

AcceptMergeRequestOptions represents the available AcceptMergeRequest() options.
AccessRequest represents a access request for a group or project.
AccessRequestsService handles communication with the project/group access requests related methods of the GitLab API.
AddClusterOptions represents the available AddCluster() options.
AddCommitDiscussionNoteOptions represents the available AddCommitDiscussionNote() options.
AddDeployKeyOptions represents the available ADDDeployKey() options.
AddEmailOptions represents the available AddEmail() options.
AddEpicDiscussionNoteOptions represents the available AddEpicDiscussionNote() options.
AddGroupBadgeOptions represents the available AddGroupBadge() options.
AddGroupClusterOptions represents the available AddCluster() options.
AddGroupHookOptions represents the available AddGroupHook() options.
AddGroupMemberOptions represents the available AddGroupMember() options.
AddGroupPlatformKubernetesOptions represents the available PlatformKubernetes options for adding.
AddHookOptions represents the available AddHook() options.
AddIssueDiscussionNoteOptions represents the available AddIssueDiscussionNote() options.
AddLicenseOptions represents the available AddLicense() options.
AddMergeRequestDiscussionNoteOptions represents the available AddMergeRequestDiscussionNote() options.
AddPipelineTriggerOptions represents the available AddPipelineTrigger() options.
AddPlatformKubernetesOptions represents the available PlatformKubernetes options for adding.
AddProjectBadgeOptions represents the available AddProjectBadge() options.
AddProjectHookOptions represents the available AddProjectHook() options.
AddProjectMemberOptions represents the available AddProjectMember() options.
AddProjectPushRuleOptions represents the available AddProjectPushRule() options.
AddSnippetDiscussionNoteOptions represents the available AddSnippetDiscussionNote() options.
AddSpentTimeOptions represents the available AddSpentTime() options.
AddSSHKeyOptions represents the available AddSSHKey() options.
ApproveAccessRequestOptions represents the available ApproveProjectAccessRequest() and ApproveGroupAccessRequest() options.
ApproveMergeRequestOptions represents the available ApproveMergeRequest() options.
ArchiveOptions represents the available Archive() options.
Author represents a GitLab commit author.
AwardEmoji represents a GitLab Award Emoji.
AwardEmojiService handles communication with the emoji awards related methods of the GitLab API.
BaseSystemEvent contains system hook's common properties.
BasicUser included in other service responses (such as merge requests, pipelines, etc).
Blob represents a single blob.
BoardList represents a GitLab board list.
Branch represents a GitLab branch.
BranchAccessDescription represents the access description for a protected branch.
BranchesService handles communication with the branch related methods of the GitLab API.
BroadcastMessage represents a GitLab issue board.
BroadcastMessagesService handles communication with the broadcast messages methods of the GitLab API.
BuildEvent represents a build event GitLab API docs: https://docs.gitlab.com/ce/user/project/integrations/webhooks.html#build-events.
ChangeAllowedApproversOptions represents the available ChangeAllowedApprovers() options.
ChangeApprovalConfigurationOptions represents the available ApprovalConfiguration() options.
ChangeMergeRequestAllowedApproversOptions represents the available ChangeMergeRequestAllowedApprovers() options.
ChangeMergeRequestApprovalConfigurationOptions represents the available ChangeMergeRequestApprovalConfiguration() options.
CherryPickCommitOptions represents the available CherryPickCommit() options.
CIYMLTemplate represents a GitLab CI YML template.
CIYMLTemplatesService handles communication with the gitlab CI YML templates related methods of the GitLab API.
A Client manages communication with the GitLab API.
Commit represents a GitLab commit.
CommitAction represents a single file action within a commit.
CommitComment represents a GitLab commit comment.
CommitCommentEvent represents a comment on a commit event.
CommitRef represents the reference of branches/tags in a commit.
CommitsService handles communication with the commit related methods of the GitLab API.
CommitStats represents the number of added and deleted files in a commit.
CommitStatus represents a GitLab commit status.
Compare represents the result of a comparison of branches, tags or commits.
CompareOptions represents the available Compare() options.
CompoundMetrics represents the GitLab sidekiq compounded stats.
ContainerRegistryService handles communication with the container registry related methods of the GitLab API.
ContributionEvent represents a user's contribution GitLab API docs: https://docs.gitlab.com/ce/api/events.html#get-user-contribution-events.
Contributor represents a GitLap contributor.
CreateAwardEmojiOptions represents the available options for awarding emoji for a resource GitLab API docs: https://docs.gitlab.com/ce/api/award_emoji.html#award-a-new-emoji.
CreateBranchOptions represents the available CreateBranch() options.
CreateBroadcastMessageOptions represents the available CreateBroadcastMessage() options.
CreateCommitDiscussionOptions represents the available CreateCommitDiscussion() options.
CreateCommitOptions represents the available options for a new commit.
CreateEnvironmentOptions represents the available CreateEnvironment() options.
CreateEpicDiscussionOptions represents the available CreateEpicDiscussion() options.
CreateEpicNoteOptions represents the available CreateEpicNote() options.
CreateEpicOptions represents the available CreateEpic() options.
CreateFileOptions represents the available CreateFile() options.
CreateGroupDeployTokenOptions represents the available CreateGroupDeployToken() options.
CreateGroupIssueBoardListOptions represents the available CreateGroupIssueBoardList() options.
CreateGroupIssueBoardOptions represents the available CreateGroupIssueBoard() options.
CreateGroupMilestoneOptions represents the available CreateGroupMilestone() options.
CreateGroupOptions represents the available CreateGroup() options.
CreateGroupVariableOptions represents the available CreateVariable() options.
CreateImpersonationTokenOptions represents the available CreateImpersonationToken() options.
CreateIssueBoardListOptions represents the available CreateIssueBoardList() options.
CreateIssueBoardOptions represents the available CreateIssueBoard() options.
CreateIssueDiscussionOptions represents the available CreateIssueDiscussion() options.
CreateIssueLinkOptions represents the available CreateIssueLink() options.
CreateIssueNoteOptions represents the available CreateIssueNote() options.
CreateIssueOptions represents the available CreateIssue() options.
CreateLabelOptions represents the available CreateLabel() options.
CreateMergeRequestApprovalRuleOptions represents the available CreateApprovalRule() options.
CreateMergeRequestDiscussionOptions represents the available CreateMergeRequestDiscussion() options.
CreateMergeRequestNoteOptions represents the available CreateMergeRequestNote() options.
CreateMergeRequestOptions represents the available CreateMergeRequest() options.
CreateMilestoneOptions represents the available CreateMilestone() options.
CreatePagesDomainOptions represents the available CreatePagesDomain() options.
CreatePipelineOptions represents the available CreatePipeline() options.
CreatePipelineScheduleOptions represents the available CreatePipelineSchedule() options.
CreatePipelineScheduleVariableOptions represents the available CreatePipelineScheduleVariable() options.
CreateProjectDeploymentOptions represents the available CreateProjectDeployment() options.
CreateProjectDeployTokenOptions represents the available CreateProjectDeployToken() options.
CreateProjectLevelRuleOptions represents the available CreateProjectApprovalRule() options.
CreateProjectOptions represents the available CreateProject() options.
CreateProjectSnippetOptions represents the available CreateSnippet() options.
CreateProjectVariableOptions represents the available CreateVariable() options.
CreateReleaseLinkOptions represents CreateReleaseLink() options.
CreateReleaseNoteOptions represents the available CreateReleaseNote() options.
CreateReleaseOptions represents CreateRelease() options.
CreateSnippetDiscussionOptions represents the available CreateSnippetDiscussion() options.
CreateSnippetNoteOptions represents the available CreateSnippetNote() options.
CreateSnippetOptions represents the available CreateSnippet() options.
CreateTagOptions represents the available CreateTag() options.
CreateUserOptions represents the available CreateUser() options.
CreateWikiPageOptions represents options to CreateWikiPage.
CustomAttribute struct is used to unmarshal response to api calls.
CustomAttributesService handles communication with the group, project and user custom attributes related methods of the GitLab API.
CustomIssueTrackerService represents Custom Issue Tracker service settings.
CustomIssueTrackerServiceProperties represents Custom Issue Tracker specific properties.
DeleteFileOptions represents the available DeleteFile() options.
DeleteLabelOptions represents the available DeleteLabel() options.
DeleteRegisteredRunnerOptions represents the available DeleteRegisteredRunner() options.
DeleteRegistryRepositoryTagsOptions represents the available DeleteRegistryRepositoryTags() options.
DeployKey represents a GitLab deploy key.
DeployKeysService handles communication with the keys related methods of the GitLab API.
Deployment represents the Gitlab deployment.
DeploymentsService handles communication with the deployment related methods of the GitLab API.
DeployToken represents a GitLab deploy token.
DeployTokensService handles communication with the deploy tokens related methods of the GitLab API.
DetailedStatus contains detailed information about the status of a pipeline.
Diff represents a GitLab diff.
Discussion represents a GitLab discussion.
DiscussionsService handles communication with the discussions related methods of the GitLab API.
DownloadArtifactsFileOptions represents the available DownloadArtifactsFile() options.
DroneCIService represents Drone CI service settings.
DroneCIServiceProperties represents Drone CI specific properties.
EditClusterOptions represents the available EditCluster() options.
EditEnvironmentOptions represents the available EditEnvironment() options.
EditGroupBadgeOptions represents the available EditGroupBadge() options.
EditGroupClusterOptions represents the available EditCluster() options.
EditGroupMemberOptions represents the available EditGroupMember() options.
EditGroupPlatformKubernetesOptions represents the available PlatformKubernetes options for editing.
EditPipelineScheduleOptions represents the available EditPipelineSchedule() options.
EditPipelineScheduleVariableOptions represents the available EditPipelineScheduleVariable() options.
EditPipelineTriggerOptions represents the available EditPipelineTrigger() options.
EditPlatformKubernetesOptions represents the available PlatformKubernetes options for editing.
EditProjectBadgeOptions represents the available EditProjectBadge() options.
EditProjectHookOptions represents the available EditProjectHook() options.
EditProjectMemberOptions represents the available EditProjectMember() options.
EditProjectOptions represents the available EditProject() options.
EditProjectPushRuleOptions represents the available EditProjectPushRule() options.
EditWikiPageOptions represents options to EditWikiPage.
Email represents an Email.
EnableProjectRunnerOptions represents the available EnableProjectRunner() options.
Environment represents a GitLab environment.
EnvironmentsService handles communication with the environment related methods of the GitLab API.
Epic represents a GitLab epic.
EpicAuthor represents a author of the epic.
EpicsService handles communication with the epic related methods of the GitLab API.
An ErrorResponse reports one or more errors caused by an API request.
EventsService handles communication with the event related methods of the GitLab API.
ExportStatus represents a project export status.
ExternalWikiService represents External Wiki service settings.
ExternalWikiServiceProperties represents External Wiki specific properties.
Feature represents a GitLab feature flag.
FeaturesService handles the communication with the application FeaturesService related methods of the GitLab API.
File represents a GitLab repository file.
FileInfo represents file details of a GitLab repository file.
ForkParent represents the parent project when this is a fork.
ForkProjectOptions represents the available ForkProject() options.
Gate represents a gate of a GitLab feature flag.
GetAllImpersonationTokensOptions represents the available GetAllImpersonationTokens() options.
GetCommitRefsOptions represents the available GetCommitRefs() options.
GetCommitStatusesOptions represents the available GetCommitStatuses() options.
GetFileMetaDataOptions represents the available GetFileMetaData() options.
GetFileOptions represents the available GetFile() options.
GetLicenseTemplateOptions represents the available GetLicenseTemplate() options.
GetMergeRequestsOptions represents the available GetMergeRequests() options.
GetProjectOptions represents the available GetProject() options.
GetRawFileOptions represents the available GetRawFile() options.
GetUserActivitiesOptions represents the options for GetUserActivities GitLap API docs: https://docs.gitlab.com/ce/api/users.html#get-user-activities-admin-only.
GithubService represents Github service settings.
GithubServiceProperties represents Github specific properties.
GitIgnoreTemplate represents a GitLab gitignore template.
GitIgnoreTemplatesService handles communication with the gitignore templates related methods of the GitLab API.
GPGSignature represents a Gitlab commit's GPG Signature.
Group represents a GitLab group.
GroupAccess represents group access.
GroupBadge represents a group badge.
GroupBadgePreviewOptions represents the available PreviewGroupBadge() options.
GroupBadgesService handles communication with the group badges GitLab API docs: https://docs.gitlab.com/ee/api/group_badges.html.
GroupCluster represents a GitLab Group Cluster.
GroupClustersService handles communication with the group clusters related methods of the GitLab API.
GroupHook represents a GitLab group hook.
GroupIssueBoard represents a GitLab group issue board.
GroupIssueBoardsService handles communication with the group issue board related methods of the GitLab API.
GroupLabelsService handles communication with the label related methods of the GitLab API.
GroupMember represents a GitLab group member.
GroupMemberSAMLIdentity represents the SAML Identity link for the group member.
GroupMembersService handles communication with the group members related methods of the GitLab API.
GroupMilestone represents a GitLab milestone.
GroupMilestonesService handles communication with the milestone related methods of the GitLab API.
GroupsService handles communication with the group related methods of the GitLab API.
GroupSystemEvent represents a group system event.
GroupVariable represents a GitLab group Variable.
GroupVariablesService handles communication with the group variables related methods of the GitLab API.
Hook represents a GitLap system hook.
HookEvent represents an event trigger by a GitLab system hook.
ImpersonationToken represents an impersonation token.
ImportFileOptions represents the available ImportFile() options.
ImportStatus represents a project import status.
Issue represents a GitLab issue.
IssueAssignee represents a assignee of the issue.
IssueAuthor represents a author of the issue.
IssueBoard represents a GitLab issue board.
IssueBoardsService handles communication with the issue board related methods of the GitLab API.
IssueCommentEvent represents a comment on an issue event.
IssueEvent represents a issue event.
IssueLink represents a two-way relation between two issues.
IssueLinks represents links of the issue.
IssueLinksService handles communication with the issue relations related methods of the GitLab API.
IssueReferences represents references of the issue.
IssuesService handles communication with the issue related methods of the GitLab API.
JenkinsCIService represents Jenkins CI service settings.
JenkinsCIServiceProperties represents Jenkins CI specific properties.
JiraService represents Jira service settings.
JiraServiceProperties represents Jira specific properties.
Job represents a ci build.
JobEvent represents a job event.
JobsService handles communication with the ci builds related methods of the GitLab API.
JobStats represents the GitLab sidekiq job stats.
Key represents a GitLab user's SSH key.
KeysService handles communication with the keys related methods of the GitLab API.
KeySystemEvent represents a key system event.
Label represents a GitLab label.
LabelEvent represents a resource label event.
LabelsService handles communication with the label related methods of the GitLab API.
License represents a GitLab license.
LicenseService handles communication with the license related methods of the GitLab API.
LicenseTemplate represents a license template.
LicenseTemplatesService handles communication with the license templates related methods of the GitLab API.
Links represents a project web links for self, issues, merge_requests, repo_branches, labels, events, members.
LintResult represents the linting results.
ListBranchesOptions represents the available ListBranches() options.
ListCommitsOptions represents the available ListCommits() options.
ListContributionEventsOptions represents the options for GetUserContributionEvents GitLap API docs: https://docs.gitlab.com/ce/api/events.html#get-user-contribution-events.
ListContributorsOptions represents the available ListContributors() options.
ListEpicNotesOptions represents the available ListEpicNotes() options.
ListGroupEpicsOptions represents the available ListGroupEpics() options.
ListGroupIssuesOptions represents the available ListGroupIssues() options.
ListGroupMembersOptions represents the available ListGroupMembers() and ListAllGroupMembers() options.
ListGroupMergeRequestsOptions represents the available ListGroupMergeRequests() options.
ListGroupMilestonesOptions represents the available ListGroupMilestones() options.
ListGroupProjectsOptions represents the available ListGroupProjects() options.
ListGroupsOptions represents the available ListGroups() options.
ListIssueNotesOptions represents the available ListIssueNotes() options.
ListIssuesOptions represents the available ListIssues() options.
ListJobsOptions are options for two list apis.
ListLabelEventsOptions represents the options for all resource label events list methods.
ListLicenseTemplatesOptions represents the available ListLicenseTemplates() options.
ListMergeRequestNotesOptions represents the available ListMergeRequestNotes() options.
ListMergeRequestsOptions represents the available ListMergeRequests() options.
ListMilestonesOptions represents the available ListMilestones() options.
ListNamespacesOptions represents the available ListNamespaces() options.
ListOptions specifies the optional parameters to various List methods that support pagination.
ListProjectDeploymentsOptions represents the available ListProjectDeployments() options.
ListProjectIssuesOptions represents the available ListProjectIssues() options.
ListProjectMembersOptions represents the available ListProjectMembers() and ListAllProjectMembers() options.
ListProjectMergeRequestsOptions represents the available ListMergeRequests() options.
ListProjectPipelinesOptions represents the available ListProjectPipelines() options.
ListProjectsOptions represents the available ListProjects() options.
ListProjectUserOptions represents the available ListProjectsUsers() options.
ListRunnerJobsOptions represents the available ListRunnerJobs() options.
ListRunnersOptions represents the available ListRunners() options.
ListSnippetNotesOptions represents the available ListSnippetNotes() options.
ListTagsOptions represents the available ListTags() options.
ListTodosOptions represents the available ListTodos() options.
ListTreeOptions represents the available ListTree() options.
ListUsersOptions represents the available ListUsers() options.
ListWikisOptions represents the available ListWikis options.
MergeAssignee represents a merge assignee.
MergeBaseOptions represents the available MergeBase() options.
MergeCommentEvent represents a comment on a merge event.
MergeEvent represents a merge event.
MergeParams represents the merge params.
MergeRequest represents a GitLab merge request.
MergeRequestApprovalRule represents a GitLab merge request approval rule.
MergeRequestApprovals represents GitLab merge request approvals.
MergeRequestApprovalsService handles communication with the merge request approvals related methods of the GitLab API.
MergeRequestApprovalState represents a GitLab merge request approval state.
MergeRequestApproverGroup represents GitLab project level merge request approver group.
MergeRequestApproverUser represents GitLab project level merge request approver user.
MergeRequestDiffVersion represents Gitlab merge request version.
MergeRequestsService handles communication with the merge requests related methods of the GitLab API.
MicrosoftTeamsService represents Microsoft Teams service settings.
MicrosoftTeamsServiceProperties represents Microsoft Teams specific properties.
Milestone represents a GitLab milestone.
MilestonesService handles communication with the milestone related methods of the GitLab API.
ModifyUserOptions represents the available ModifyUser() options.
MoveIssueOptions represents the available MoveIssue() options.
Namespace represents a GitLab namespace.
NamespacesService handles communication with the namespace related methods of the GitLab API.
Note represents a GitLab note.
NotePosition represents the position attributes of a note.
NotesService handles communication with the notes related methods of the GitLab API.
NotificationEvents represents the available notification setting events.
NotificationSettings represents the Gitlab notification setting.
NotificationSettingsOptions represents the available options that can be passed to the API when updating the notification settings.
NotificationSettingsService handles communication with the notification settings related methods of the GitLab API.
PagesDomain represents a pages domain.
PagesDomainsService handles communication with the pages domains related methods of the GitLab API.
Permissions represents permissions.
Pipeline represents a GitLab pipeline.
PipelineEvent represents a pipeline event.
PipelineInfo shows the basic entities of a pipeline, mostly used as fields on other assets, like Commit.
PipelineSchedule represents a pipeline schedule.
PipelineSchedulesService handles communication with the pipeline schedules related methods of the GitLab API.
PipelinesEmailProperties represents PipelinesEmail specific properties.
PipelinesEmailService represents Pipelines Email service settings.
PipelinesService handles communication with the repositories related methods of the GitLab API.
PipelineTrigger represents a project pipeline trigger.
PipelineTriggersService handles Project pipeline triggers.
PipelineVariable represents a pipeline variable.
PlatformKubernetes represents a GitLab Project Cluster PlatformKubernetes.
PostCommitCommentOptions represents the available PostCommitComment() options.
ProcessMetrics represents the GitLab sidekiq process metrics.
Project represents a GitLab project.
ProjectAccess represents project access.
ProjectApprovalRule represents a GitLab project approval rule.
ProjectApprovals represents GitLab project level merge request approvals.
ProjectBadge represents a project badge.
ProjectBadgePreviewOptions represents the available PreviewProjectBadge() options.
ProjectBadgesService handles communication with the project badges related methods of the GitLab API.
ProjectCluster represents a GitLab Project Cluster.
ProjectClustersService handles communication with the project clusters related methods of the GitLab API.
ProjectEvent represents a GitLab project event.
ProjectFile represents an uploaded project file GitLab API docs: https://docs.gitlab.com/ce/api/projects.html#upload-a-file.
ProjectForkRelation represents a project fork relationship.
ProjectHook represents a project hook.
ProjectImportExportService handles communication with the project import/export related methods of the GitLab API.
ProjectMember represents a project member.
ProjectMembersService handles communication with the project members related methods of the GitLab API.
ProjectNamespace represents a project namespace.
ProjectPushRules represents a project push rule.
ProjectSnippetsService handles communication with the project snippets related methods of the GitLab API.
ProjectsService handles communication with the repositories related methods of the GitLab API.
ProjectStatistics represents a statistics record for a project.
ProjectSystemEvent represents a project system event.
ProjectUser represents a GitLab project user.
ProjectVariable represents a GitLab Project Variable.
ProjectVariablesService handles communication with the project variables related methods of the GitLab API.
ProtectBranchOptions represents the available ProtectBranch() options.
ProtectedBranch represents a protected branch.
ProtectedBranchesService handles communication with the protected branch related methods of the GitLab API.
ProtectedTag represents a protected tag.
ProtectedTagsService handles communication with the protected tag methods of the GitLab API.
ProtectRepositoryBranchesOptions represents the available ProtectRepositoryBranches() options.
ProtectRepositoryTagsOptions represents the available ProtectRepositoryTags() options.
PushEvent represents a push event.
PushSystemEvent represents a push system event.
QueueMetrics represents the GitLab sidekiq queue metrics.
RegisterNewRunnerOptions represents the available RegisterNewRunner() options.
RegistryRepository represents a GitLab content registry repository.
RegistryRepositoryTag represents a GitLab registry image tag.
Release represents a project release.
ReleaseAssetLink represents release asset link in CreateRelease() options GitLab API docs: https://docs.gitlab.com/ce/api/releases/index.html#create-a-release.
ReleaseAssets represents release assets in CreateRelease() options GitLab API docs: https://docs.gitlab.com/ce/api/releases/index.html#create-a-release.
ReleaseLink represents a release link.
ReleaseLinksService handles communication with the release link methods of the GitLab API.
ReleaseNote represents a GitLab version release.
ReleasesService handles communication with the releases methods of the GitLab API.
RepositoriesService handles communication with the repositories related methods of the GitLab API.
Repository represents a repository.
RepositoryFilesService handles communication with the repository files related methods of the GitLab API.
RepositoryUpdateSystemEvent represents a repository updated system event.
RequireCodeOwnerApprovalsOptions represents the available RequireCodeOwnerApprovals() options.
ResolveMergeRequestDiscussionOptions represents the available ResolveMergeRequestDiscussion() options.
ResourceLabelEventsService handles communication with the event related methods of the GitLab API.
Response is a GitLab API response.
RevertCommitOptions represents the available RevertCommit() options.
Runner represents a GitLab CI Runner.
RunnerDetails represents the GitLab CI runner details.
RunnersService handles communication with the runner related methods of the GitLab API.
RunPipelineTriggerOptions represents the available RunPipelineTrigger() options.
ScheduleExportOptions represents the available ScheduleExport() options.
SearchService handles communication with the search related methods of the GitLab API.
Service represents a GitLab service.
ServicesService handles communication with the services related methods of the GitLab API.
SetCommitStatusOptions represents the available SetCommitStatus() options.
SetCustomIssueTrackerServiceOptions represents the available SetCustomIssueTrackerService() options.
SetDroneCIServiceOptions represents the available SetDroneCIService() options.
SetExternalWikiServiceOptions represents the available SetExternalWikiService() options.
SetGithubServiceOptions represents the available SetGithubService() options.
SetGitLabCIServiceOptions represents the available SetGitLabCIService() options.
SetHipChatServiceOptions represents the available SetHipChatService() options.
SetJenkinsCIServiceOptions represents the available SetJenkinsCIService() options.
SetJiraServiceOptions represents the available SetJiraService() options.
SetMicrosoftTeamsServiceOptions represents the available SetMicrosoftTeamsService() options.
SetPipelinesEmailServiceOptions represents the available SetPipelinesEmailService() options.
SetSlackServiceOptions represents the available SetSlackService() options.
SetTimeEstimateOptions represents the available SetTimeEstimate() options.
Settings represents the GitLab application settings.
SettingsService handles communication with the application SettingsService related methods of the GitLab API.
ShareWithGroupOptions represents options to share project with groups GitLab API docs: https://docs.gitlab.com/ce/api/projects.html#share-project-with-group.
SidekiqService handles communication with the sidekiq service GitLab API docs: https://docs.gitlab.com/ce/api/sidekiq_metrics.html.
SlackService represents Slack service settings.
SlackServiceProperties represents Slack specific properties.
Snippet represents a GitLab snippet.
SnippetCommentEvent represents a comment on a snippet event.
SnippetsService handles communication with the snippets related methods of the GitLab API.
SSHKey represents a SSH key.
StorageStatistics represents a statistics record for a group or project.
SystemHooksService handles communication with the system hooks related methods of the GitLab API.
Tag represents a GitLab tag.
TagAccessDescription reperesents the access decription for a protected tag.
TagEvent represents a tag event.
TagPushSystemEvent represents a tag push system event.
TagsService handles communication with the tags related methods of the GitLab API.
TimeStats represents the time estimates and time spent for an issue.
Todo represents a GitLab todo.
TodosService handles communication with the todos related methods of the Gitlab API.
TodoTarget represents a todo target of type Issue or MergeRequest.
TransferProjectOptions represents the available TransferProject() options.
TreeNode represents a GitLab repository file or directory.
UpdateBroadcastMessageOptions represents the available CreateBroadcastMessage() options.
UpdateCommitDiscussionNoteOptions represents the available UpdateCommitDiscussion() options.
UpdateEpicDiscussionNoteOptions represents the available UpdateEpicDiscussion() options.
UpdateEpicNoteOptions represents the available UpdateEpicNote() options.
UpdateEpicOptions represents the available UpdateEpic() options.
UpdateFileOptions represents the available UpdateFile() options.
UpdateGroupIssueBoardListOptions represents the available UpdateGroupIssueBoardList() options.
UpdateGroupIssueBoardOptions represents a group issue board.
UpdateGroupMilestoneOptions represents the available UpdateGroupMilestone() options.
UpdateGroupVariableOptions represents the available UpdateVariable() options.
UpdateIssueBoardListOptions represents the available UpdateIssueBoardList() options.
UpdateIssueBoardOptions represents the available UpdateIssueBoard() options.
UpdateIssueDiscussionNoteOptions represents the available UpdateIssueDiscussion() options.
UpdateIssueNoteOptions represents the available UpdateIssueNote() options.
UpdateIssueOptions represents the available UpdateIssue() options.
UpdateLabelOptions represents the available UpdateLabel() options.
UpdateMergeRequestApprovalRuleOptions represents the available UpdateApprovalRule() options.
UpdateMergeRequestDiscussionNoteOptions represents the available UpdateMergeRequestDiscussion() options.
UpdateMergeRequestNoteOptions represents the available UpdateMergeRequestNote() options.
UpdateMergeRequestOptions represents the available UpdateMergeRequest() options.
UpdateMilestoneOptions represents the available UpdateMilestone() options.
UpdatePagesDomainOptions represents the available UpdatePagesDomain() options.
UpdateProjectDeploymentOptions represents the available UpdateProjectDeployment() options.
UpdateProjectLevelRuleOptions represents the available UpdateProjectApprovalRule() options.
UpdateProjectSnippetOptions represents the available UpdateSnippet() options.
UpdateProjectVariableOptions represents the available UpdateVariable() options.
UpdateReleaseLinkOptions represents UpdateReleaseLink() options.
UpdateReleaseNoteOptions represents the available UpdateReleaseNote() options.
UpdateReleaseOptions represents UpdateRelease() options.
UpdateRunnerDetailsOptions represents the available UpdateRunnerDetails() options.
UpdateSettingsOptions represents the available UpdateSettings() options.
UpdateSnippetDiscussionNoteOptions represents the available UpdateSnippetDiscussion() options.
UpdateSnippetNoteOptions represents the available UpdateSnippetNote() options.
UpdateSnippetOptions represents the available UpdateSnippet() options.
User represents a GitLab user.
UserActivity represents an entry in the user/activities response GitLab API docs: https://docs.gitlab.com/ce/api/users.html#get-user-activities-admin-only.
UserGroupSystemEvent represents a user group system event.
UserIdentity represents a user identity.
UsersService handles communication with the user related methods of the GitLab API.
UserStatus represents the current status of a user GitLab API docs: https://docs.gitlab.com/ce/api/users.html#user-status.
UserStatusOptions represents the options required to set the status GitLab API docs: https://docs.gitlab.com/ce/api/users.html#set-user-status.
UserSystemEvent represents a user system event.
UserTeamSystemEvent represents a user team system event.
ValidateService handles communication with the validation related methods of the GitLab API.
VerifyRegisteredRunnerOptions represents the available VerifyRegisteredRunner() options.
Version represents a GitLab instance version.
VersionService handles communication with the GitLab server instance to retrieve its version information via the GitLab API.
Wiki represents a GitLab wiki.
WikiPageEvent represents a wiki page event.
WikisService handles communication with the wikis related methods of the Gitlab API.

# Type aliases

AccessLevelValue represents a permission level within GitLab.
BadgeKind represents a GitLab Badge Kind.
BoolValue is a boolean value with advanced json unmarshaling features.
BuildStateValue represents a GitLab build state.
CreateGroupLabelOptions represents the available CreateGroupLabel() options.
CreateProjectForUserOptions represents the available CreateProjectForUser() options.
DeleteGroupLabelOptions represents the available DeleteGroupLabel() options.
DeploymentStatusValue represents a Gitlab deployment status.
EventTargetTypeValue represents actions type value for contribution events.
EventType represents a Gitlab event type.
EventTypeValue represents actions type for contribution events.
ExploreSnippetsOptions represents the available ExploreSnippets() options.
FileAction represents the available actions that can be performed on a file.
GetCommitCommentsOptions represents the available GetCommitComments() options.
GetCommitDiffOptions represents the available GetCommitDiff() options.
GetGroupMilestoneIssuesOptions represents the available GetGroupMilestoneIssues() options.
GetGroupMilestoneMergeRequestsOptions represents the available GetGroupMilestoneMergeRequests() options.
GetIssueBoardListsOptions represents the available GetIssueBoardLists() options.
GetIssuesClosedOnMergeOptions represents the available GetIssuesClosedOnMerge() options.
GetMergeRequestCommitsOptions represents the available GetMergeRequestCommits() options.
GetMergeRequestDiffVersionsOptions represents the available GetMergeRequestDiffVersions() options.
GetMilestoneIssuesOptions represents the available GetMilestoneIssues() options.
GetMilestoneMergeRequestsOptions represents the available GetMilestoneMergeRequests() options.
GetProjectEventsOptions represents the available GetProjectEvents() options.
GroupLabel represents a GitLab group label.
ISOTime represents an ISO 8601 formatted date.
Labels is a custom type with specific marshaling characteristics.
ListAccessRequestsOptions represents the available ListProjectAccessRequests() or ListGroupAccessRequests() options.
ListAwardEmojiOptions represents the available options for listing emoji for each resources GitLab API docs: https://docs.gitlab.com/ce/api/award_emoji.html.
ListBroadcastMessagesOptions represents the available ListBroadcastMessages() options.
ListCIYMLTemplatesOptions represents the available ListAllTemplates() options.
ListCommitDiscussionsOptions represents the available ListCommitDiscussions() options.
ListEmailsForUserOptions represents the available ListEmailsForUser() options.
ListEnvironmentsOptions represents the available ListEnvironments() options.
ListGroupBadgesOptions represents the available ListGroupBadges() options.
ListGroupDeployTokensOptions represents the available ListGroupDeployTokens() options.
ListGroupEpicDiscussionsOptions represents the available ListEpicDiscussions() options.
ListGroupIssueBoardListsOptions represents the available ListGroupIssueBoardLists() options.
ListGroupIssueBoardsOptions represents the available ListGroupIssueBoards() options.
ListGroupLabelsOptions represents the available ListGroupLabels() options.
ListGroupVariablesOptions represents the available options for listing variables for a group.
ListIssueBoardsOptions represents the available ListIssueBoards() options.
ListIssueDiscussionsOptions represents the available ListIssueDiscussions() options.
ListLabelsOptions represents the available ListLabels() options.
ListMergeRequestDiscussionsOptions represents the available ListMergeRequestDiscussions() options.
ListMergeRequestsClosingIssueOptions represents the available ListMergeRequestsClosingIssue() options.
ListMergeRequestsRelatedToIssueOptions represents the available ListMergeRequestsRelatedToIssue() options.
ListPagesDomainsOptions represents the available ListPagesDomains() options.
ListPipelineSchedulesOptions represents the available ListPipelineTriggers() options.
ListPipelineTriggersOptions represents the available ListPipelineTriggers() options.
ListProjectBadgesOptions represents the available ListProjectBadges() options.
ListProjectDeployKeysOptions represents the available ListProjectDeployKeys() options.
ListProjectDeployTokensOptions represents the available ListProjectDeployTokens() options.
ListProjectHooksOptions represents the available ListProjectHooks() options.
ListProjectRunnersOptions represents the available ListProjectRunners() options.
ListProjectSnippetsOptions represents the available ListSnippets() options.
ListProjectVariablesOptions represents the available options for listing variables in a project.
ListProtectedBranchesOptions represents the available ListProtectedBranches() options.
ListProtectedTagsOptions represents the available ListProtectedTags() options.
ListRegistryRepositoriesOptions represents the available ListRegistryRepositories() options.
ListRegistryRepositoryTagsOptions represents the available ListRegistryRepositoryTags() options.
ListReleaseLinksOptions represents ListReleaseLinks() options.
ListReleasesOptions represents ListReleases() options.
ListSnippetDiscussionsOptions represents the available ListSnippetDiscussions() options.
ListSnippetsOptions represents the available ListSnippets() options.
ListSSHKeysForUserOptions represents the available ListSSHKeysForUser() options.
ListSubgroupsOptions represents the available ListSubgroupsOptions() options.
ListTemplatesOptions represents the available ListAllTemplates() options.
MergeMethodValue represents a project merge type within GitLab.
NotificationLevelValue represents a notification level.
OptionFunc can be passed to all API requests to make the API call as if you were another user, provided your private token is from an administrator account.
ProjectCreationLevelValue represents a project creation level within GitLab.
ProjectLanguages is a map of strings because the response is arbitrary Gitlab API docs: https://docs.gitlab.com/ce/api/projects.html#languages.
SearchOptions represents the available options for all search methods.
SubGroupCreationLevelValue represents a sub group creation level within GitLab.
TodoAction represents the available actions that can be performed on a todo.
UpdateGroupLabelOptions represents the available UpdateGroupLabel() options.
UpdateGroupOptions represents the set of available options to update a Group; as of today these are exactly the same available when creating a new Group.
VariableTypeValue represents a variable type within GitLab.
VisibilityValue represents a visibility level within GitLab.
WikiFormat represents the available wiki formats.