Copyright	(c) Rob Stewart Heriot-Watt University 2019
License	BSD3
Maintainer	robstewart57@gmail.com
Stability	stable
Safe Haskell	None
Language	Haskell2010

GitLab.API.Projects

Contents

List all projects
Get single project
Get project users
User projects
starredProjects
project groups
create project
edit project
fork project
forks of project
starring projects
archving projects
delete project
share projects with groups
impport project members
fork relationship
Search for projects
housekeeping
Transfer projects
Additional functionality beyond the GitLab Projects API

Description

Synopsis

projects :: ProjectSearchAttrs -> GitLab [Project]
project :: Int -> GitLab (Either (Response ByteString) (Maybe Project))
projectUsers :: Project -> GitLab (Either (Response ByteString) [User])
userProjects :: User -> ProjectSearchAttrs -> GitLab (Maybe [Project])
starredProjects :: User -> ProjectSearchAttrs -> GitLab [Project]
projectGroups :: Project -> GitLab (Either (Response ByteString) [Group])
createProject :: Text -> Text -> GitLab (Either (Response ByteString) (Maybe Project))
createProjectForUser :: User -> Text -> GitLab (Either (Response ByteString) (Maybe Project))
editProject :: Project -> ProjectAttrs -> GitLab (Either (Response ByteString) Project)
forkProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
projectForks :: Text -> GitLab (Either (Response ByteString) [Project])
starProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
unstarProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
projectStarrers :: Project -> GitLab (Either (Response ByteString) [Group])
archiveProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
unarchiveProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
deleteProject :: Project -> GitLab (Either (Response ByteString) (Maybe ()))
shareProjectWithGroup :: Int -> Project -> AccessLevel -> GitLab (Either (Response ByteString) (Maybe Project))
unshareProjectWithGroup :: Int -> Project -> GitLab (Either (Response ByteString) (Maybe ()))
importMembersFromProject :: Project -> Project -> GitLab (Either (Response ByteString) (Maybe Project))
forkRelation :: Project -> Project -> GitLab (Either (Response ByteString) (Maybe Project))
unforkRelation :: Project -> GitLab (Either (Response ByteString) (Maybe ()))
projectsWithName :: Text -> GitLab [Project]
projectWithPathAndName :: Text -> Text -> GitLab (Either (Response ByteString) (Maybe Project))
houseKeeping :: Project -> GitLab (Either (Response ByteString) (Maybe Project))
transferProject :: Project -> Text -> GitLab (Either (Response ByteString) Project)
multipleCommitters :: Project -> GitLab Bool
commitsEmailAddresses :: Project -> GitLab [Text]
projectOfIssue :: Issue -> GitLab Project
projectDiffs :: Project -> Text -> GitLab (Either (Response ByteString) [Diff])
defaultProjectAttrs :: Int -> ProjectAttrs
defaultProjectSearchAttrs :: ProjectSearchAttrs
data ProjectAttrs = ProjectAttrs {
- project_edit_allow_merge_on_skipped_pipeline :: Maybe Bool
- project_edit_analytics_access_level :: Maybe Text
- project_edit_approvals_before_merge :: Maybe Int
- project_edit_auto_cancel_pending_pipelines :: Maybe EnabledDisabled
- project_edit_auto_devops_deploy_strategy :: Maybe AutoDeployStrategy
- project_edit_auto_devops_enabled :: Maybe Bool
- project_edit_autoclose_referenced_issues :: Maybe Bool
- project_edit_build_coverage_regex :: Maybe Text
- project_edit_build_git_strategy :: Maybe GitStrategy
- project_edit_build_timeout :: Maybe Int
- project_edit_builds_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_ci_config_path :: Maybe Text
- project_edit_ci_default_git_depth :: Maybe Int
- project_edit_ci_forward_deployment_enabled :: Maybe Bool
- project_edit_container_registry_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_default_branch :: Maybe Text
- project_edit_description :: Maybe Text
- project_edit_emails_disabled :: Maybe Bool
- project_edit_external_authorization_classification_label :: Maybe Text
- project_edit_forking_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_id :: Int
- project_edit_import_url :: Maybe Text
- project_edit_issues_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_lfs_enabled :: Maybe Bool
- project_edit_merge_method :: Maybe MergeMethod
- project_edit_merge_requests_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_mirror_overwrites_diverged_branches :: Maybe Bool
- project_edit_mirror_trigger_builds :: Maybe Bool
- project_edit_mirror_user_id :: Maybe Int
- project_edit_mirror :: Maybe Bool
- project_edit_name :: Maybe Text
- project_edit_operations_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_only_allow_merge_if_all_discussions_are_resolved :: Maybe Bool
- project_edit_only_allow_merge_if_pipeline_succeeds :: Maybe Bool
- project_edit_only_mirror_protected_branches :: Maybe Bool
- project_edit_packages_enabled :: Maybe Bool
- project_edit_pages_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_requirements_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_restrict_user_defined_variables :: Maybe Bool
- project_edit_path :: Maybe Text
- project_edit_public_builds :: Maybe Bool
- project_edit_remove_source_branch_after_merge :: Maybe Bool
- project_edit_repository_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_repository_storage :: Maybe Text
- project_edit_request_access_enabled :: Maybe Bool
- project_edit_resolve_outdated_diff_discussions :: Maybe Bool
- project_edit_service_desk_enabled :: Maybe Bool
- project_edit_shared_runners_enabled :: Maybe Bool
- project_edit_show_default_award_emojis :: Maybe Bool
- project_edit_snippets_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_squash_option :: Maybe SquashOption
- project_edit_suggestion_commit_message :: Maybe Text
- project_edit_visibility :: Maybe Visibility
- project_edit_wiki_access_level :: Maybe ProjectSettingAccessLevel
- project_edit_issues_template :: Maybe Text
- project_edit_merge_requests_template :: Maybe Text
- project_edit_keep_latest_artifact :: Maybe Bool
}
data ProjectSearchAttrs = ProjectSearchAttrs {
- projectSearchFilter_archived :: Maybe Bool
- projectSearchFilter_id_after :: Maybe Int
- projectSearchFilter_id_before :: Maybe Bool
- projectSearchFilter_imported :: Maybe Bool
- projectSearchFilter_last_activity_after :: Maybe UTCTime
- projectSearchFilter_last_activity_before :: Maybe UTCTime
- projectSearchFilter_membership :: Maybe Bool
- projectSearchFilter_min_access_level :: Maybe AccessLevel
- projectSearchFilter_order_by :: Maybe OrderBy
- projectSearchFilter_owned :: Maybe Bool
- projectSearchFilter_repository_checksum_failed :: Maybe Bool
- projectSearchFilter_repository_storage :: Maybe Text
- projectSearchFilter_search_namespaces :: Maybe Bool
- projectSearchFilter_search :: Maybe Text
- projectSearchFilter_simple :: Maybe Bool
- projectSearchFilter_sort :: Maybe SortBy
- projectSearchFilter_starred :: Maybe Bool
- projectSearchFilter_statistics :: Maybe Bool
- projectSearchFilter_topic :: Maybe Text
- projectSearchFilter_topic_id :: Maybe Int
- projectSearchFilter_visibility :: Maybe Visibility
- projectSearchFilter_with_custom_attributes :: Maybe Bool
- projectSearchFilter_with_issues_enabled :: Maybe Bool
- projectSearchFilter_with_merge_requests_enabled :: Maybe Bool
- projectSearchFilter_with_programming_language :: Maybe Text
}
data EnabledDisabled
- = Enabled
- | Disabled
data AutoDeployStrategy
- = Continuous
- | Manual
- | TimedIncremental
data GitStrategy
- = Clone
- | Fetch
- | None
data ProjectSettingAccessLevel
- = DisabledAccess
- | PrivateAccess
- | EnabledAccess
- | PublicAccess
data MergeMethod
- = Merge
- | RebaseMerge
- | FF
data SquashOption
- = NeverSquash
- | AlwaysSquash
- | DefaultOnSquash
- | DefaultOffSquash

List all projects

projects Source #

Arguments

:: ProjectSearchAttrs	project filters
-> GitLab [Project]

Get a list of all visible projects across GitLab for the authenticated user. When accessed without authentication, only public projects with simple fields are returned.

Get single project

project :: Int -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Get a specific project. This endpoint can be accessed without authentication if the project is publicly accessible.

Get project users

projectUsers :: Project -> GitLab (Either (Response ByteString) [User]) Source #

Get the users list of a project.

User projects

userProjects :: User -> ProjectSearchAttrs -> GitLab (Maybe [Project]) Source #

gets all projects for a user.

userProjects myUser

starredProjects

starredProjects :: User -> ProjectSearchAttrs -> GitLab [Project] Source #

Get a list of visible projects starred by the given user. When accessed without authentication, only public projects are returned.

userProjects myUser

project groups

projectGroups :: Project -> GitLab (Either (Response ByteString) [Group]) Source #

Get a list of ancestor groups for this project.

create project

createProject :: Text -> Text -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Creates a new project owned by the authenticated user.

createProjectForUser Source #

Arguments

:: User	user to create the project for
-> Text	name of the new project
-> GitLab (Either (Response ByteString) (Maybe Project))

Creates a new project owned by the specified user. Available only for administrators.

edit project

editProject Source #

Arguments

:: Project	project
-> ProjectAttrs	project attributes
-> GitLab (Either (Response ByteString) Project)

Edit a project. The defaultProjectAttrs value has default project search values, which is a record that can be modified with Just values.

For example to disable project specific email notifications:

editProject myProject (defaultProjectAttrs { project_edit_emails_disabled = Just True })

fork project

forkProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Forks a project into the user namespace of the authenticated user or the one provided.

forks of project

projectForks Source #

Arguments

:: Text	name or namespace of the project
-> GitLab (Either (Response ByteString) [Project])

List the projects accessible to the calling user that have an established, forked relationship with the specified project

projectForks "project1"
projectForks "group1/project1"

starring projects

starProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Stars a given project.

unstarProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Stars a given project.

projectStarrers :: Project -> GitLab (Either (Response ByteString) [Group]) Source #

List the users who starred the specified project.

archving projects

archiveProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Archives the project if the user is either an administrator or the owner of this project.

unarchiveProject :: Project -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

Unarchives the project if the user is either an administrator or the owner of this project.

delete project

deleteProject :: Project -> GitLab (Either (Response ByteString) (Maybe ())) Source #

Deletes a project including all associated resources.

share projects with groups

shareProjectWithGroup Source #

Arguments

:: Int	group ID
-> Project	project
-> AccessLevel	level of access granted
-> GitLab (Either (Response ByteString) (Maybe Project))

Allow to share project with group.

unshareProjectWithGroup Source #

Arguments

:: Int	group ID
-> Project	project
-> GitLab (Either (Response ByteString) (Maybe ()))

Unshare the project from the group.

impport project members

importMembersFromProject Source #

Arguments

:: Project	project to receive memvers
-> Project	source project to import members from
-> GitLab (Either (Response ByteString) (Maybe Project))

Import members from another project.

fork relationship

forkRelation Source #

Arguments

:: Project	forked project
-> Project	project that was forked from
-> GitLab (Either (Response ByteString) (Maybe Project))

Allows modification of the forked relationship between existing projects. Available only for project owners and administrators.

unforkRelation Source #

Arguments

:: Project	forked project
-> GitLab (Either (Response ByteString) (Maybe ()))

Delete an existing forked from relationship.

Search for projects

projectsWithName Source #

Arguments

:: Text	project name being searched for.
-> GitLab [Project]

gets all projects with the given project name. It only returns projects with an exact match with the project path.

projectsWithName "project1"

projectWithPathAndName :: Text -> Text -> GitLab (Either (Response ByteString) (Maybe Project)) Source #

gets a project with the given name for the given full path of the namespace. E.g.

projectWithPathAndName "user1" "project1"

looks for "user1/project1"

projectWithPathAndName "group1/subgroup1" "project1"

looks for "project1" within the namespace with full path "group1/subgroup1"

housekeeping

houseKeeping Source #

Arguments

:: Project	the project
-> GitLab (Either (Response ByteString) (Maybe Project))

Start the Housekeeping task for a project.

Transfer projects

transferProject Source #

Arguments

:: Project	project
-> Text	namespace where to transfer project to
-> GitLab (Either (Response ByteString) Project)

transfer a project to a new namespace.

Additional functionality beyond the GitLab Projects API

multipleCommitters :: Project -> GitLab Bool Source #

Returns True is a projecthas multiple email addresses associated with all commits in a project, False otherwise.

commitsEmailAddresses :: Project -> GitLab [Text] Source #

gets the email addresses in the author information in all commit for a project.

projectOfIssue :: Issue -> GitLab Project Source #

gets the Project against which the given Issue was created.

projectDiffs :: Project -> Text -> GitLab (Either (Response ByteString) [Diff]) Source #

gets all diffs in a project for a given commit SHA.

defaultProjectAttrs Source #

Arguments

:: Int	project ID
-> ProjectAttrs

A default set of project attributes to override with the editProject functions. Only the project ID value is set is a search parameter, all other search parameters are not set and can be overwritten.

defaultProjectSearchAttrs :: ProjectSearchAttrs Source #

A default set of project searc filters where no project filters are applied, thereby returning all projects.

data ProjectAttrs Source #

Attributes for updating when editing a project with the editProject functions.

Constructors

ProjectAttrs

Fields

project_edit_allow_merge_on_skipped_pipeline :: Maybe Bool
Set whether or not merge requests can be merged with skipped jobs.
project_edit_analytics_access_level :: Maybe Text
One of disabled, private or enabled.
project_edit_approvals_before_merge :: Maybe Int
How many approvers should approve merge request by default.
project_edit_auto_cancel_pending_pipelines :: Maybe EnabledDisabled
Auto-cancel pending pipelines.
project_edit_auto_devops_deploy_strategy :: Maybe AutoDeployStrategy
Auto Deploy strategy (continuous, manual, or timed_incremental).
project_edit_auto_devops_enabled :: Maybe Bool
Enable Auto DevOps for this project.
project_edit_autoclose_referenced_issues :: Maybe Bool
Set whether auto-closing referenced issues on default branch.
project_edit_build_coverage_regex :: Maybe Text
Test coverage parsing.
project_edit_build_git_strategy :: Maybe GitStrategy
The Git strategy. Defaults to fetch.
project_edit_build_timeout :: Maybe Int
The maximum amount of time, in seconds, that a job can run.
project_edit_builds_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_ci_config_path :: Maybe Text
The path to CI configuration file.
project_edit_ci_default_git_depth :: Maybe Int
Default number of revisions for shallow cloning.
project_edit_ci_forward_deployment_enabled :: Maybe Bool
When a new deployment job starts, skip older deployment jobs that are still pending.
project_edit_container_registry_access_level :: Maybe ProjectSettingAccessLevel
Set visibility of container registry, for this project, to one of disabled, private or enabled.
project_edit_default_branch :: Maybe Text
The default branch name.
project_edit_description :: Maybe Text
Short project description.
project_edit_emails_disabled :: Maybe Bool
Disable email notifications.
project_edit_external_authorization_classification_label :: Maybe Text
The classification label for the project.
project_edit_forking_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_id :: Int
The ID or URL-encoded path of the project.
project_edit_import_url :: Maybe Text
URL to import repository from.
project_edit_issues_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_lfs_enabled :: Maybe Bool
Enable LFS.
project_edit_merge_method :: Maybe MergeMethod
Set the merge method used.
project_edit_merge_requests_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_mirror_overwrites_diverged_branches :: Maybe Bool
Pull mirror overwrites diverged branches.
project_edit_mirror_trigger_builds :: Maybe Bool
Pull mirroring triggers builds.
project_edit_mirror_user_id :: Maybe Int
User responsible for all the activity surrounding a pull mirror event. (admins only)
project_edit_mirror :: Maybe Bool
Enables pull mirroring in a project.
project_edit_name :: Maybe Text
The name of the project.
project_edit_operations_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_only_allow_merge_if_all_discussions_are_resolved :: Maybe Bool
Set whether merge requests can only be merged when all the discussions are resolved.
project_edit_only_allow_merge_if_pipeline_succeeds :: Maybe Bool
Set whether merge requests can only be merged with successful jobs.
project_edit_only_mirror_protected_branches :: Maybe Bool
Only mirror protected branches.
project_edit_packages_enabled :: Maybe Bool
Enable or disable packages repository feature.
project_edit_pages_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, enabled, or public.
project_edit_requirements_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, enabled or public.
project_edit_restrict_user_defined_variables :: Maybe Bool
Allow only maintainers to pass user-defined variables when triggering a pipeline. For example when the pipeline is triggered in the UI, with the API, or by a trigger token.
project_edit_path :: Maybe Text
Custom repository name for the project. By default generated based on name.
project_edit_public_builds :: Maybe Bool
If true, jobs can be viewed by non-project members.
project_edit_remove_source_branch_after_merge :: Maybe Bool
Enable Delete source branch option by default for all new merge requests.
project_edit_repository_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_repository_storage :: Maybe Text
Which storage shard the repository is on. (admins only)
project_edit_request_access_enabled :: Maybe Bool
Allow users to request member access.
project_edit_resolve_outdated_diff_discussions :: Maybe Bool
Automatically resolve merge request diffs discussions on lines changed with a push.
project_edit_service_desk_enabled :: Maybe Bool
Enable or disable Service Desk feature.
project_edit_shared_runners_enabled :: Maybe Bool
Enable shared runners for this project.
project_edit_show_default_award_emojis :: Maybe Bool
Show default award emojis.
project_edit_snippets_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_squash_option :: Maybe SquashOption
One of never, always, default_on, or default_off.
project_edit_suggestion_commit_message :: Maybe Text
The commit message used to apply merge request suggestions.
project_edit_visibility :: Maybe Visibility
project_edit_wiki_access_level :: Maybe ProjectSettingAccessLevel
One of disabled, private, or enabled.
project_edit_issues_template :: Maybe Text
Default description for Issues. Description is parsed with GitLab Flavored Markdown. See Templates for issues and merge requests.
project_edit_merge_requests_template :: Maybe Text
Default description for Merge Requests. Description is parsed with GitLab Flavored Markdown.
project_edit_keep_latest_artifact :: Maybe Bool
Disable or enable the ability to keep the latest artifact for this project.

Instances

Instances details

Eq ProjectAttrs Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: ProjectAttrs -> ProjectAttrs -> Bool # (/=) :: ProjectAttrs -> ProjectAttrs -> Bool #
Show ProjectAttrs Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> ProjectAttrs -> ShowS # show :: ProjectAttrs -> String # showList :: [ProjectAttrs] -> ShowS #
Generic ProjectAttrs Source #
Instance details Defined in GitLab.API.Projects Associated Types type Rep ProjectAttrs :: Type -> Type # Methods from :: ProjectAttrs -> Rep ProjectAttrs x # to :: Rep ProjectAttrs x -> ProjectAttrs #
type Rep ProjectAttrs Source #
Instance details Defined in GitLab.API.Projects type Rep ProjectAttrs = D1 ('MetaData "ProjectAttrs" "GitLab.API.Projects" "gitlab-haskell-1.0.0.1-DonaEDjMHw5I5CPNrgZNHH" 'False) (C1 ('MetaCons "ProjectAttrs" 'PrefixI 'True) (((((S1 ('MetaSel ('Just "project_edit_allow_merge_on_skipped_pipeline") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "project_edit_analytics_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "project_edit_approvals_before_merge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "project_edit_auto_cancel_pending_pipelines") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe EnabledDisabled)) :: S1 ('MetaSel ('Just "project_edit_auto_devops_deploy_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe AutoDeployStrategy))) :: (S1 ('MetaSel ('Just "project_edit_auto_devops_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_autoclose_referenced_issues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "project_edit_build_coverage_regex") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "project_edit_build_git_strategy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe GitStrategy)) :: S1 ('MetaSel ('Just "project_edit_build_timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)))) :: ((S1 ('MetaSel ('Just "project_edit_builds_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_ci_config_path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "project_edit_ci_default_git_depth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "project_edit_ci_forward_deployment_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "project_edit_container_registry_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: (S1 ('MetaSel ('Just "project_edit_default_branch") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "project_edit_description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "project_edit_emails_disabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_external_authorization_classification_label") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "project_edit_forking_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))) :: ((S1 ('MetaSel ('Just "project_edit_import_url") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "project_edit_issues_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_lfs_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "project_edit_merge_method") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe MergeMethod)) :: S1 ('MetaSel ('Just "project_edit_merge_requests_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel))) :: (S1 ('MetaSel ('Just "project_edit_mirror_overwrites_diverged_branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_mirror_trigger_builds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))))) :: ((((S1 ('MetaSel ('Just "project_edit_mirror_user_id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int)) :: (S1 ('MetaSel ('Just "project_edit_mirror") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "project_edit_operations_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_only_allow_merge_if_all_discussions_are_resolved") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "project_edit_only_allow_merge_if_pipeline_succeeds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_only_mirror_protected_branches") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: ((S1 ('MetaSel ('Just "project_edit_packages_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "project_edit_pages_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_requirements_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)))) :: ((S1 ('MetaSel ('Just "project_edit_restrict_user_defined_variables") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_path") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "project_edit_public_builds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_remove_source_branch_after_merge") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))) :: (((S1 ('MetaSel ('Just "project_edit_repository_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: (S1 ('MetaSel ('Just "project_edit_repository_storage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "project_edit_request_access_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))) :: ((S1 ('MetaSel ('Just "project_edit_resolve_outdated_diff_discussions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_service_desk_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "project_edit_shared_runners_enabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "project_edit_show_default_award_emojis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool))))) :: (((S1 ('MetaSel ('Just "project_edit_snippets_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_squash_option") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe SquashOption))) :: (S1 ('MetaSel ('Just "project_edit_suggestion_commit_message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "project_edit_visibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Visibility)))) :: ((S1 ('MetaSel ('Just "project_edit_wiki_access_level") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe ProjectSettingAccessLevel)) :: S1 ('MetaSel ('Just "project_edit_issues_template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "project_edit_merge_requests_template") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "project_edit_keep_latest_artifact") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))))))

data ProjectSearchAttrs Source #

Attributes related to a group

Constructors

ProjectSearchAttrs

Fields

projectSearchFilter_archived :: Maybe Bool
Limit by archived status.
projectSearchFilter_id_after :: Maybe Int
Limit results to projects with IDs greater than the specified ID.
projectSearchFilter_id_before :: Maybe Bool
Limit results to projects with IDs less than the specified ID.
projectSearchFilter_imported :: Maybe Bool
Limit results to projects which were imported from external systems by current user.
projectSearchFilter_last_activity_after :: Maybe UTCTime
Limit results to projects with last_activity after specified time.
projectSearchFilter_last_activity_before :: Maybe UTCTime
Limit results to projects with last_activity before specified time.
projectSearchFilter_membership :: Maybe Bool
Limit by projects that the current user is a member of.
projectSearchFilter_min_access_level :: Maybe AccessLevel
Limit by current user minimal access level.
projectSearchFilter_order_by :: Maybe OrderBy
Return projects ordered by a given criteria.
projectSearchFilter_owned :: Maybe Bool
Limit by projects explicitly owned by the current user.
projectSearchFilter_repository_checksum_failed :: Maybe Bool
Limit projects where the repository checksum calculation has failed.
projectSearchFilter_repository_storage :: Maybe Text
Limit results to projects stored on repository_storage. (administrators only).
projectSearchFilter_search_namespaces :: Maybe Bool
Include ancestor namespaces when matching search criteria. Default is false.
projectSearchFilter_search :: Maybe Text
Return list of projects matching the search criteria.
projectSearchFilter_simple :: Maybe Bool
Return only limited fields for each project. This is a no-op without authentication as then only simple fields are returned.
projectSearchFilter_sort :: Maybe SortBy
Return projects sorted in asc or desc order. Default is desc.
projectSearchFilter_starred :: Maybe Bool
Limit by projects starred by the current user.
projectSearchFilter_statistics :: Maybe Bool
Include project statistics. Only available to Reporter or higher level role members.
projectSearchFilter_topic :: Maybe Text
Comma-separated topic names. Limit results to projects that match all of given topics.
projectSearchFilter_topic_id :: Maybe Int
Limit results to projects with the assigned topic given by the topic ID.
projectSearchFilter_visibility :: Maybe Visibility
Limit by visibility.
projectSearchFilter_with_custom_attributes :: Maybe Bool
Include custom attributes in response. (administrator only).
projectSearchFilter_with_issues_enabled :: Maybe Bool
Limit by enabled issues feature.
projectSearchFilter_with_merge_requests_enabled :: Maybe Bool
Limit by enabled merge requests feature.
projectSearchFilter_with_programming_language :: Maybe Text
Limit by projects which use the given programming language.

data EnabledDisabled Source #

Is auto-cancel pending pipelines enabled or disabled

Constructors

Enabled
Disabled

Instances

Instances details

Eq EnabledDisabled Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: EnabledDisabled -> EnabledDisabled -> Bool # (/=) :: EnabledDisabled -> EnabledDisabled -> Bool #
Show EnabledDisabled Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> EnabledDisabled -> ShowS # show :: EnabledDisabled -> String # showList :: [EnabledDisabled] -> ShowS #

data AutoDeployStrategy Source #

Auto Deploy strategy: continuous, manual, or timed_incremental, for the editProject functions

Constructors

Continuous
Manual
TimedIncremental

Instances

Instances details

Eq AutoDeployStrategy Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: AutoDeployStrategy -> AutoDeployStrategy -> Bool # (/=) :: AutoDeployStrategy -> AutoDeployStrategy -> Bool #
Show AutoDeployStrategy Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> AutoDeployStrategy -> ShowS # show :: AutoDeployStrategy -> String # showList :: [AutoDeployStrategy] -> ShowS #

data GitStrategy Source #

The Git strategy, defaults to fetch, for the editProject functions

Constructors

Clone
Fetch
None

Instances

Instances details

Eq GitStrategy Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: GitStrategy -> GitStrategy -> Bool # (/=) :: GitStrategy -> GitStrategy -> Bool #
Show GitStrategy Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> GitStrategy -> ShowS # show :: GitStrategy -> String # showList :: [GitStrategy] -> ShowS #

data ProjectSettingAccessLevel Source #

The project access level setting, for the editProject functions

Constructors

DisabledAccess
PrivateAccess
EnabledAccess
PublicAccess

Instances

Instances details

Eq ProjectSettingAccessLevel Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: ProjectSettingAccessLevel -> ProjectSettingAccessLevel -> Bool # (/=) :: ProjectSettingAccessLevel -> ProjectSettingAccessLevel -> Bool #
Show ProjectSettingAccessLevel Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> ProjectSettingAccessLevel -> ShowS # show :: ProjectSettingAccessLevel -> String # showList :: [ProjectSettingAccessLevel] -> ShowS #

data MergeMethod Source #

The project git merge method, for the editProject functions

Constructors

Merge
RebaseMerge
FF

Instances

Instances details

Eq MergeMethod Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: MergeMethod -> MergeMethod -> Bool # (/=) :: MergeMethod -> MergeMethod -> Bool #
Show MergeMethod Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> MergeMethod -> ShowS # show :: MergeMethod -> String # showList :: [MergeMethod] -> ShowS #

data SquashOption Source #

The project git merge squash option, for the editProject functions

Constructors

NeverSquash
AlwaysSquash
DefaultOnSquash
DefaultOffSquash

Instances

Instances details

Eq SquashOption Source #
Instance details Defined in GitLab.API.Projects Methods (==) :: SquashOption -> SquashOption -> Bool # (/=) :: SquashOption -> SquashOption -> Bool #
Show SquashOption Source #
Instance details Defined in GitLab.API.Projects Methods showsPrec :: Int -> SquashOption -> ShowS # show :: SquashOption -> String # showList :: [SquashOption] -> ShowS #