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
1
Merge Requests
1
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
nexedi
gitlab-ce
Commits
8c101f9f
Commit
8c101f9f
authored
Aug 30, 2016
by
Achilleas Pipinellis
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Mention that the `:id` of a project can also be `NAMESPACE/PROJECT_NAME`
[ci skip]
parent
2778dec1
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
18 additions
and
18 deletions
+18
-18
doc/api/commits.md
doc/api/commits.md
+7
-7
doc/api/projects.md
doc/api/projects.md
+11
-11
No files found.
doc/api/commits.md
View file @
8c101f9f
...
@@ -10,7 +10,7 @@ GET /projects/:id/repository/commits
...
@@ -10,7 +10,7 @@ GET /projects/:id/repository/commits
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project |
|
`id`
| integer | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`ref_name`
| string | no | The name of a repository branch or tag or if not given the default branch |
|
`ref_name`
| string | no | The name of a repository branch or tag or if not given the default branch |
|
`since`
| string | no | Only commits after or in this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
|
`since`
| string | no | Only commits after or in this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
|
`until`
| string | no | Only commits before or in this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
|
`until`
| string | no | Only commits before or in this date will be returned in ISO 8601 format YYYY-MM-DDTHH:MM:SSZ |
...
@@ -58,7 +58,7 @@ Parameters:
...
@@ -58,7 +58,7 @@ Parameters:
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project |
|
`id`
| integer | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
```
bash
```
bash
...
@@ -102,7 +102,7 @@ Parameters:
...
@@ -102,7 +102,7 @@ Parameters:
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project |
|
`id`
| integer | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
```
bash
```
bash
...
@@ -138,7 +138,7 @@ Parameters:
...
@@ -138,7 +138,7 @@ Parameters:
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project |
|
`id`
| integer | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
|
`sha`
| string | yes | The commit hash or name of a repository branch or tag |
```
bash
```
bash
...
@@ -187,7 +187,7 @@ POST /projects/:id/repository/commits/:sha/comments
...
@@ -187,7 +187,7 @@ POST /projects/:id/repository/commits/:sha/comments
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project |
|
`id`
| integer | yes | The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit SHA or name of a repository branch or tag |
|
`sha`
| string | yes | The commit SHA or name of a repository branch or tag |
|
`note`
| string | yes | The text of the comment |
|
`note`
| string | yes | The text of the comment |
|
`path`
| string | no | The file path relative to the repository |
|
`path`
| string | no | The file path relative to the repository |
...
@@ -232,7 +232,7 @@ GET /projects/:id/repository/commits/:sha/statuses
...
@@ -232,7 +232,7 @@ GET /projects/:id/repository/commits/:sha/statuses
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of a project
|
`id`
| integer | yes | The ID of a project
or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit SHA
|
`sha`
| string | yes | The commit SHA
|
`ref_name`
| string | no | The name of a repository branch or tag or, if not given, the default branch
|
`ref_name`
| string | no | The name of a repository branch or tag or, if not given, the default branch
|
`stage`
| string | no | Filter by
[
build stage
](
../ci/yaml/README.md#stages
)
, e.g.,
`test`
|
`stage`
| string | no | Filter by
[
build stage
](
../ci/yaml/README.md#stages
)
, e.g.,
`test`
...
@@ -306,7 +306,7 @@ POST /projects/:id/statuses/:sha
...
@@ -306,7 +306,7 @@ POST /projects/:id/statuses/:sha
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes
| The ID of a project
|
`id`
| integer | yes
| The ID of a project or NAMESPACE/PROJECT_NAME owned by the authenticated user
|
`sha`
| string | yes | The commit SHA
|
`sha`
| string | yes | The commit SHA
|
`state`
| string | yes | The state of the status. Can be one of the following:
`pending`
,
`running`
,
`success`
,
`failed`
,
`canceled`
|
`state`
| string | yes | The state of the status. Can be one of the following:
`pending`
,
`running`
,
`success`
,
`failed`
,
`canceled`
|
`ref`
| string | no | The
`ref`
(branch or tag) to which the status refers
|
`ref`
| string | no | The
`ref`
(branch or tag) to which the status refers
...
...
doc/api/projects.md
View file @
8c101f9f
...
@@ -489,7 +489,7 @@ PUT /projects/:id
...
@@ -489,7 +489,7 @@ PUT /projects/:id
Parameters:
Parameters:
-
`id`
(required) - The ID of a project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME o
f a project
-
`name`
(optional) - project name
-
`name`
(optional) - project name
-
`path`
(optional) - repository name for project
-
`path`
(optional) - repository name for project
-
`description`
(optional) - short project description
-
`description`
(optional) - short project description
...
@@ -519,7 +519,7 @@ POST /projects/fork/:id
...
@@ -519,7 +519,7 @@ POST /projects/fork/:id
Parameters:
Parameters:
-
`id`
(required) - The ID of the project to be forked
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME o
f the project to be forked
### Star a project
### Star a project
...
@@ -532,7 +532,7 @@ POST /projects/:id/star
...
@@ -532,7 +532,7 @@ POST /projects/:id/star
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of the project |
|
`id`
| integer | yes | The ID of the project
or NAMESPACE/PROJECT_NAME
|
```
bash
```
bash
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/5/star"
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/5/star"
...
@@ -599,7 +599,7 @@ DELETE /projects/:id/star
...
@@ -599,7 +599,7 @@ DELETE /projects/:id/star
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of the project |
|
`id`
| integer | yes | The ID of the project
or NAMESPACE/PROJECT_NAME
|
```
bash
```
bash
curl
--request
DELETE
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/5/star"
curl
--request
DELETE
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/5/star"
...
@@ -670,7 +670,7 @@ POST /projects/:id/archive
...
@@ -670,7 +670,7 @@ POST /projects/:id/archive
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of the project |
|
`id`
| integer | yes | The ID of the project
or NAMESPACE/PROJECT_NAME
|
```
bash
```
bash
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/archive"
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/archive"
...
@@ -757,7 +757,7 @@ POST /projects/:id/unarchive
...
@@ -757,7 +757,7 @@ POST /projects/:id/unarchive
| Attribute | Type | Required | Description |
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| --------- | ---- | -------- | ----------- |
|
`id`
| integer | yes | The ID of the project |
|
`id`
| integer | yes | The ID of the project
or NAMESPACE/PROJECT_NAME
|
```
bash
```
bash
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/unarchive"
curl
--request
POST
--header
"PRIVATE-TOKEN: 9koXpg98eAheJpvBs5tK"
"https://gitlab.example.com/api/v3/projects/unarchive"
...
@@ -839,7 +839,7 @@ DELETE /projects/:id
...
@@ -839,7 +839,7 @@ DELETE /projects/:id
Parameters:
Parameters:
-
`id`
(required) - The ID o
f a project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of the project to be forked
## Uploads
## Uploads
...
@@ -853,7 +853,7 @@ POST /projects/:id/uploads
...
@@ -853,7 +853,7 @@ POST /projects/:id/uploads
Parameters:
Parameters:
-
`id`
(required) - The ID o
f the project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of the project to be forked
-
`file`
(required) - The file to be uploaded
-
`file`
(required) - The file to be uploaded
```
json
```
json
...
@@ -882,7 +882,7 @@ POST /projects/:id/share
...
@@ -882,7 +882,7 @@ POST /projects/:id/share
Parameters:
Parameters:
-
`id`
(required) - The ID o
f a project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of the project to be forked
-
`group_id`
(required) - The ID of a group
-
`group_id`
(required) - The ID of a group
-
`group_access`
(required) - Level of permissions for sharing
-
`group_access`
(required) - Level of permissions for sharing
...
@@ -1114,7 +1114,7 @@ POST /projects/:id/fork/:forked_from_id
...
@@ -1114,7 +1114,7 @@ POST /projects/:id/fork/:forked_from_id
Parameters:
Parameters:
-
`id`
(required) - The ID o
f the project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of the project to be forked
-
`forked_from_id:`
(required) - The ID of the project that was forked from
-
`forked_from_id:`
(required) - The ID of the project that was forked from
### Delete an existing forked from relationship
### Delete an existing forked from relationship
...
@@ -1125,7 +1125,7 @@ DELETE /projects/:id/fork
...
@@ -1125,7 +1125,7 @@ DELETE /projects/:id/fork
Parameter:
Parameter:
-
`id`
(required) - The ID o
f the project
-
`id`
(required) - The ID o
r NAMESPACE/PROJECT_NAME of the project to be forked
## Search for projects by name
## Search for projects by name
...
...
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