diff options
| author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-14 14:50:25 +0200 |
|---|---|---|
| committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-14 14:50:25 +0200 |
| commit | f2f5a115c6d9dbb9f016693df979e67dd20833a4 (patch) | |
| tree | 30ee71fc736591d18da2d8c4074a16855e773b01 | |
| parent | 47c9b7d34ce0e4e842dba72cedd66671efc03be5 (diff) | |
| download | gitlab-ce-f2f5a115c6d9dbb9f016693df979e67dd20833a4.tar.gz | |
Fix grammar and syntax
| -rw-r--r-- | doc/api/ci/README.md | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/api/ci/README.md b/doc/api/ci/README.md index aea808007fc..96a281e27c8 100644 --- a/doc/api/ci/README.md +++ b/doc/api/ci/README.md @@ -2,19 +2,21 @@ ## Purpose -Main purpose of GitLab CI API is to provide necessary data and context for -GitLab CI Runners. +The main purpose of GitLab CI API is to provide the necessary data and context +for GitLab CI Runners. -For consumer API take a look at this [documentation](../../api/README.md) where -you will find all relevant information. +All relevant information about the consumer API can be found in a +[separate document](../../api/README.md). ## API Prefix -Current CI API prefix is `/ci/api/v1`. +The current CI API prefix is `/ci/api/v1`. You need to prepend this prefix to all examples in this documentation, like: - GET /ci/api/v1/builds/:id/artifacts +```bash +GET /ci/api/v1/builds/:id/artifacts +``` ## Resources |