diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-09 18:32:17 +0200 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-06-13 14:10:31 +0200 |
commit | b27012d9754fd5e4c6013b2e96f0226b724a1ac3 (patch) | |
tree | 3173ff9aa6489d9705fd6622142923dad3d8d19a /doc/api/ci/README.md | |
parent | 30ee4ea6659c91ac6a249d700a9fcdd266676942 (diff) | |
download | gitlab-ce-update-ci-api-docs.tar.gz |
Update CI API docsupdate-ci-api-docs
- Move ci/api under api/ci
- Clean up builds.md and runners.md
- Replace old links with new ones
- Add CI API links in ci/README.md
Diffstat (limited to 'doc/api/ci/README.md')
-rw-r--r-- | doc/api/ci/README.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/api/ci/README.md b/doc/api/ci/README.md new file mode 100644 index 00000000000..aea808007fc --- /dev/null +++ b/doc/api/ci/README.md @@ -0,0 +1,22 @@ +# GitLab CI API + +## Purpose + +Main purpose of GitLab CI API is to provide 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. + +## API Prefix + +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 + +## Resources + +- [Builds](builds.md) +- [Runners](runners.md) |