Method: Gitlab::Client::Boards#edit_board

Defined in:

lib/gitlab/client/boards.rb

#edit_board(project, id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates a board.

Examples:

Gitlab.edit_board(5, 1, name: 'new_name')
Gitlab.edit_board(5, 1, name: 'new_name', assignee_id: 1, milestone_id: 1)

Parameters:

• project (Integer, String) —

  The ID or name of a project.

• id (Integer) —

  The ID of a board.

• options (Hash) (defaults to: {}) —

  A customizable set of options.

Options Hash (options):

• :name(optional) (String) —

  The new name of the board.

• :assignee_id(optional) (Integer) —

  The assignee the board should be scoped to.

• :milestone_id(optional) (Integer) —

  The milestone the board should be scoped to.

• :labels(optional) (String) —

  Comma-separated list of label names which the board should be scoped to.

• :weight(optional) (Integer) —

  The weight range from 0 to 9, to which the board should be scoped to.

Returns:

• (Gitlab::ObjectifiedHash) —

  Information about updated board.

# File 'lib/gitlab/client/boards.rb', line 62

def edit_board(project, id, options = {})
  put("/projects/#{url_encode project}/boards/#{id}", body: options)
end