Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Kazuhiko Shiozaki
gitlab-ce
Commits
8fe58ed5
Commit
8fe58ed5
authored
12 years ago
by
Dmitriy Zaporozhets
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #2330 from gitlabhq/v4.0-api-fixes
V4.0 API fixes
parents
86673a66
eaa99478
No related merge requests found
Changes
16
Show whitespace changes
Inline
Side-by-side
Showing
16 changed files
with
90 additions
and
95 deletions
+90
-95
app/views/layouts/_init_auto_complete.html.haml
app/views/layouts/_init_auto_complete.html.haml
+1
-1
doc/api/README.md
doc/api/README.md
+1
-1
doc/api/issues.md
doc/api/issues.md
+4
-4
doc/api/merge_requests.md
doc/api/merge_requests.md
+5
-5
doc/api/milestones.md
doc/api/milestones.md
+4
-4
doc/api/notes.md
doc/api/notes.md
+9
-9
doc/api/projects.md
doc/api/projects.md
+11
-15
doc/api/repositories.md
doc/api/repositories.md
+5
-5
doc/api/snippets.md
doc/api/snippets.md
+6
-6
lib/api.rb
lib/api.rb
+1
-1
lib/api/entities.rb
lib/api/entities.rb
+1
-1
lib/api/issues.rb
lib/api/issues.rb
+5
-5
lib/api/merge_requests.rb
lib/api/merge_requests.rb
+5
-5
lib/api/milestones.rb
lib/api/milestones.rb
+4
-4
lib/api/notes.rb
lib/api/notes.rb
+6
-6
lib/api/projects.rb
lib/api/projects.rb
+22
-23
No files found.
app/views/layouts/_init_auto_complete.html.haml
View file @
8fe58ed5
:javascript
$
(
function
()
{
GitLab
.
GfmAutoComplete
.
Members
.
url
=
"
#{
"/api/v
2
/projects/#{@project.id}/members"
if
@project
}
"
;
GitLab
.
GfmAutoComplete
.
Members
.
url
=
"
#{
"/api/v
3
/projects/#{@project.id}/members"
if
@project
}
"
;
GitLab
.
GfmAutoComplete
.
Members
.
params
.
private_token
=
"
#{
current_user
.
private_token
}
"
;
GitLab
.
GfmAutoComplete
.
Emoji
.
data
=
#{
raw
emoji_autocomplete_source
}
;
...
...
This diff is collapsed.
Click to expand it.
doc/api/README.md
View file @
8fe58ed5
...
...
@@ -15,7 +15,7 @@ API requests should be prefixed with `api` and the API version. The API version
Example of a valid API request:
```
GET http://example.com/api/v
2
/projects?private_token=QVy1PB7sTxfy4pqfZM1U
GET http://example.com/api/v
3
/projects?private_token=QVy1PB7sTxfy4pqfZM1U
```
The API uses JSON to serialize data. You don't need to specify
`.json`
at the end of API URL.
...
...
This diff is collapsed.
Click to expand it.
doc/api/issues.md
View file @
8fe58ed5
...
...
@@ -78,7 +78,7 @@ GET /projects/:id/issues
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
## Single issue
...
...
@@ -90,7 +90,7 @@ GET /projects/:id/issues/:issue_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of a project issue
```
json
...
...
@@ -143,7 +143,7 @@ POST /projects/:id/issues
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`title`
(required) - The title of an issue
+
`description`
(optional) - The description of an issue
+
`assignee_id`
(optional) - The ID of a user to assign issue
...
...
@@ -162,7 +162,7 @@ PUT /projects/:id/issues/:issue_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of a project's issue
+
`title`
(optional) - The title of an issue
+
`description`
(optional) - The description of an issue
...
...
This diff is collapsed.
Click to expand it.
doc/api/merge_requests.md
View file @
8fe58ed5
...
...
@@ -8,7 +8,7 @@ GET /projects/:id/merge_requests
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
```
json
[
...
...
@@ -50,7 +50,7 @@ GET /projects/:id/merge_request/:merge_request_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`merge_request_id`
(required) - The ID of MR
```
json
...
...
@@ -92,7 +92,7 @@ POST /projects/:id/merge_requests
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`source_branch`
(required) - The source branch
+
`target_branch`
(required) - The target branch
+
`assignee_id`
- Assignee user ID
...
...
@@ -136,7 +136,7 @@ PUT /projects/:id/merge_request/:merge_request_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`merge_request_id`
(required) - ID of MR
+
`source_branch`
- The source branch
+
`target_branch`
- The target branch
...
...
@@ -182,7 +182,7 @@ POST /projects/:id/merge_request/:merge_request_id/comments
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`merge_request_id`
(required) - ID of MR
+
`note`
(required) - Text of comment
...
...
This diff is collapsed.
Click to expand it.
doc/api/milestones.md
View file @
8fe58ed5
...
...
@@ -8,7 +8,7 @@ GET /projects/:id/milestones
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
## Single milestone
...
...
@@ -20,7 +20,7 @@ GET /projects/:id/milestones/:milestone_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`milestone_id`
(required) - The ID of a project milestone
## New milestone
...
...
@@ -33,7 +33,7 @@ POST /projects/:id/milestones
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`milestone_id`
(required) - The ID of a project milestone
+
`title`
(required) - The title of an milestone
+
`description`
(optional) - The description of the milestone
...
...
@@ -49,7 +49,7 @@ PUT /projects/:id/milestones/:milestone_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`milestone_id`
(required) - The ID of a project milestone
+
`title`
(optional) - The title of a milestone
+
`description`
(optional) - The description of a milestone
...
...
This diff is collapsed.
Click to expand it.
doc/api/notes.md
View file @
8fe58ed5
...
...
@@ -28,7 +28,7 @@ GET /projects/:id/notes
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
### List issue notes
...
...
@@ -40,7 +40,7 @@ GET /projects/:id/issues/:issue_id/notes
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of an issue
### List snippet notes
...
...
@@ -53,7 +53,7 @@ GET /projects/:id/snippets/:snippet_id/notes
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a snippet
## Single note
...
...
@@ -68,7 +68,7 @@ GET /projects/:id/notes/:note_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`note_id`
(required) - The ID of a wall note
### Single issue note
...
...
@@ -81,7 +81,7 @@ GET /projects/:id/issues/:issue_id/:notes/:note_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of a project issue
+
`note_id`
(required) - The ID of an issue note
...
...
@@ -95,7 +95,7 @@ GET /projects/:id/issues/:snippet_id/:notes/:note_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a project snippet
+
`note_id`
(required) - The ID of an snippet note
...
...
@@ -111,7 +111,7 @@ POST /projects/:id/notes
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`body`
(required) - The content of a note
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:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`issue_id`
(required) - The ID of an issue
+
`body`
(required) - The content of a note
...
...
@@ -143,7 +143,7 @@ POST /projects/:id/snippets/:snippet_id/notes
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of an snippet
+
`body`
(required) - The content of a note
...
...
This diff is collapsed.
Click to expand it.
doc/api/projects.md
View file @
8fe58ed5
...
...
@@ -10,7 +10,6 @@ GET /projects
[
{
"id"
:
3
,
"code"
:
"rails"
,
"name"
:
"rails"
,
"description"
:
null
,
"path"
:
"rails"
,
...
...
@@ -32,7 +31,6 @@ GET /projects
},
{
"id"
:
5
,
"code"
:
"gitlab"
,
"name"
:
"gitlab"
,
"description"
:
null
,
"path"
:
"gitlab"
,
...
...
@@ -65,12 +63,11 @@ GET /projects/:id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
```
json
{
"id"
:
5
,
"code"
:
"gitlab"
,
"name"
:
"gitlab"
,
"description"
:
null
,
"path"
:
"gitlab"
,
...
...
@@ -103,7 +100,6 @@ POST /projects
Parameters:
+
`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
+
`description`
(optional) - short project description
+
`default_branch`
(optional) - 'master' by default
...
...
@@ -125,7 +121,7 @@ GET /projects/:id/members
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`query`
- Query string
## Get project team member
...
...
@@ -138,7 +134,7 @@ GET /projects/:id/members/:user_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`user_id`
(required) - The ID of a user
```
json
...
...
@@ -164,7 +160,7 @@ POST /projects/:id/members
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`user_id`
(required) - The ID of a user to add
+
`access_level`
(required) - Project access level
...
...
@@ -180,7 +176,7 @@ PUT /projects/:id/members/:user_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`user_id`
(required) - The ID of a team member
+
`access_level`
(required) - Project access level
...
...
@@ -196,7 +192,7 @@ DELETE /projects/:id/members/:user_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`user_id`
(required) - The ID of a team member
Status code
`200`
will be returned on success.
...
...
@@ -211,7 +207,7 @@ GET /projects/:id/hooks
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
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:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`hook_id`
(required) - The ID of a project hook
Will return hook with status
`200 OK`
on success, or
`404 Not found`
on fail.
...
...
@@ -240,7 +236,7 @@ POST /projects/:id/hooks
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`url`
(required) - The hook URL
Will return status
`201 Created`
on success, or
`404 Not found`
on fail.
...
...
@@ -255,7 +251,7 @@ PUT /projects/:id/hooks/:hook_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`hook_id`
(required) - The ID of a project hook
+
`url`
(required) - The hook URL
...
...
@@ -272,7 +268,7 @@ DELETE /projects/:id/hooks
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`hook_id`
(required) - The ID of hook to delete
Will return status
`200 OK`
on success, or
`404 Not found`
on fail.
This diff is collapsed.
Click to expand it.
doc/api/repositories.md
View file @
8fe58ed5
...
...
@@ -8,7 +8,7 @@ GET /projects/:id/repository/branches
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
```
json
[
...
...
@@ -48,7 +48,7 @@ GET /projects/:id/repository/branches/:branch
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`branch`
(required) - The name of the branch
```
json
...
...
@@ -87,7 +87,7 @@ GET /projects/:id/repository/tags
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
```
json
[
...
...
@@ -125,7 +125,7 @@ GET /projects/:id/repository/commits
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`ref_name`
(optional) - The name of a repository branch or tag
```
json
...
...
@@ -159,7 +159,7 @@ GET /projects/:id/repository/commits/:sha/blob
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`sha`
(required) - The commit or branch name
+
`filepath`
(required) - The path the file
...
...
This diff is collapsed.
Click to expand it.
doc/api/snippets.md
View file @
8fe58ed5
...
...
@@ -8,7 +8,7 @@ GET /projects/:id/snippets
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
## Single snippet
...
...
@@ -20,7 +20,7 @@ GET /projects/:id/snippets/:snippet_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a project's snippet
```
json
...
...
@@ -52,7 +52,7 @@ GET /projects/:id/snippets/:snippet_id/raw
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a project's snippet
## New snippet
...
...
@@ -65,7 +65,7 @@ POST /projects/:id/snippets
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`title`
(required) - The title of a snippet
+
`file_name`
(required) - The name of a snippet file
+
`lifetime`
(optional) - The expiration date of a snippet
...
...
@@ -83,7 +83,7 @@ PUT /projects/:id/snippets/:snippet_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a project's snippet
+
`title`
(optional) - The title of a snippet
+
`file_name`
(optional) - The name of a snippet file
...
...
@@ -102,7 +102,7 @@ DELETE /projects/:id/snippets/:snippet_id
Parameters:
+
`id`
(required) - The ID o
r code name o
f a project
+
`id`
(required) - The ID of a project
+
`snippet_id`
(required) - The ID of a project's snippet
Status code
`200`
will be returned on success.
...
...
This diff is collapsed.
Click to expand it.
lib/api.rb
View file @
8fe58ed5
...
...
@@ -2,7 +2,7 @@ Dir["#{Rails.root}/lib/api/*.rb"].each {|file| require file}
module
Gitlab
class
API
<
Grape
::
API
version
'v
2
'
,
using: :path
version
'v
3
'
,
using: :path
rescue_from
ActiveRecord
::
RecordNotFound
do
rack_response
({
'message'
=>
'404 Not found'
}.
to_json
,
404
)
...
...
This diff is collapsed.
Click to expand it.
lib/api/entities.rb
View file @
8fe58ed5
...
...
@@ -18,7 +18,7 @@ module Gitlab
end
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
:private_flag
,
as: :private
expose
:issues_enabled
,
:merge_requests_enabled
,
:wall_enabled
,
:wiki_enabled
,
:created_at
...
...
This diff is collapsed.
Click to expand it.
lib/api/issues.rb
View file @
8fe58ed5
...
...
@@ -17,7 +17,7 @@ module Gitlab
# Get a list of project issues
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/issues
get
":id/issues"
do
...
...
@@ -27,7 +27,7 @@ module Gitlab
# Get a single project issue
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# GET /projects/:id/issues/:issue_id
...
...
@@ -39,7 +39,7 @@ module Gitlab
# Create a new project issue
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# title (required) - The title of an issue
# description (optional) - The description of an issue
# assignee_id (optional) - The ID of a user to assign issue
...
...
@@ -62,7 +62,7 @@ module Gitlab
# Update an existing issue
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# title (optional) - The title of an issue
# description (optional) - The description of an issue
...
...
@@ -88,7 +88,7 @@ module Gitlab
# Delete a project issue (deprecated)
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# issue_id (required) - The ID of a project issue
# Example Request:
# DELETE /projects/:id/issues/:issue_id
...
...
This diff is collapsed.
Click to expand it.
lib/api/merge_requests.rb
View file @
8fe58ed5
...
...
@@ -8,7 +8,7 @@ module Gitlab
# List merge requests
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
#
# Example:
# GET /projects/:id/merge_requests
...
...
@@ -22,7 +22,7 @@ module Gitlab
# Show MR
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# merge_request_id (required) - The ID of MR
#
# Example:
...
...
@@ -40,7 +40,7 @@ module Gitlab
#
# Parameters:
#
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# source_branch (required) - The source branch
# target_branch (required) - The target branch
# assignee_id - Assignee user ID
...
...
@@ -67,7 +67,7 @@ module Gitlab
# Update MR
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# merge_request_id (required) - ID of MR
# source_branch - The source branch
# target_branch - The target branch
...
...
@@ -95,7 +95,7 @@ module Gitlab
# Post comment to merge request
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# merge_request_id (required) - ID of MR
# note (required) - Text of comment
# Examples:
...
...
This diff is collapsed.
Click to expand it.
lib/api/milestones.rb
View file @
8fe58ed5
...
...
@@ -7,7 +7,7 @@ module Gitlab
# Get a list of project milestones
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/milestones
get
":id/milestones"
do
...
...
@@ -19,7 +19,7 @@ module Gitlab
# Get a single project milestone
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# milestone_id (required) - The ID of a project milestone
# Example Request:
# GET /projects/:id/milestones/:milestone_id
...
...
@@ -33,7 +33,7 @@ module Gitlab
# Create a new project milestone
#
# Parameters:
# id (required) - The ID o
r code name o
f the project
# id (required) - The ID of the project
# title (required) - The title of the milestone
# description (optional) - The description of the milestone
# due_date (optional) - The due date of the milestone
...
...
@@ -54,7 +54,7 @@ module Gitlab
# Update an existing project milestone
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# milestone_id (required) - The ID of a project milestone
# title (optional) - The title of a milestone
# description (optional) - The description of a milestone
...
...
This diff is collapsed.
Click to expand it.
lib/api/notes.rb
View file @
8fe58ed5
...
...
@@ -9,7 +9,7 @@ module Gitlab
# Get a list of project wall notes
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/notes
get
":id/notes"
do
...
...
@@ -20,7 +20,7 @@ module Gitlab
# Get a single project wall note
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# note_id (required) - The ID of a note
# Example Request:
# GET /projects/:id/notes/:note_id
...
...
@@ -32,7 +32,7 @@ module Gitlab
# Create a new project wall note
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# body (required) - The content of a note
# Example Request:
# POST /projects/:id/notes
...
...
@@ -54,7 +54,7 @@ module Gitlab
# Get a list of project +noteable+ notes
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# Example Request:
# GET /projects/:id/issues/:noteable_id/notes
...
...
@@ -67,7 +67,7 @@ module Gitlab
# Get a single +noteable+ note
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# note_id (required) - The ID of a note
# Example Request:
...
...
@@ -82,7 +82,7 @@ module Gitlab
# Create a new +noteable+ note
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# noteable_id (required) - The ID of an issue or snippet
# body (required) - The content of a note
# Example Request:
...
...
This diff is collapsed.
Click to expand it.
lib/api/projects.rb
View file @
8fe58ed5
...
...
@@ -16,7 +16,7 @@ module Gitlab
# Get a single project
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id
get
":id"
do
...
...
@@ -27,7 +27,6 @@ module Gitlab
#
# Parameters:
# 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
# description (optional) - short project description
# default_branch (optional) - 'master' by default
...
...
@@ -56,7 +55,7 @@ module Gitlab
# Get a project team members
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# query - Query string
# Example Request:
# GET /projects/:id/members
...
...
@@ -72,7 +71,7 @@ module Gitlab
# Get a project team members
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# user_id (required) - The ID of a user
# Example Request:
# GET /projects/:id/members/:user_id
...
...
@@ -84,7 +83,7 @@ module Gitlab
# Add a new project team member
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# user_id (required) - The ID of a user
# access_level (required) - Project access level
# Example Request:
...
...
@@ -107,7 +106,7 @@ module Gitlab
# Update project team member
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# user_id (required) - The ID of a team member
# access_level (required) - Project access level
# Example Request:
...
...
@@ -127,7 +126,7 @@ module Gitlab
# Remove a team member from project
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# user_id (required) - The ID of a team member
# Example Request:
# DELETE /projects/:id/members/:user_id
...
...
@@ -140,7 +139,7 @@ module Gitlab
# Get project hooks
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/hooks
get
":id/hooks"
do
...
...
@@ -152,7 +151,7 @@ module Gitlab
# Get a project hook
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# hook_id (required) - The ID of a project hook
# Example Request:
# GET /projects/:id/hooks/:hook_id
...
...
@@ -165,7 +164,7 @@ module Gitlab
# Add hook to project
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# url (required) - The hook URL
# Example Request:
# POST /projects/:id/hooks
...
...
@@ -182,7 +181,7 @@ module Gitlab
# Update an existing project hook
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# hook_id (required) - The ID of a project hook
# url (required) - The hook URL
# Example Request:
...
...
@@ -203,7 +202,7 @@ module Gitlab
# Delete project hook
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# hook_id (required) - The ID of hook to delete
# Example Request:
# DELETE /projects/:id/hooks
...
...
@@ -216,7 +215,7 @@ module Gitlab
# Get a project repository branches
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/repository/branches
get
":id/repository/branches"
do
...
...
@@ -226,7 +225,7 @@ module Gitlab
# Get a single branch
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# branch (required) - The name of the branch
# Example Request:
# GET /projects/:id/repository/branches/:branch
...
...
@@ -238,7 +237,7 @@ module Gitlab
# Get a project repository tags
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/repository/tags
get
":id/repository/tags"
do
...
...
@@ -248,7 +247,7 @@ module Gitlab
# Get a project repository commits
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# ref_name (optional) - The name of a repository branch or tag
# Example Request:
# GET /projects/:id/repository/commits
...
...
@@ -266,7 +265,7 @@ module Gitlab
# Get a project snippets
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# Example Request:
# GET /projects/:id/snippets
get
":id/snippets"
do
...
...
@@ -276,7 +275,7 @@ module Gitlab
# Get a project snippet
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id
...
...
@@ -288,7 +287,7 @@ module Gitlab
# Create a new project snippet
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# title (required) - The title of a snippet
# file_name (required) - The name of a snippet file
# lifetime (optional) - The expiration date of a snippet
...
...
@@ -314,7 +313,7 @@ module Gitlab
# Update an existing project snippet
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# title (optional) - The title of a snippet
# file_name (optional) - The name of a snippet file
...
...
@@ -340,7 +339,7 @@ module Gitlab
# Delete a project snippet
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# DELETE /projects/:id/snippets/:snippet_id
...
...
@@ -354,7 +353,7 @@ module Gitlab
# Get a raw project snippet
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# snippet_id (required) - The ID of a project snippet
# Example Request:
# GET /projects/:id/snippets/:snippet_id/raw
...
...
@@ -367,7 +366,7 @@ module Gitlab
# Get a raw file contents
#
# Parameters:
# id (required) - The ID o
r code name o
f a project
# id (required) - The ID of a project
# sha (required) - The commit or branch name
# filepath (required) - The path to the file to display
# Example Request:
...
...
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment