diff options
| author | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-10 10:02:49 +0200 |
|---|---|---|
| committer | Gauvain Pocentek <gauvain@pocentek.net> | 2018-06-10 10:02:49 +0200 |
| commit | f4c4e52fd8962638ab79429a49fd4a699048bafc (patch) | |
| tree | b78c3c845665560f15257b3a3c9b2d729a297b2d /docs | |
| parent | d6a61afc0c599a85d74947617cb13ab39b4929fc (diff) | |
| download | gitlab-f4c4e52fd8962638ab79429a49fd4a699048bafc.tar.gz | |
Add support for board creation/deletion (EE)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/gl_objects/boards.rst | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/docs/gl_objects/boards.rst b/docs/gl_objects/boards.rst index 0099371..3bdbb51 100644 --- a/docs/gl_objects/boards.rst +++ b/docs/gl_objects/boards.rst @@ -32,16 +32,25 @@ Examples Get the list of existing boards for a project or a group:: # item is a Project or a Group - boards = item.boards.list() + boards = project_or_group.boards.list() Get a single board for a project or a group:: - board = group.boards.get(board_id) + board = project_or_group.boards.get(board_id) -.. note:: +Create a board:: - Boards cannot be created using the API, they need to be created using the - UI. + board = project_or_group.boards.create({'name': 'new-board'}) + +.. note:: Board creation is not supported in the GitLab CE edition. + +Delete a board:: + + board.delete() + # or + project_or_group.boards.delete(board_id) + +.. note:: Board deletion is not supported in the GitLab CE edition. Board lists =========== |