Copyright | (c) Rob Stewart Heriot-Watt University 2019 |
---|---|
License | BSD3 |
Maintainer | robstewart57@gmail.com |
Stability | stable |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- groups :: ListGroupsAttrs -> GitLab [Group]
- subGroups :: Group -> ListGroupsAttrs -> GitLab [Group]
- descendantGroups :: Group -> ListGroupsAttrs -> GitLab [Group]
- groupProjects :: Group -> GroupProjectAttrs -> GitLab [Project]
- groupSharedProjects :: Group -> GroupProjectAttrs -> GitLab [Project]
- group :: Int -> GitLab (Either (Response ByteString) (Maybe Group))
- newGroup :: Text -> Text -> GroupAttrs -> GitLab (Either (Response ByteString) (Maybe Group))
- newSubGroup :: Text -> Text -> Int -> GroupAttrs -> GitLab (Either (Response ByteString) (Maybe Group))
- updateGroup :: Int -> GroupAttrs -> GitLab (Either (Response ByteString) (Maybe Group))
- removeGroup :: Int -> GitLab (Either (Response ByteString) (Maybe ()))
- searchGroup :: Text -> GitLab [Group]
- data ListGroupsAttrs = ListGroupsAttrs {
- listGroupsFilter_skip_groups :: Maybe [Int]
- listGroupsFilter_all_available :: Maybe Bool
- listGroupsFilter_search :: Maybe Text
- listGroupsFilter_order_by :: Maybe GroupOrderBy
- listGroupsFilter_sort :: Maybe SortBy
- listGroupsFilter_owned :: Maybe Bool
- listGroupsFilter_min_access_level :: Maybe AccessLevel
- listGroupsFilter_top_level_only :: Maybe Bool
- data GroupOrderBy
- data GroupProjectAttrs = GroupProjectAttrs {
- groupProjectFilter_id :: Maybe Int
- groupProjectFilter_archived :: Maybe Bool
- groupProjectFilter_visibility :: Maybe Visibility
- groupProjectFilter_order_by :: Maybe GroupProjectOrderBy
- groupProjectFilter_sort :: Maybe SortBy
- groupProjectFilter_search :: Maybe Text
- groupProjectFilter_simple :: Maybe Bool
- groupProjectFilter_owned :: Maybe Bool
- groupProjectFilter_starred :: Maybe Bool
- groupProjectFilter_with_issues_enabled :: Maybe Bool
- groupProjectFilter_with_merge_requests_enabled :: Maybe Bool
- groupProjectFilter_with_shared :: Maybe Bool
- groupProjectFilter_include_subgroups :: Maybe Bool
- groupProjectFilter_min_access_level :: Maybe AccessLevel
- groupProjectFilter_with_custom_attributes :: Maybe Bool
- groupProjectFilter_with_security_reports :: Maybe Bool
- data GroupProjectOrderBy
- data GroupAttrs = GroupAttrs {
- groupFilter_name :: Maybe Text
- groupFilter_path :: Maybe Text
- groupFilter_auto_devops_enabled :: Maybe Bool
- groupFilter_default_branch_protection :: Maybe BranchProtection
- groupFilter_description :: Maybe Text
- groupFilter_emails_disabled :: Maybe Bool
- groupFilter_lfs_enabled :: Maybe Bool
- groupFilter_mentions_disabled :: Maybe Bool
- groupFilter_parent_id :: Maybe Int
- groupFilter_project_creation_level :: Maybe AccessLevel
- groupFilter_request_access_enabled :: Maybe Bool
- groupFilter_require_two_factor_authentication :: Maybe Bool
- groupFilter_share_with_group_lock :: Maybe Bool
- groupFilter_subgroup_creation_level :: Maybe AccessLevel
- groupFilter_two_factor_grace_period :: Maybe Int
- groupFilter_visibility :: Maybe Visibility
- data BranchProtection
- defaultGroupFilters :: GroupAttrs
- defaultListGroupsFilters :: ListGroupsAttrs
- defaultGroupProjectFilters :: GroupProjectAttrs
List groups
groups :: ListGroupsAttrs -> GitLab [Group] Source #
Get a list of visible groups for the authenticated user.
List a group’s subgroups
subGroups :: Group -> ListGroupsAttrs -> GitLab [Group] Source #
Get a list of visible direct subgroups in this group.
List a group’s descendant groups
descendantGroups :: Group -> ListGroupsAttrs -> GitLab [Group] Source #
Get a list of visible descendant groups of this group.
List a group’s projects
groupProjects :: Group -> GroupProjectAttrs -> GitLab [Project] Source #
Get a list of projects in this group.
List a group’s shared projects
groupSharedProjects :: Group -> GroupProjectAttrs -> GitLab [Project] Source #
Get a list of projects in this group.
Details of a group
Get all details of a group.
New group
:: Text | group name |
-> Text | group path |
-> GroupAttrs | group attributes |
-> GitLab (Either (Response ByteString) (Maybe Group)) |
Creates a new project group (TODO include attributes).
New Subgroup
:: Text | group name |
-> Text | group path |
-> Int | parent group ID |
-> GroupAttrs | group attributes |
-> GitLab (Either (Response ByteString) (Maybe Group)) |
Creates a new project group.
Update group
:: Int | The ID of the group. |
-> GroupAttrs | Group attributes |
-> GitLab (Either (Response ByteString) (Maybe Group)) |
Updates the project group. Only available to group owners and administrators.
Remove group
Only available to group owners and administrators.
Search for group
Get all groups that match your string in their name or path.
Group attributes
data ListGroupsAttrs Source #
Attributes related to listing groups
data GroupOrderBy Source #
The order of groups in search results.
Instances
Show GroupOrderBy Source # | |
Defined in GitLab.API.Groups showsPrec :: Int -> GroupOrderBy -> ShowS # show :: GroupOrderBy -> String # showList :: [GroupOrderBy] -> ShowS # |
data GroupProjectAttrs Source #
Attributes related to a group
data GroupProjectOrderBy Source #
The order of group projects in search results.
GroupProjectOrderId | |
GroupProjectOrderName | |
GroupProjectOrderPath | |
GroupProjectOrderCreatedAt | |
GroupProjectOrderUpdatedAt | |
GroupProjectOrderSimilarity | |
GroupProjectOrderLastActivityAt |
Instances
Show GroupProjectOrderBy Source # | |
Defined in GitLab.API.Groups showsPrec :: Int -> GroupProjectOrderBy -> ShowS # show :: GroupProjectOrderBy -> String # showList :: [GroupProjectOrderBy] -> ShowS # |
data GroupAttrs Source #
Attributes related to a group
GroupAttrs | |
|
data BranchProtection Source #
A group level branch protection setting.
NoProtection | Users with the Developer or Maintainer role can: push new commits, force push changes, delete the branch |
PartialProtection | Users with the Developer or Maintainer role can: push new commits |
FullProtection | Only users with the Maintainer role can: push new commits |
ProtectAgainstPushes | Users with the Maintainer role can: push new commits, force push changes, accept merge requests; Users with the Developer role can: accept merge requests |
Instances
Show BranchProtection Source # | |
Defined in GitLab.API.Groups showsPrec :: Int -> BranchProtection -> ShowS # show :: BranchProtection -> String # showList :: [BranchProtection] -> ShowS # |
defaultGroupFilters :: GroupAttrs Source #
No group filters applied.
defaultListGroupsFilters :: ListGroupsAttrs Source #
No group filters applied, thereby returning all groups.
defaultGroupProjectFilters :: GroupProjectAttrs Source #
No group filters applied, thereby returning all groups.