Method: Gitlab::Client::Projects#user_starred_projects

Defined in:

lib/gitlab/client/projects.rb

#user_starred_projects(user_id, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Get a list of visible projects that the given user has starred.

Examples:

Gitlab.user_starred_projects(1)
Gitlab.user_starred_projects(1, { order_by: 'last_activity_at' })
Gitlab.user_starred_projects('username', { order_by: 'name', sort: 'asc' })

Parameters:

• user_id (Integer, String) —

  The ID or username of the user.

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

  A customizable set of options.

Options Hash (options):

• :per_page (String) —

  Number of projects to return per page

• :page (String) —

  The page to retrieve

• :order_by (String) —

  Return projects ordered by id, name, path, created_at, updated_at, or last_activity_at fields.

• :sort (String) —

  Return projects sorted in asc or desc order.

Returns:

• (Array<Gitlab::ObjectifiedHash>)

See Also:

• https://docs.gitlab.com/ee/api/projects.html#list-projects-starred-by-a-user

# File 'lib/gitlab/client/projects.rb', line 556

def user_starred_projects(user_id, options = {})
  get("/users/#{url_encode user_id}/starred_projects", query: options)
end