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
Tatuya Kamada
gitlab-ce
Commits
441e6dcf
Commit
441e6dcf
authored
Feb 11, 2014
by
Marin Jankovski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Update api project documentation to include project name as attribute.
parent
e1c1e882
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
15 additions
and
15 deletions
+15
-15
doc/api/projects.md
doc/api/projects.md
+15
-15
No files found.
doc/api/projects.md
View file @
441e6dcf
...
@@ -162,7 +162,7 @@ GET /projects/:id/events
...
@@ -162,7 +162,7 @@ GET /projects/:id/events
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
```
json
```
json
...
@@ -290,7 +290,7 @@ GET /projects/:id/members
...
@@ -290,7 +290,7 @@ GET /projects/:id/members
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`query`
(optional) - Query string to search for members
+
`query`
(optional) - Query string to search for members
...
@@ -304,7 +304,7 @@ GET /projects/:id/members/:user_id
...
@@ -304,7 +304,7 @@ GET /projects/:id/members/:user_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`user_id`
(required) - The ID of a user
+
`user_id`
(required) - The ID of a user
```
json
```
json
...
@@ -332,7 +332,7 @@ POST /projects/:id/members
...
@@ -332,7 +332,7 @@ POST /projects/:id/members
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
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
...
@@ -347,7 +347,7 @@ PUT /projects/:id/members/:user_id
...
@@ -347,7 +347,7 @@ PUT /projects/:id/members/:user_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
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
...
@@ -362,7 +362,7 @@ DELETE /projects/:id/members/:user_id
...
@@ -362,7 +362,7 @@ DELETE /projects/:id/members/:user_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`user_id`
(required) - The ID of a team member
+
`user_id`
(required) - The ID of a team member
This method is idempotent and can be called multiple times with the same parameters.
This method is idempotent and can be called multiple times with the same parameters.
...
@@ -383,7 +383,7 @@ GET /projects/:id/hooks
...
@@ -383,7 +383,7 @@ GET /projects/:id/hooks
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
### Get project hook
### Get project hook
...
@@ -396,7 +396,7 @@ GET /projects/:id/hooks/:hook_id
...
@@ -396,7 +396,7 @@ GET /projects/:id/hooks/:hook_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`hook_id`
(required) - The ID of a project hook
+
`hook_id`
(required) - The ID of a project hook
```
json
```
json
...
@@ -422,7 +422,7 @@ POST /projects/:id/hooks
...
@@ -422,7 +422,7 @@ POST /projects/:id/hooks
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`url`
(required) - The hook URL
+
`url`
(required) - The hook URL
+
`push_events`
- Trigger hook on push events
+
`push_events`
- Trigger hook on push events
+
`issues_events`
- Trigger hook on issues events
+
`issues_events`
- Trigger hook on issues events
...
@@ -439,7 +439,7 @@ PUT /projects/:id/hooks/:hook_id
...
@@ -439,7 +439,7 @@ PUT /projects/:id/hooks/:hook_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
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
+
`push_events`
- Trigger hook on push events
+
`push_events`
- Trigger hook on push events
...
@@ -458,7 +458,7 @@ DELETE /projects/:id/hooks/:hook_id
...
@@ -458,7 +458,7 @@ DELETE /projects/:id/hooks/:hook_id
Parameters:
Parameters:
+
`id`
(required) - The ID or NAME of a project
+
`id`
(required) - The ID or NAME
SPACE/PROJECT_NAME
of a project
+
`hook_id`
(required) - The ID of hook to delete
+
`hook_id`
(required) - The ID of hook to delete
Note the JSON response differs if the hook is available or not. If the project hook
Note the JSON response differs if the hook is available or not. If the project hook
...
@@ -477,7 +477,7 @@ GET /projects/:id/repository/branches
...
@@ -477,7 +477,7 @@ GET /projects/:id/repository/branches
Parameters:
Parameters:
+
`id`
(required) - The ID o
f the
project
+
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of a
project
```
json
```
json
[
[
...
@@ -539,7 +539,7 @@ GET /projects/:id/repository/branches/:branch
...
@@ -539,7 +539,7 @@ GET /projects/:id/repository/branches/:branch
Parameters:
Parameters:
+
`id`
(required) - The ID o
f the project.
+
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of a project
+
`branch`
(required) - The name of the branch.
+
`branch`
(required) - The name of the branch.
...
@@ -553,7 +553,7 @@ PUT /projects/:id/repository/branches/:branch/protect
...
@@ -553,7 +553,7 @@ PUT /projects/:id/repository/branches/:branch/protect
Parameters:
Parameters:
+
`id`
(required) - The ID o
f the project.
+
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of a project
+
`branch`
(required) - The name of the branch.
+
`branch`
(required) - The name of the branch.
...
@@ -567,7 +567,7 @@ PUT /projects/:id/repository/branches/:branch/unprotect
...
@@ -567,7 +567,7 @@ PUT /projects/:id/repository/branches/:branch/unprotect
Parameters:
Parameters:
+
`id`
(required) - The ID o
f the project.
+
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of a project
+
`branch`
(required) - The name of the branch.
+
`branch`
(required) - The name of the branch.
...
...
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