[−][src]Module gitlab::types
API entities
These entities are exposed by Gitlab via its API.
There are some places where Gitlab does not completely specify its types. This causes problems when the types and names change inside of those. If found, issues should be filed upstream.
Structs
| AccessRequester | A member with extra permissions on a project. |
| AwardEmoji | An awarded emoji on an entity. |
| AwardId | Type-safe award ID. |
| BasicProjectDetails | Basic project information. |
| ColorSchemeId | Type-safe color scheme ID. |
| Commit | |
| CommitNote | A note on a commit diff. |
| CommitStatus | A status of a commit. |
| CommitStatusId | Type-safe commit status ID. |
| Deployable | |
| Deployment | |
| DeploymentId | Type-safe deployment ID. |
| DiffRefs | |
| Discussion | A threaded discussion |
Email address. | |
| EmailId | Type-safe email ID. |
| Environment | |
| EnvironmentId | Type-safe environment ID. |
| Event | An event on a project. |
| EventLabel | An label on a project. |
| ExternalIssue | An external issue reference. |
| ExternalIssueId | Type-safe external issue ID. |
| Group | Group information. |
| GroupDetail | Group information with a project listing. |
| GroupId | Type-safe group ID. |
| GroupStatistics | Statistics about a group. |
| Hook | A web hook to notify of events. |
| HookId | Type-safe hook ID. |
| Identity | External authentication tokens. |
| IssuableTimeStats | A time estimate on an issue or merge request. |
| Issue | An issue on a project. |
| IssueId | Type-safe issue ID. |
| IssueInternalId | Type-safe issue internal ID (internal to a project). |
| Job | Information about a job in Gitlab CI. |
| JobArtifactFile | An uploaded artifact from a job. |
| JobId | Type-safe job ID. |
| Label | An label on a project. |
| LabelColor | Type-safe label color. |
| LabelEventId | Type-safe label event ID. |
| LabelId | Type-safe label ID. |
| Member | A member with extra permissions on a project. |
| MemberAccess | Access information to a project. |
| MergeRequest | A merge request. |
| MergeRequestChanges | A merge request with changes. |
| MergeRequestId | Type-safe merge request ID. |
| MergeRequestInternalId | Type-safe merge request internal ID (internal to a project). |
| MergeRequestUser | Information about current user's access to the merge request. |
| Milestone | A milestone in a project. |
| MilestoneId | Type-safe milestone ID. |
| MilestoneInternalId | Type-safe milestone internal ID (internal to a project). |
| Namespace | An entity which can own projects. |
| Note | A comment on an entity. |
| NoteId | Type-safe note (comment) ID. |
| NotePosition | When a note is against a diff, the position of the note |
| ObjectId | The ID of a git object. |
| Permissions | Permissions granted to the current user to a project. |
| Pipeline | More information about a pipeline in Gitlab CI. |
| PipelineBasic | Information about a pipeline in Gitlab CI. |
| PipelineId | Type-safe pipeline ID. |
| PipelineVariable | A pipeline variable. |
| Project | Project information. |
| ProjectHook | A web hook to notify of project events. |
| ProjectId | Type-safe project ID. |
| ProjectNamespaceAvatar | The avatar of a project's namespace. |
| ProjectSnippet | A project-specific snippet. |
| ProjectStatistics | Statistics about a project. |
| RepoBranch | A branch on a repository. |
| RepoCommit | A commit in a project. |
| RepoCommitDetail | A commit in a project with statistics. |
| RepoCommitStats | Stats about a commit. |
| RepoDiff | A diff within a repository. |
| RepoTreeObject | An object inside of a repository. |
| ResourceLabelEvent | A resource label event |
| Runner | A Gitlab CI runner. |
| RunnerId | Type-safe runner ID. |
| SharedGroup | Structure for a group a project has been shared with. |
| SnippetId | Type-safe snippet ID. |
| SshKey | An uploaded SSH key. |
| SshKeyId | Type-safe SSH key ID. |
| SshKeyWithUser | An uploaded SSH key with its owner. |
| ThemeId | Type-safe theme ID. |
| User | More detailed information only accessible to administrators. |
| UserBasic | Basic user information. |
| UserId | Type-safe user ID. |
| UserPublic | Full user structure information. |
| WebhookEvents | The events a webhook listener may receive. |
Enums
| AccessLevel | Access levels for groups and projects. |
| AwardableId | An ID of an entity which may receive an award. |
| AwardableType | The entities which may be awarded. |
| DiscussionNoteType | The various types a note can have |
| EventTargetId | The ID of an event target. |
| EventTargetType | The target of an event. |
| FeatureVisibilityLevel | Visibility levels for project features. |
| IssueReference | A reference to an issue. |
| IssueState | The states an issue may be in. |
| LineType | The type of line commented on. |
| MergeRequestState | The states a merge request may be in. |
| MergeStatus | The status of the possible merge for a merge request. |
| MilestoneState | The states a milestone may be in. |
| NamespaceId | The ID of a namespace. |
| NamespaceKind | The kinds of namespaces supported by Gitlab. |
| NotePositionType | A note can be attached to text or an image |
| NoteType | The entities a note may be added to. |
| NoteableId | The ID of an entity a note is attached to. |
| NoteableInternalId | The internal ID of an entity a note is attached to (internal to a project). GitLab only has this for notes attached to issues and merge requests. |
| ObjectType | The kinds of objects Gitlab can return. |
| PipelineVariableType | |
| ResourceLabelEventTarget | The type of object that on which the resource label event was created |
| StatusState | States for commit statuses. |
| UserState | The states a user account can be in. |
| VisibilityLevel | Visibility levels of projects. |
Traits
| UserResult | A unifying trait for all user types. |
Type Definitions
| QueryParamSlice | Type alias for slice of string two-tuples |
| QueryParamVec | Type alias for Vec of string two-tuples |