deac/gitlabhq
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #2330 from gitlabhq/v4.0-api-fixes

Browse source 
V4.0 API fixes
This commit is contained in:
Dmitriy Zaporozhets 2012-12-22 00:43:17 -08:00
commit 8fe58ed541
16 changed files with 90 additions and 95 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/views/layouts/_init_auto_complete.html.haml
View file

@ -1,6 +1,6 @@
:javascript :javascript
$(function() { $(function() {
GitLab.GfmAutoComplete.Members.url = "#{ "/api/v2/projects/#{@project.id}/members" if @project }"; GitLab.GfmAutoComplete.Members.url = "#{ "/api/v3/projects/#{@project.id}/members" if @project }";
GitLab.GfmAutoComplete.Members.params.private_token = "#{current_user.private_token}"; GitLab.GfmAutoComplete.Members.params.private_token = "#{current_user.private_token}";
GitLab.GfmAutoComplete.Emoji.data = #{raw emoji_autocomplete_source}; GitLab.GfmAutoComplete.Emoji.data = #{raw emoji_autocomplete_source};

2
doc/api/README.md
View file

@ -15,7 +15,7 @@ API requests should be prefixed with `api` and the API version. The API version
Example of a valid API request: Example of a valid API request:
``` ```
GET http://example.com/api/v2/projects?private_token=QVy1PB7sTxfy4pqfZM1U GET http://example.com/api/v3/projects?private_token=QVy1PB7sTxfy4pqfZM1U
``` ```
The API uses JSON to serialize data. You don't need to specify `.json` at the end of API URL. The API uses JSON to serialize data. You don't need to specify `.json` at the end of API URL.

8
doc/api/issues.md
View file

@ -78,7 +78,7 @@ GET /projects/:id/issues
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
## Single issue ## Single issue
@ -90,7 +90,7 @@ GET /projects/:id/issues/:issue_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of a project issue + `issue_id` (required) - The ID of a project issue
```json ```json
@ -143,7 +143,7 @@ POST /projects/:id/issues
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `title` (required) - The title of an issue + `title` (required) - The title of an issue
+ `description` (optional) - The description of an issue + `description` (optional) - The description of an issue
+ `assignee_id` (optional) - The ID of a user to assign issue + `assignee_id` (optional) - The ID of a user to assign issue
@ -162,7 +162,7 @@ PUT /projects/:id/issues/:issue_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of a project's issue + `issue_id` (required) - The ID of a project's issue
+ `title` (optional) - The title of an issue + `title` (optional) - The title of an issue
+ `description` (optional) - The description of an issue + `description` (optional) - The description of an issue

10
doc/api/merge_requests.md
View file

@ -8,7 +8,7 @@ GET /projects/:id/merge_requests
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
```json ```json
[ [
@ -50,7 +50,7 @@ GET /projects/:id/merge_request/:merge_request_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `merge_request_id` (required) - The ID of MR + `merge_request_id` (required) - The ID of MR
```json ```json
@ -92,7 +92,7 @@ POST /projects/:id/merge_requests
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `source_branch` (required) - The source branch + `source_branch` (required) - The source branch
+ `target_branch` (required) - The target branch + `target_branch` (required) - The target branch
+ `assignee_id` - Assignee user ID + `assignee_id` - Assignee user ID
@ -136,7 +136,7 @@ PUT /projects/:id/merge_request/:merge_request_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `merge_request_id` (required) - ID of MR + `merge_request_id` (required) - ID of MR
+ `source_branch` - The source branch + `source_branch` - The source branch
+ `target_branch` - The target branch + `target_branch` - The target branch
@ -182,7 +182,7 @@ POST /projects/:id/merge_request/:merge_request_id/comments
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `merge_request_id` (required) - ID of MR + `merge_request_id` (required) - ID of MR
+ `note` (required) - Text of comment + `note` (required) - Text of comment

8
doc/api/milestones.md
View file

@ -8,7 +8,7 @@ GET /projects/:id/milestones
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
## Single milestone ## Single milestone
@ -20,7 +20,7 @@ GET /projects/:id/milestones/:milestone_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `milestone_id` (required) - The ID of a project milestone + `milestone_id` (required) - The ID of a project milestone
## New milestone ## New milestone
@ -33,7 +33,7 @@ POST /projects/:id/milestones
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `milestone_id` (required) - The ID of a project milestone + `milestone_id` (required) - The ID of a project milestone
+ `title` (required) - The title of an milestone + `title` (required) - The title of an milestone
+ `description` (optional) - The description of the milestone + `description` (optional) - The description of the milestone
@ -49,7 +49,7 @@ PUT /projects/:id/milestones/:milestone_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `milestone_id` (required) - The ID of a project milestone + `milestone_id` (required) - The ID of a project milestone
+ `title` (optional) - The title of a milestone + `title` (optional) - The title of a milestone
+ `description` (optional) - The description of a milestone + `description` (optional) - The description of a milestone

18
doc/api/notes.md
View file

@ -28,7 +28,7 @@ GET /projects/:id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
### List issue notes ### List issue notes
@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of an issue + `issue_id` (required) - The ID of an issue
### List snippet notes ### List snippet notes
@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a snippet + `snippet_id` (required) - The ID of a snippet
## Single note ## Single note
@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `note_id` (required) - The ID of a wall note + `note_id` (required) - The ID of a wall note
### Single issue note ### Single issue note
@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of a project issue + `issue_id` (required) - The ID of a project issue
+ `note_id` (required) - The ID of an issue note + `note_id` (required) - The ID of an issue note
@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project snippet + `snippet_id` (required) - The ID of a project snippet
+ `note_id` (required) - The ID of an snippet note + `note_id` (required) - The ID of an snippet note
@ -111,7 +111,7 @@ POST /projects/:id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `body` (required) - The content of a note + `body` (required) - The content of a note
Will return created note with status `201 Created` on success, or `404 Not found` on fail. Will return created note with status `201 Created` on success, or `404 Not found` on fail.
@ -127,7 +127,7 @@ POST /projects/:id/issues/:issue_id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `issue_id` (required) - The ID of an issue + `issue_id` (required) - The ID of an issue
+ `body` (required) - The content of a note + `body` (required) - The content of a note
@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of an snippet + `snippet_id` (required) - The ID of an snippet
+ `body` (required) - The content of a note + `body` (required) - The content of a note

26
doc/api/projects.md
View file

@ -10,7 +10,6 @@ GET /projects
[ [
{ {
"id": 3, "id": 3,
"code": "rails",
"name": "rails", "name": "rails",
"description": null, "description": null,
"path": "rails", "path": "rails",
@ -32,7 +31,6 @@ GET /projects
}, },
{ {
"id": 5, "id": 5,
"code": "gitlab",
"name": "gitlab", "name": "gitlab",
"description": null, "description": null,
"path": "gitlab", "path": "gitlab",
@ -65,12 +63,11 @@ GET /projects/:id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
```json ```json
{ {
"id": 5, "id": 5,
"code": "gitlab",
"name": "gitlab", "name": "gitlab",
"description": null, "description": null,
"path": "gitlab", "path": "gitlab",
@ -103,7 +100,6 @@ POST /projects
Parameters: Parameters:
+ `name` (required) - new project name + `name` (required) - new project name
+ `code` (optional) - new project code, uses project name if not set
+ `path` (optional) - new project path, uses project name if not set + `path` (optional) - new project path, uses project name if not set
+ `description` (optional) - short project description + `description` (optional) - short project description
+ `default_branch` (optional) - 'master' by default + `default_branch` (optional) - 'master' by default
@ -125,7 +121,7 @@ GET /projects/:id/members
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `query` - Query string + `query` - Query string
## Get project team member ## Get project team member
@ -138,7 +134,7 @@ GET /projects/:id/members/:user_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `user_id` (required) - The ID of a user + `user_id` (required) - The ID of a user
```json ```json
@ -164,7 +160,7 @@ POST /projects/:id/members
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `user_id` (required) - The ID of a user to add + `user_id` (required) - The ID of a user to add
+ `access_level` (required) - Project access level + `access_level` (required) - Project access level
@ -180,7 +176,7 @@ PUT /projects/:id/members/:user_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `user_id` (required) - The ID of a team member + `user_id` (required) - The ID of a team member
+ `access_level` (required) - Project access level + `access_level` (required) - Project access level
@ -196,7 +192,7 @@ DELETE /projects/:id/members/:user_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `user_id` (required) - The ID of a team member + `user_id` (required) - The ID of a team member
Status code `200` will be returned on success. Status code `200` will be returned on success.
@ -211,7 +207,7 @@ GET /projects/:id/hooks
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
Will return hooks with status `200 OK` on success, or `404 Not found` on fail. Will return hooks with status `200 OK` on success, or `404 Not found` on fail.
@ -225,7 +221,7 @@ GET /projects/:id/hooks/:hook_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `hook_id` (required) - The ID of a project hook + `hook_id` (required) - The ID of a project hook
Will return hook with status `200 OK` on success, or `404 Not found` on fail. Will return hook with status `200 OK` on success, or `404 Not found` on fail.
@ -240,7 +236,7 @@ POST /projects/:id/hooks
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `url` (required) - The hook URL + `url` (required) - The hook URL
Will return status `201 Created` on success, or `404 Not found` on fail. Will return status `201 Created` on success, or `404 Not found` on fail.
@ -255,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `hook_id` (required) - The ID of a project hook + `hook_id` (required) - The ID of a project hook
+ `url` (required) - The hook URL + `url` (required) - The hook URL
@ -272,7 +268,7 @@ DELETE /projects/:id/hooks
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `hook_id` (required) - The ID of hook to delete + `hook_id` (required) - The ID of hook to delete
Will return status `200 OK` on success, or `404 Not found` on fail. Will return status `200 OK` on success, or `404 Not found` on fail.

10
doc/api/repositories.md
View file

@ -8,7 +8,7 @@ GET /projects/:id/repository/branches
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
```json ```json
[ [
@ -48,7 +48,7 @@ GET /projects/:id/repository/branches/:branch
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `branch` (required) - The name of the branch + `branch` (required) - The name of the branch
```json ```json
@ -87,7 +87,7 @@ GET /projects/:id/repository/tags
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
```json ```json
[ [
@ -125,7 +125,7 @@ GET /projects/:id/repository/commits
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `ref_name` (optional) - The name of a repository branch or tag + `ref_name` (optional) - The name of a repository branch or tag
```json ```json
@ -159,7 +159,7 @@ GET /projects/:id/repository/commits/:sha/blob
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `sha` (required) - The commit or branch name + `sha` (required) - The commit or branch name
+ `filepath` (required) - The path the file + `filepath` (required) - The path the file

12
doc/api/snippets.md
View file

@ -8,7 +8,7 @@ GET /projects/:id/snippets
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
## Single snippet ## Single snippet
@ -20,7 +20,7 @@ GET /projects/:id/snippets/:snippet_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet + `snippet_id` (required) - The ID of a project's snippet
```json ```json
@ -52,7 +52,7 @@ GET /projects/:id/snippets/:snippet_id/raw
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet + `snippet_id` (required) - The ID of a project's snippet
## New snippet ## New snippet
@ -65,7 +65,7 @@ POST /projects/:id/snippets
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `title` (required) - The title of a snippet + `title` (required) - The title of a snippet
+ `file_name` (required) - The name of a snippet file + `file_name` (required) - The name of a snippet file
+ `lifetime` (optional) - The expiration date of a snippet + `lifetime` (optional) - The expiration date of a snippet
@ -83,7 +83,7 @@ PUT /projects/:id/snippets/:snippet_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet + `snippet_id` (required) - The ID of a project's snippet
+ `title` (optional) - The title of a snippet + `title` (optional) - The title of a snippet
+ `file_name` (optional) - The name of a snippet file + `file_name` (optional) - The name of a snippet file
@ -102,7 +102,7 @@ DELETE /projects/:id/snippets/:snippet_id
Parameters: Parameters:
+ `id` (required) - The ID or code name of a project + `id` (required) - The ID of a project
+ `snippet_id` (required) - The ID of a project's snippet + `snippet_id` (required) - The ID of a project's snippet
Status code `200` will be returned on success. Status code `200` will be returned on success.

2
lib/api.rb
View file

@ -2,7 +2,7 @@ Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file}
module Gitlab module Gitlab
class API < Grape::API class API < Grape::API
version 'v2', using: :path version 'v3', using: :path
rescue_from ActiveRecord::RecordNotFound do rescue_from ActiveRecord::RecordNotFound do
rack_response({'message' => '404 Not found'}.to_json, 404) rack_response({'message' => '404 Not found'}.to_json, 404)

2
lib/api/entities.rb
View file

@ -18,7 +18,7 @@ module Gitlab
end end
class Project < Grape::Entity class Project < Grape::Entity
expose :id, :code, :name, :description, :path, :default_branch expose :id, :name, :description, :path, :default_branch
expose :owner, using: Entities::UserBasic expose :owner, using: Entities::UserBasic
expose :private_flag, as: :private expose :private_flag, as: :private
expose :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at expose :issues_enabled, :merge_requests_enabled, :wall_enabled, :wiki_enabled, :created_at

10
lib/api/issues.rb
View file

@ -17,7 +17,7 @@ module Gitlab
# Get a list of project issues # Get a list of project issues
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/issues # GET /projects/:id/issues
get ":id/issues" do get ":id/issues" do
@ -27,7 +27,7 @@ module Gitlab
# Get a single project issue # Get a single project issue
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# issue_id (required) - The ID of a project issue # issue_id (required) - The ID of a project issue
# Example Request: # Example Request:
# GET /projects/:id/issues/:issue_id # GET /projects/:id/issues/:issue_id
@ -39,7 +39,7 @@ module Gitlab
# Create a new project issue # Create a new project issue
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# title (required) - The title of an issue # title (required) - The title of an issue
# description (optional) - The description of an issue # description (optional) - The description of an issue
# assignee_id (optional) - The ID of a user to assign issue # assignee_id (optional) - The ID of a user to assign issue
@ -62,7 +62,7 @@ module Gitlab
# Update an existing issue # Update an existing issue
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# issue_id (required) - The ID of a project issue # issue_id (required) - The ID of a project issue
# title (optional) - The title of an issue # title (optional) - The title of an issue
# description (optional) - The description of an issue # description (optional) - The description of an issue
@ -88,7 +88,7 @@ module Gitlab
# Delete a project issue (deprecated) # Delete a project issue (deprecated)
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# issue_id (required) - The ID of a project issue # issue_id (required) - The ID of a project issue
# Example Request: # Example Request:
# DELETE /projects/:id/issues/:issue_id # DELETE /projects/:id/issues/:issue_id

10
lib/api/merge_requests.rb
View file

@ -8,7 +8,7 @@ module Gitlab
# List merge requests # List merge requests
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# #
# Example: # Example:
# GET /projects/:id/merge_requests # GET /projects/:id/merge_requests
@ -22,7 +22,7 @@ module Gitlab
# Show MR # Show MR
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# merge_request_id (required) - The ID of MR # merge_request_id (required) - The ID of MR
# #
# Example: # Example:
@ -40,7 +40,7 @@ module Gitlab
# #
# Parameters: # Parameters:
# #
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# source_branch (required) - The source branch # source_branch (required) - The source branch
# target_branch (required) - The target branch # target_branch (required) - The target branch
# assignee_id - Assignee user ID # assignee_id - Assignee user ID
@ -67,7 +67,7 @@ module Gitlab
# Update MR # Update MR
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# merge_request_id (required) - ID of MR # merge_request_id (required) - ID of MR
# source_branch - The source branch # source_branch - The source branch
# target_branch - The target branch # target_branch - The target branch
@ -95,7 +95,7 @@ module Gitlab
# Post comment to merge request # Post comment to merge request
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# merge_request_id (required) - ID of MR # merge_request_id (required) - ID of MR
# note (required) - Text of comment # note (required) - Text of comment
# Examples: # Examples:

8
lib/api/milestones.rb
View file

@ -7,7 +7,7 @@ module Gitlab
# Get a list of project milestones # Get a list of project milestones
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/milestones # GET /projects/:id/milestones
get ":id/milestones" do get ":id/milestones" do
@ -19,7 +19,7 @@ module Gitlab
# Get a single project milestone # Get a single project milestone
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# milestone_id (required) - The ID of a project milestone # milestone_id (required) - The ID of a project milestone
# Example Request: # Example Request:
# GET /projects/:id/milestones/:milestone_id # GET /projects/:id/milestones/:milestone_id
@ -33,7 +33,7 @@ module Gitlab
# Create a new project milestone # Create a new project milestone
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of the project # id (required) - The ID of the project
# title (required) - The title of the milestone # title (required) - The title of the milestone
# description (optional) - The description of the milestone # description (optional) - The description of the milestone
# due_date (optional) - The due date of the milestone # due_date (optional) - The due date of the milestone
@ -54,7 +54,7 @@ module Gitlab
# Update an existing project milestone # Update an existing project milestone
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# milestone_id (required) - The ID of a project milestone # milestone_id (required) - The ID of a project milestone
# title (optional) - The title of a milestone # title (optional) - The title of a milestone
# description (optional) - The description of a milestone # description (optional) - The description of a milestone

12
lib/api/notes.rb
View file

@ -9,7 +9,7 @@ module Gitlab
# Get a list of project wall notes # Get a list of project wall notes
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/notes # GET /projects/:id/notes
get ":id/notes" do get ":id/notes" do
@ -20,7 +20,7 @@ module Gitlab
# Get a single project wall note # Get a single project wall note
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# note_id (required) - The ID of a note # note_id (required) - The ID of a note
# Example Request: # Example Request:
# GET /projects/:id/notes/:note_id # GET /projects/:id/notes/:note_id
@ -32,7 +32,7 @@ module Gitlab
# Create a new project wall note # Create a new project wall note
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# body (required) - The content of a note # body (required) - The content of a note
# Example Request: # Example Request:
# POST /projects/:id/notes # POST /projects/:id/notes
@ -54,7 +54,7 @@ module Gitlab
# Get a list of project +noteable+ notes # Get a list of project +noteable+ notes
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet # noteable_id (required) - The ID of an issue or snippet
# Example Request: # Example Request:
# GET /projects/:id/issues/:noteable_id/notes # GET /projects/:id/issues/:noteable_id/notes
@ -67,7 +67,7 @@ module Gitlab
# Get a single +noteable+ note # Get a single +noteable+ note
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet # noteable_id (required) - The ID of an issue or snippet
# note_id (required) - The ID of a note # note_id (required) - The ID of a note
# Example Request: # Example Request:
@ -82,7 +82,7 @@ module Gitlab
# Create a new +noteable+ note # Create a new +noteable+ note
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet # noteable_id (required) - The ID of an issue or snippet
# body (required) - The content of a note # body (required) - The content of a note
# Example Request: # Example Request:

45
lib/api/projects.rb
View file

@ -16,7 +16,7 @@ module Gitlab
# Get a single project # Get a single project
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id # GET /projects/:id
get ":id" do get ":id" do
@ -27,7 +27,6 @@ module Gitlab
# #
# Parameters: # Parameters:
# name (required) - name for new project # name (required) - name for new project
# code (optional) - code for new project, uses project name if not set
# path (optional) - path for new project, uses project name if not set # path (optional) - path for new project, uses project name if not set
# description (optional) - short project description # description (optional) - short project description
# default_branch (optional) - 'master' by default # default_branch (optional) - 'master' by default
@ -56,7 +55,7 @@ module Gitlab
# Get a project team members # Get a project team members
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# query - Query string # query - Query string
# Example Request: # Example Request:
# GET /projects/:id/members # GET /projects/:id/members
@ -72,7 +71,7 @@ module Gitlab
# Get a project team members # Get a project team members
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# user_id (required) - The ID of a user # user_id (required) - The ID of a user
# Example Request: # Example Request:
# GET /projects/:id/members/:user_id # GET /projects/:id/members/:user_id
@ -84,7 +83,7 @@ module Gitlab
# Add a new project team member # Add a new project team member
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# user_id (required) - The ID of a user # user_id (required) - The ID of a user
# access_level (required) - Project access level # access_level (required) - Project access level
# Example Request: # Example Request:
@ -107,7 +106,7 @@ module Gitlab
# Update project team member # Update project team member
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# user_id (required) - The ID of a team member # user_id (required) - The ID of a team member
# access_level (required) - Project access level # access_level (required) - Project access level
# Example Request: # Example Request:
@ -127,7 +126,7 @@ module Gitlab
# Remove a team member from project # Remove a team member from project
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# user_id (required) - The ID of a team member # user_id (required) - The ID of a team member
# Example Request: # Example Request:
# DELETE /projects/:id/members/:user_id # DELETE /projects/:id/members/:user_id
@ -140,7 +139,7 @@ module Gitlab
# Get project hooks # Get project hooks
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/hooks # GET /projects/:id/hooks
get ":id/hooks" do get ":id/hooks" do
@ -152,7 +151,7 @@ module Gitlab
# Get a project hook # Get a project hook
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# hook_id (required) - The ID of a project hook # hook_id (required) - The ID of a project hook
# Example Request: # Example Request:
# GET /projects/:id/hooks/:hook_id # GET /projects/:id/hooks/:hook_id
@ -165,7 +164,7 @@ module Gitlab
# Add hook to project # Add hook to project
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# url (required) - The hook URL # url (required) - The hook URL
# Example Request: # Example Request:
# POST /projects/:id/hooks # POST /projects/:id/hooks
@ -182,7 +181,7 @@ module Gitlab
# Update an existing project hook # Update an existing project hook
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# hook_id (required) - The ID of a project hook # hook_id (required) - The ID of a project hook
# url (required) - The hook URL # url (required) - The hook URL
# Example Request: # Example Request:
@ -203,7 +202,7 @@ module Gitlab
# Delete project hook # Delete project hook
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# hook_id (required) - The ID of hook to delete # hook_id (required) - The ID of hook to delete
# Example Request: # Example Request:
# DELETE /projects/:id/hooks # DELETE /projects/:id/hooks
@ -216,7 +215,7 @@ module Gitlab
# Get a project repository branches # Get a project repository branches
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/repository/branches # GET /projects/:id/repository/branches
get ":id/repository/branches" do get ":id/repository/branches" do
@ -226,7 +225,7 @@ module Gitlab
# Get a single branch # Get a single branch
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# branch (required) - The name of the branch # branch (required) - The name of the branch
# Example Request: # Example Request:
# GET /projects/:id/repository/branches/:branch # GET /projects/:id/repository/branches/:branch
@ -238,7 +237,7 @@ module Gitlab
# Get a project repository tags # Get a project repository tags
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/repository/tags # GET /projects/:id/repository/tags
get ":id/repository/tags" do get ":id/repository/tags" do
@ -248,7 +247,7 @@ module Gitlab
# Get a project repository commits # Get a project repository commits
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# ref_name (optional) - The name of a repository branch or tag # ref_name (optional) - The name of a repository branch or tag
# Example Request: # Example Request:
# GET /projects/:id/repository/commits # GET /projects/:id/repository/commits
@ -266,7 +265,7 @@ module Gitlab
# Get a project snippets # Get a project snippets
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# Example Request: # Example Request:
# GET /projects/:id/snippets # GET /projects/:id/snippets
get ":id/snippets" do get ":id/snippets" do
@ -276,7 +275,7 @@ module Gitlab
# Get a project snippet # Get a project snippet
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet # snippet_id (required) - The ID of a project snippet
# Example Request: # Example Request:
# GET /projects/:id/snippets/:snippet_id # GET /projects/:id/snippets/:snippet_id
@ -288,7 +287,7 @@ module Gitlab
# Create a new project snippet # Create a new project snippet
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# title (required) - The title of a snippet # title (required) - The title of a snippet
# file_name (required) - The name of a snippet file # file_name (required) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet # lifetime (optional) - The expiration date of a snippet
@ -314,7 +313,7 @@ module Gitlab
# Update an existing project snippet # Update an existing project snippet
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet # snippet_id (required) - The ID of a project snippet
# title (optional) - The title of a snippet # title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file # file_name (optional) - The name of a snippet file
@ -340,7 +339,7 @@ module Gitlab
# Delete a project snippet # Delete a project snippet
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet # snippet_id (required) - The ID of a project snippet
# Example Request: # Example Request:
# DELETE /projects/:id/snippets/:snippet_id # DELETE /projects/:id/snippets/:snippet_id
@ -354,7 +353,7 @@ module Gitlab
# Get a raw project snippet # Get a raw project snippet
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet # snippet_id (required) - The ID of a project snippet
# Example Request: # Example Request:
# GET /projects/:id/snippets/:snippet_id/raw # GET /projects/:id/snippets/:snippet_id/raw
@ -367,7 +366,7 @@ module Gitlab
# Get a raw file contents # Get a raw file contents
# #
# Parameters: # Parameters:
# id (required) - The ID or code name of a project # id (required) - The ID of a project
# sha (required) - The commit or branch name # sha (required) - The commit or branch name
# filepath (required) - The path to the file to display # filepath (required) - The path to the file to display
# Example Request: # Example Request: