refactor API and improve docs
This commit is contained in:
parent
84a3f8fca4
commit
0d67f209fc
3 changed files with 89 additions and 53 deletions
50
lib/api/projects.rb
Normal file
50
lib/api/projects.rb
Normal file
|
@ -0,0 +1,50 @@
|
|||
module Gitlab
|
||||
# Projects API
|
||||
class Projects < Grape::API
|
||||
before { authenticate! }
|
||||
|
||||
resource :projects do
|
||||
# Get a projects list for authenticated user
|
||||
#
|
||||
# Example Request:
|
||||
# GET /projects
|
||||
get do
|
||||
@projects = current_user.projects
|
||||
present @projects, :with => Entities::Project
|
||||
end
|
||||
|
||||
# Get a single project
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The code of a project
|
||||
# Example Request:
|
||||
# GET /projects/:id
|
||||
get ":id" do
|
||||
@project = current_user.projects.find_by_code(params[:id])
|
||||
present @project, :with => Entities::Project
|
||||
end
|
||||
|
||||
# Get a project repository branches
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The code of a project
|
||||
# Example Request:
|
||||
# GET /projects/:id/repository/branches
|
||||
get ":id/repository/branches" do
|
||||
@project = current_user.projects.find_by_code(params[:id])
|
||||
present @project.repo.heads.sort_by(&:name), :with => Entities::ProjectRepositoryBranches
|
||||
end
|
||||
|
||||
# Get a project repository tags
|
||||
#
|
||||
# Parameters:
|
||||
# id (required) - The code of a project
|
||||
# Example Request:
|
||||
# GET /projects/:id/repository/tags
|
||||
get ":id/repository/tags" do
|
||||
@project = current_user.projects.find_by_code(params[:id])
|
||||
present @project.repo.tags.sort_by(&:name).reverse, :with => Entities::ProjectRepositoryTags
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
Loading…
Add table
Add a link
Reference in a new issue