Module types/output

APIs

APIs

interface GetProjectsProject

interface GetProjectsProject
_links: {[key: string]: string};

property approvalsBeforeMerge

approvalsBeforeMerge: number;

The numbers of approvals needed in a merge requests.

property archived

archived: boolean;

Limit by archived status.

property avatarUrl

avatarUrl: string;

property ciConfigPath

ciConfigPath: string;

property containerRegistryEnabled

containerRegistryEnabled: boolean;

property createdAt

createdAt: string;

property creatorId

creatorId: number;

property customAttributes

customAttributes: {[key: string]: any}[];

property defaultBranch

defaultBranch: string;

property description

description: string;

property forkedFromProject

forkedFromProject: GetProjectsProjectForkedFromProject;

property forksCount

forksCount: number;

property httpUrlToRepo

httpUrlToRepo: string;

The HTTP clone URL of the project.

property id

id: number;

The ID of the project.

property importError

importError: string;

property importStatus

importStatus: string;

property issuesEnabled

issuesEnabled: boolean;

property jobsEnabled

jobsEnabled: boolean;

Whether pipelines are enabled for the project.

property lastActivityAt

lastActivityAt: string;

property lfsEnabled

lfsEnabled: boolean;

property mergeMethod

mergeMethod: string;

property mergeRequestsEnabled

mergeRequestsEnabled: boolean;

property mirror

mirror: boolean;

property mirrorOverwritesDivergedBranches

mirrorOverwritesDivergedBranches: boolean;

property mirrorTriggerBuilds

mirrorTriggerBuilds: boolean;

property mirrorUserId

mirrorUserId: number;

property name

name: string;

The name of the project.

property nameWithNamespace

nameWithNamespace: string;

In group / subgroup / project or user / project format.

property namespace

namespace: GetProjectsProjectNamespace;

property onlyAllowMergeIfAllDiscussionsAreResolved

onlyAllowMergeIfAllDiscussionsAreResolved: boolean;

property onlyAllowMergeIfPipelineSucceeds

onlyAllowMergeIfPipelineSucceeds: boolean;

property onlyMirrorProtectedBranches

onlyMirrorProtectedBranches: boolean;

property openIssuesCount

openIssuesCount: number;

property owner

owner: GetProjectsProjectOwner;

property path

path: string;

property pathWithNamespace

pathWithNamespace: string;

In group/subgroup/project or user/project format.

property permissions

permissions: GetProjectsProjectPermissions;

property public

public: boolean;

Whether the project is public.

property publicBuilds

publicBuilds: boolean;

property readmeUrl

readmeUrl: string;

property requestAccessEnabled

requestAccessEnabled: boolean;

property resolveOutdatedDiffDiscussions

resolveOutdatedDiffDiscussions: boolean;

property runnersToken

runnersToken: string;

property sharedRunnersEnabled

sharedRunnersEnabled: boolean;

property sharedWithGroups

sharedWithGroups: GetProjectsProjectSharedWithGroup[];

property snippetsEnabled

snippetsEnabled: boolean;

property sshUrlToRepo

sshUrlToRepo: string;

The SSH clone URL of the project.

property starCount

starCount: number;

property statistics

statistics: {[key: string]: number};

Include project statistics. Cannot be used with groupId.

property tagLists

tagLists: string[];

A set of the project topics (formerly called “project tags”).

property visibility

visibility: string;

Limit by visibility public, internal, or private.

property webUrl

webUrl: string;

property wikiEnabled

wikiEnabled: boolean;

interface GetProjectsProjectForkedFromProject

interface GetProjectsProjectForkedFromProject

property httpUrlToRepo

httpUrlToRepo: string;

The HTTP clone URL of the project.

property id

id: number;

The ID of the project.

property name

name: string;

The name of the project.

property nameWithNamespace

nameWithNamespace: string;

In group / subgroup / project or user / project format.

property path

path: string;

property pathWithNamespace

pathWithNamespace: string;

In group/subgroup/project or user/project format.

property webUrl

webUrl: string;

interface GetProjectsProjectNamespace

interface GetProjectsProjectNamespace

property fullPath

fullPath: string;

property id

id: number;

The ID of the project.

property kind

kind: string;

property name

name: string;

The name of the project.

property path

path: string;

interface GetProjectsProjectOwner

interface GetProjectsProjectOwner

property avatarUrl

avatarUrl: string;

property id

id: number;

The ID of the project.

property name

name: string;

The name of the project.

property state

state: string;

property username

username: string;

property websiteUrl

websiteUrl: string;

interface GetProjectsProjectPermissions

interface GetProjectsProjectPermissions

property groupAccess

groupAccess: {[key: string]: number};

property projectAccess

projectAccess: {[key: string]: number};

interface GetProjectsProjectSharedWithGroup

interface GetProjectsProjectSharedWithGroup

property groupAccessLevel

groupAccessLevel: string;

property groupId

groupId: number;

The ID of the group owned by the authenticated user to look projects for within. Cannot be used with minAccessLevel, withProgrammingLanguage or statistics.

property groupName

groupName: string;

interface GetUsersUser

interface GetUsersUser

property avatarUrl

avatarUrl: string;

The avatar URL of the user.

property bio

bio: string;

The bio of the user.

property canCreateGroup

canCreateGroup: boolean;

Whether the user can create groups.

property canCreateProject

canCreateProject: boolean;

Whether the user can create projects.

property colorSchemeId

colorSchemeId: number;

User’s color scheme ID.

property createdAt

createdAt: string;

Date the user was created at.

property currentSignInAt

currentSignInAt: string;

Current user’s sign-in date.

property email

email: string;

The e-mail address of the user.

property externUid

externUid: string;

Lookup users by external UID. (Requires administrator privileges)

property external

external: boolean;

Whether the user is external.

property id

id: number;

The unique id assigned to the user by the gitlab server.

property isAdmin

isAdmin: boolean;

Whether the user is an admin.

property lastSignInAt

lastSignInAt: string;

Last user’s sign-in date.

property linkedin

linkedin: string;

Linkedin profile of the user.

property location

location: string;

The location of the user.

property name

name: string;

The name of the user.

property organization

organization: string;

The organization of the user.

property projectsLimit

projectsLimit: number;

Number of projects the user can create.

property provider

provider: string;

The UID provider of the user.

property skype

skype: string;

Skype username of the user.

property state

state: string;

Whether the user is active or blocked.

property themeId

themeId: number;

User’s theme ID.

property twitter

twitter: string;

Twitter username of the user.

property twoFactorEnabled

twoFactorEnabled: boolean;

Whether user’s two factor auth is enabled.

property username

username: string;

The username of the user.

property websiteUrl

websiteUrl: string;

User’s website URL.

interface ProjectSharedWithGroup

interface ProjectSharedWithGroup

property groupAccessLevel

groupAccessLevel: string;

Group’s sharing permissions. See [group members permission][groupMembersPermissions] for more info. Valid values are guest, reporter, developer, master.

property groupId

groupId: number;

Group id of the group you want to share the project with.

property groupName

groupName: string;

Group’s name.