Method: Gitlab::Client::Projects#edit_project

Defined in:
lib/gitlab/client/projects.rb

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

Updates an existing project.

(Any provided options will be passed to Gitlab. See Gitlab docs for all valid options)

Examples:

Gitlab.edit_project(42)
Gitlab.edit_project(42, { name: 'Project Name' })
Gitlab.edit_project('project-name', { name: 'New Project Name', path: 'new-project-patth' })

Parameters:

  • project (Integer, String) —

    The ID or path of a project.

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

    A customizable set of options

Options Hash (options):

  • :name (String) —

    The name of a project

  • :path (String) —

    The project’s repository name, also used in Gitlab’s URLs

  • :description (String) —

    The description to show in Gitlab

Returns:



475
476
477
 
# File 'lib/gitlab/client/projects.rb', line 475

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