mirror of
https://github.com/wahyd4/gitlabhq.git
synced 2026-08-25 12:36:27 +10:00
Remove deprecated CI API docs for commits and projects
[ci skip]
This commit is contained in:
Grzegorz Bizon
+1
-2
@@ -213,8 +213,7 @@ Example response:
|
||||
|
||||
## Commit status
|
||||
|
||||
Since GitLab 8.1, this is the new commit status API. The documentation in
|
||||
[ci/api/commits](../ci/api/commits.md) is deprecated.
|
||||
Since GitLab 8.1, this is the new commit status API.
|
||||
|
||||
### Get the status of a commit
|
||||
|
||||
|
||||
@@ -20,4 +20,3 @@ You need to prepend this prefix to all examples in this documentation, like:
|
||||
|
||||
- [Builds](builds.md)
|
||||
- [Runners](runners.md)
|
||||
- [Commits](commits.md)
|
||||
|
||||
@@ -1,108 +0,0 @@
|
||||
# Commits API
|
||||
|
||||
**DEPRECATED**
|
||||
|
||||
Since GitLab 8.1, there is a new commit status API. Please see the [revised
|
||||
documentation](../../api/commits.md#commit-status).
|
||||
|
||||
---
|
||||
|
||||
__Authentication is done by GitLab CI project token__
|
||||
|
||||
## Commits
|
||||
|
||||
### Retrieve all commits per project
|
||||
|
||||
Get list of commits per project
|
||||
|
||||
GET /ci/commits
|
||||
|
||||
Parameters:
|
||||
|
||||
* `project_id` (required) - The ID of a project
|
||||
* `project_token` (requires) - Project token
|
||||
* `page` (optional)
|
||||
* `per_page` (optional) - items per request (default is 20)
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
[{
|
||||
"id": 3,
|
||||
"ref": "master",
|
||||
"sha": "65617dfc36761baa1f46a7006f2a88916f7f56cf",
|
||||
"project_id": 2,
|
||||
"before_sha": "96906f2bceb04c7323f8514aa5ad8cb1313e2898",
|
||||
"created_at": "2014-11-05T09:46:35.247Z",
|
||||
"status": "success",
|
||||
"finished_at": "2014-11-05T09:46:44.254Z",
|
||||
"duration": 5.062692165374756,
|
||||
"git_commit_message": "wow\n",
|
||||
"git_author_name": "Administrator",
|
||||
"git_author_email": "admin@example.com",
|
||||
"builds": [{
|
||||
"id": 7,
|
||||
"project_id": 2,
|
||||
"ref": "master",
|
||||
"status": "success",
|
||||
"finished_at": "2014-11-05T09:46:44.254Z",
|
||||
"created_at": "2014-11-05T09:46:35.259Z",
|
||||
"updated_at": "2014-11-05T09:46:44.255Z",
|
||||
"sha": "65617dfc36761baa1f46a7006f2a88916f7f56cf",
|
||||
"started_at": "2014-11-05T09:46:39.192Z",
|
||||
"before_sha": "96906f2bceb04c7323f8514aa5ad8cb1313e2898",
|
||||
"runner_id": 1,
|
||||
"coverage": null,
|
||||
"commit_id": 3
|
||||
}]
|
||||
}]
|
||||
```
|
||||
|
||||
### Create commit
|
||||
|
||||
Inform GitLab CI about new commit you want it to build.
|
||||
|
||||
__If commit already exists in GitLab CI it will not be created__
|
||||
|
||||
|
||||
POST /ci/commits
|
||||
|
||||
Parameters:
|
||||
|
||||
* `project_id` (required) - The ID of a project
|
||||
* `project_token` (requires) - Project token
|
||||
* `data` (required) - Push data. For example see comment in `lib/api/commits.rb`
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
{
|
||||
"id": 3,
|
||||
"ref": "master",
|
||||
"sha": "65617dfc36761baa1f46a7006f2a88916f7f56cf",
|
||||
"project_id": 2,
|
||||
"before_sha": "96906f2bceb04c7323f8514aa5ad8cb1313e2898",
|
||||
"created_at": "2014-11-05T09:46:35.247Z",
|
||||
"status": "success",
|
||||
"finished_at": "2014-11-05T09:46:44.254Z",
|
||||
"duration": 5.062692165374756,
|
||||
"git_commit_message": "wow\n",
|
||||
"git_author_name": "Administrator",
|
||||
"git_author_email": "admin@example.com",
|
||||
"builds": [{
|
||||
"id": 7,
|
||||
"project_id": 2,
|
||||
"ref": "master",
|
||||
"status": "success",
|
||||
"finished_at": "2014-11-05T09:46:44.254Z",
|
||||
"created_at": "2014-11-05T09:46:35.259Z",
|
||||
"updated_at": "2014-11-05T09:46:44.255Z",
|
||||
"sha": "65617dfc36761baa1f46a7006f2a88916f7f56cf",
|
||||
"started_at": "2014-11-05T09:46:39.192Z",
|
||||
"before_sha": "96906f2bceb04c7323f8514aa5ad8cb1313e2898",
|
||||
"runner_id": 1,
|
||||
"coverage": null,
|
||||
"commit_id": 3
|
||||
}]
|
||||
}
|
||||
```
|
||||
@@ -1,149 +0,0 @@
|
||||
# Projects API
|
||||
|
||||
This API is intended to aid in the setup and configuration of
|
||||
projects on GitLab CI.
|
||||
|
||||
__Authentication is done by GitLab user token & GitLab url__
|
||||
|
||||
## Projects
|
||||
|
||||
### List Authorized Projects
|
||||
|
||||
Lists all projects that the authenticated user has access to.
|
||||
|
||||
```
|
||||
GET /ci/projects
|
||||
```
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id" : 271,
|
||||
"name" : "gitlabhq",
|
||||
"timeout" : 1800,
|
||||
"token" : "iPWx6WM4lhHNedGfBpPJNP",
|
||||
"default_ref" : "master",
|
||||
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
|
||||
"path" : "gitlab/gitlab-shell",
|
||||
"always_build" : false,
|
||||
"polling_interval" : null,
|
||||
"public" : false,
|
||||
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
|
||||
"gitlab_id" : 3
|
||||
},
|
||||
{
|
||||
"id" : 272,
|
||||
"name" : "gitlab-ci",
|
||||
"timeout" : 1800,
|
||||
"token" : "iPWx6WM4lhHNedGfBpPJNP",
|
||||
"default_ref" : "master",
|
||||
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
|
||||
"path" : "gitlab/gitlab-shell",
|
||||
"always_build" : false,
|
||||
"polling_interval" : null,
|
||||
"public" : false,
|
||||
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
|
||||
"gitlab_id" : 4
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### List Owned Projects
|
||||
|
||||
Lists all projects that the authenticated user owns.
|
||||
|
||||
```
|
||||
GET /ci/projects/owned
|
||||
```
|
||||
|
||||
Returns:
|
||||
|
||||
```json
|
||||
[
|
||||
{
|
||||
"id" : 272,
|
||||
"name" : "gitlab-ci",
|
||||
"timeout" : 1800,
|
||||
"token" : "iPWx6WM4lhHNedGfBpPJNP",
|
||||
"default_ref" : "master",
|
||||
"gitlab_url" : "http://demo.gitlabhq.com/gitlab/gitlab-shell",
|
||||
"path" : "gitlab/gitlab-shell",
|
||||
"always_build" : false,
|
||||
"polling_interval" : null,
|
||||
"public" : false,
|
||||
"ssh_url_to_repo" : "git@demo.gitlab.com:gitlab/gitlab-shell.git",
|
||||
"gitlab_id" : 4
|
||||
}
|
||||
]
|
||||
```
|
||||
|
||||
### Single Project
|
||||
|
||||
Returns information about a single project for which the user is
|
||||
authorized.
|
||||
|
||||
GET /ci/projects/:id
|
||||
|
||||
Parameters:
|
||||
|
||||
* `id` (required) - The ID of the GitLab CI project
|
||||
|
||||
### Create Project
|
||||
|
||||
Creates a GitLab CI project using GitLab project details.
|
||||
|
||||
POST /ci/projects
|
||||
|
||||
Parameters:
|
||||
|
||||
* `name` (required) - The name of the project
|
||||
* `gitlab_id` (required) - The ID of the project on the GitLab instance
|
||||
* `default_ref` (optional) - The branch to run on (default to `master`)
|
||||
|
||||
### Update Project
|
||||
|
||||
Updates a GitLab CI project using GitLab project details that the
|
||||
authenticated user has access to.
|
||||
|
||||
PUT /ci/projects/:id
|
||||
|
||||
Parameters:
|
||||
|
||||
* `name` - The name of the project
|
||||
* `default_ref` - The branch to run on (default to `master`)
|
||||
|
||||
### Remove Project
|
||||
|
||||
Removes a GitLab CI project that the authenticated user has access to.
|
||||
|
||||
DELETE /ci/projects/:id
|
||||
|
||||
Parameters:
|
||||
|
||||
* `id` (required) - The ID of the GitLab CI project
|
||||
|
||||
### Link Project to Runner
|
||||
|
||||
Links a runner to a project so that it can make builds (only via
|
||||
authorized user).
|
||||
|
||||
POST /ci/projects/:id/runners/:runner_id
|
||||
|
||||
Parameters:
|
||||
|
||||
* `id` (required) - The ID of the GitLab CI project
|
||||
* `runner_id` (required) - The ID of the GitLab CI runner
|
||||
|
||||
### Remove Project from Runner
|
||||
|
||||
Removes a runner from a project so that it can not make builds (only
|
||||
via authorized user).
|
||||
|
||||
DELETE /ci/projects/:id/runners/:runner_id
|
||||
|
||||
Parameters:
|
||||
|
||||
* `id` (required) - The ID of the GitLab CI project
|
||||
* `runner_id` (required) - The ID of the GitLab CI runner
|
||||
Reference in New Issue
Block a user