From 1b464bfe03be2f05f509a96740a9f9d024e8217d Mon Sep 17 00:00:00 2001 From: Kamil Trzcinski Date: Wed, 16 Sep 2015 00:28:59 +0200 Subject: Update documentation and config files --- doc/ci/api/README.md | 4 ++-- doc/ci/api/builds.md | 4 ++-- doc/ci/api/commits.md | 4 ++-- doc/ci/api/forks.md | 2 +- doc/ci/api/projects.md | 16 ++++++++-------- doc/ci/api/runners.md | 6 +++--- 6 files changed, 18 insertions(+), 18 deletions(-) (limited to 'doc/ci/api') diff --git a/doc/ci/api/README.md b/doc/ci/api/README.md index 95fe2f837a5..e47e5c46732 100644 --- a/doc/ci/api/README.md +++ b/doc/ci/api/README.md @@ -29,12 +29,12 @@ sending the `private-token` of a valid user and the `url` of an authorized Gitlab instance via a query string along with the API request: - GET http://ci.example.com/api/v1/projects?private_token=QVy1PB7sTxfy4pqfZM1U&url=http://demo.gitlab.com/ + GET http://gitlab.example.com/ci/api/v1/projects?private_token=QVy1PB7sTxfy4pqfZM1U&url=http://demo.gitlab.com/ If preferred, you may instead send the `private-token` as a header in your request: - curl --header "PRIVATE-TOKEN: QVy1PB7sTxfy4pqfZM1U" "http://ci.example.com/api/v1/projects?url=http://demo.gitlab.com/" + curl --header "PRIVATE-TOKEN: QVy1PB7sTxfy4pqfZM1U" "http://gitlab.example.com/ci/api/v1/projects?url=http://demo.gitlab.com/" ### Authentication #2: GitLab CI project token diff --git a/doc/ci/api/builds.md b/doc/ci/api/builds.md index 54749bc6fa1..3b5008ccdb4 100644 --- a/doc/ci/api/builds.md +++ b/doc/ci/api/builds.md @@ -8,7 +8,7 @@ __Authentication is done by runner token__ ### Runs oldest pending build by runner - POST /builds/register + POST /ci/builds/register Parameters: @@ -32,7 +32,7 @@ Returns: ### Update details of an existing build - PUT /builds/:id + PUT /ci/builds/:id Parameters: diff --git a/doc/ci/api/commits.md b/doc/ci/api/commits.md index 0015a62a38f..4df7afc6c52 100644 --- a/doc/ci/api/commits.md +++ b/doc/ci/api/commits.md @@ -8,7 +8,7 @@ __Authentication is done by GitLab CI project token__ Get list of commits per project - GET /commits + GET /ci/commits Parameters: @@ -58,7 +58,7 @@ Inform GitLab CI about new commit you want it to build. __If commit already exists in GitLab CI it will not be created__ - POST /commits + POST /ci/commits Parameters: diff --git a/doc/ci/api/forks.md b/doc/ci/api/forks.md index 1a5ea8041d8..8f32e2d3b40 100644 --- a/doc/ci/api/forks.md +++ b/doc/ci/api/forks.md @@ -12,7 +12,7 @@ __Authentication is done by GitLab user token & GitLab project token__ ``` -POST /forks +POST /ci/forks ``` Parameters: diff --git a/doc/ci/api/projects.md b/doc/ci/api/projects.md index c24d48f829f..54584db0938 100644 --- a/doc/ci/api/projects.md +++ b/doc/ci/api/projects.md @@ -12,7 +12,7 @@ __Authentication is done by GitLab user token & GitLab url__ Lists all projects that the authenticated user has access to. ``` -GET /projects +GET /ci/projects ``` Returns: @@ -55,7 +55,7 @@ Returns: Lists all projects that the authenticated user owns. ``` -GET /projects/owned +GET /ci/projects/owned ``` Returns: @@ -84,7 +84,7 @@ Returns: Returns information about a single project for which the user is authorized. - GET /projects/:id + GET /ci/projects/:id Parameters: @@ -94,7 +94,7 @@ Parameters: Creates a Gitlab CI project using Gitlab project details. - POST /projects + POST /ci/projects Parameters: @@ -109,7 +109,7 @@ Parameters: Updates a Gitlab CI project using Gitlab project details that the authenticated user has access to. - PUT /projects/:id + PUT /ci/projects/:id Parameters: @@ -123,7 +123,7 @@ Parameters: Removes a Gitlab CI project that the authenticated user has access to. - DELETE /projects/:id + DELETE /ci/projects/:id Parameters: @@ -134,7 +134,7 @@ Parameters: Links a runner to a project so that it can make builds (only via authorized user). - POST /projects/:id/runners/:runner_id + POST /ci/projects/:id/runners/:runner_id Parameters: @@ -146,7 +146,7 @@ Parameters: Removes a runner from a project so that it can not make builds (only via authorized user). - DELETE /projects/:id/runners/:runner_id + DELETE /ci/projects/:id/runners/:runner_id Parameters: diff --git a/doc/ci/api/runners.md b/doc/ci/api/runners.md index 68b5851617a..e9f88ee066e 100644 --- a/doc/ci/api/runners.md +++ b/doc/ci/api/runners.md @@ -9,7 +9,7 @@ __Authentication is done by GitLab user token & GitLab url__ Used to get information about all runners registered on the Gitlab CI instance. - GET /runners + GET /ci/runners Returns: @@ -33,7 +33,7 @@ __Authentication is done with a Shared runner registration token or a project Sp Used to make Gitlab CI aware of available runners. - POST /runners/register + POST /ci/runners/register Parameters: @@ -58,7 +58,7 @@ __Authentication is done by runner token__ Used to removing runners. - DELETE /runners/delete + DELETE /ci/runners/delete Parameters: -- cgit v1.2.3