| Copyright | (c) Rob Stewart Heriot-Watt University 2021 |
|---|---|
| License | BSD3 |
| Maintainer | robstewart57@gmail.com |
| Stability | stable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GitLab.API.Boards
Description
Synopsis
- projectIssueBoards :: Project -> GitLab [IssueBoard]
- projectIssueBoard :: Project -> Int -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
- createIssueBoard :: Project -> Text -> GitLab (Maybe IssueBoard)
- updateIssueBoard :: Project -> Int -> UpdateBoardAttrs -> GitLab (Either (Response ByteString) (Maybe IssueBoard))
- deleteIssueBoard :: Project -> IssueBoard -> GitLab (Either (Response ByteString) (Maybe ()))
- projectBoardLists :: Project -> IssueBoard -> GitLab [BoardIssue]
- boardList :: Project -> IssueBoard -> Int -> GitLab (Maybe BoardIssue)
- createBoardList :: Project -> IssueBoard -> CreateBoardAttrs -> GitLab (Maybe BoardIssue)
- reorderBoardList :: Project -> IssueBoard -> Int -> Int -> GitLab (Either (Response ByteString) (Maybe BoardIssue))
- deleteBoardList :: Project -> IssueBoard -> Int -> GitLab (Either (Response ByteString) (Maybe ()))
- data UpdateBoardAttrs = UpdateBoardAttrs {}
- defaultUpdateBoardAttrs :: UpdateBoardAttrs
- data CreateBoardAttrs = CreateBoardAttrs {}
- defaultCreateBoardAttrs :: CreateBoardAttrs
List project issue boards
Arguments
| :: Project | the project |
| -> GitLab [IssueBoard] |
returns all issue boards for a project.
Show a single issue board
Arguments
| :: Project | the project |
| -> Int | the board ID |
| -> GitLab (Either (Response ByteString) (Maybe IssueBoard)) |
returns a single project issue board.
Create an issue board
Arguments
| :: Project | the project |
| -> Text | board name |
| -> GitLab (Maybe IssueBoard) |
Creates a project issue board.
Update an issue board
Arguments
| :: Project | project |
| -> Int | the board ID |
| -> UpdateBoardAttrs | attributes for updating boards |
| -> GitLab (Either (Response ByteString) (Maybe IssueBoard)) |
Updates a project issue board.
Delete an issue board
Arguments
| :: Project | the project |
| -> IssueBoard | the board |
| -> GitLab (Either (Response ByteString) (Maybe ())) |
Deletes a project issue board.
List board lists in a project issue board
Arguments
| :: Project | the project |
| -> IssueBoard | the board |
| -> GitLab [BoardIssue] |
Get a list of the board’s lists. Does not include open and closed lists.
Show a single board list
Arguments
| :: Project | the project |
| -> IssueBoard | the board |
| -> Int | list ID |
| -> GitLab (Maybe BoardIssue) |
Get a single board list. Does not include open and closed lists.
Create a board list
Arguments
| :: Project | the project |
| -> IssueBoard | the board |
| -> CreateBoardAttrs | attributes for creating boards |
| -> GitLab (Maybe BoardIssue) |
Creates a new issue board list.
Reorder a list in a board
Arguments
| :: Project | project |
| -> IssueBoard | board |
| -> Int | list ID |
| -> Int | the position of the list |
| -> GitLab (Either (Response ByteString) (Maybe BoardIssue)) |
Updates an existing issue board list. This call is used to change list position.
Update an issue board
Arguments
| :: Project | project |
| -> IssueBoard | board |
| -> Int | list ID |
| -> GitLab (Either (Response ByteString) (Maybe ())) |
Only for administrators and project owners. Deletes a board list.
Board attributes
data UpdateBoardAttrs Source #
Attributes for updating when editing a board with the functions for updating issue boards.
Constructors
| UpdateBoardAttrs | |
defaultUpdateBoardAttrs :: UpdateBoardAttrs Source #
default attributes for board update.
data CreateBoardAttrs Source #
exactly one parameter must be provided.
Constructors
| CreateBoardAttrs | |
Fields | |
defaultCreateBoardAttrs :: CreateBoardAttrs Source #
default attributes for board creation.