diff options
| author | Zeger-Jan van de Weg <git@zjvandeweg.nl> | 2017-08-21 08:38:09 +0200 |
|---|---|---|
| committer | Zeger-Jan van de Weg <git@zjvandeweg.nl> | 2017-08-21 09:05:17 +0200 |
| commit | f5b733ebdd2c6071968e30ae0b684f82795405df (patch) | |
| tree | 89f6ec9021e3769217bd155c677ca7dc534bbd32 | |
| parent | 1ffd0c8562922de0e70eef2faf71108e0eecbb51 (diff) | |
| download | gitlab-ce-zj-remove-ci-api-v1.tar.gz | |
Fix broken links in documentationzj-remove-ci-api-v1
Also, move the old linting docs to the new location.
| -rw-r--r-- | doc/api/README.md | 7 | ||||
| -rw-r--r-- | doc/api/lint.md | 52 |
2 files changed, 53 insertions, 6 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index 8acb2145f1a..266b5f018d9 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -55,15 +55,10 @@ following locations: - [Tags](tags.md) - [Todos](todos.md) - [Users](users.md) -- [Validate CI configuration](ci/lint.md) +- [Validate CI configuration](lint.md) - [V3 to V4](v3_to_v4.md) - [Version](version.md) -The following documentation is for the [internal CI API](ci/README.md): - -- [Builds](ci/builds.md) -- [Runners](ci/runners.md) - ## Road to GraphQL Going forward, we will start on moving to diff --git a/doc/api/lint.md b/doc/api/lint.md new file mode 100644 index 00000000000..bd5a216a99d --- /dev/null +++ b/doc/api/lint.md @@ -0,0 +1,52 @@ +# Validate the .gitlab-ci.yml (API) + +> [Introduced][ce-5953] in GitLab 8.12. + +Checks if your .gitlab-ci.yml file is valid. + +``` +POST /lint +``` + +| Attribute | Type | Required | Description | +| ---------- | ------- | -------- | -------- | +| `content` | string | yes | the .gitlab-ci.yaml content| + +```bash +curl --header "Content-Type: application/json" https://gitlab.example.com/api/v4/ci/lint --data '{"content": "{ \"image\": \"ruby:2.1\", \"services\": [\"postgres\"], \"before_script\": [\"gem install bundler\", \"bundle install\", \"bundle exec rake db:create\"], \"variables\": {\"DB_NAME\": \"postgres\"}, \"types\": [\"test\", \"deploy\", \"notify\"], \"rspec\": { \"script\": \"rake spec\", \"tags\": [\"ruby\", \"postgres\"], \"only\": [\"branches\"]}}"}' +``` + +Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces. + +Example responses: + +* Valid content: + + ```json + { + "status": "valid", + "errors": [] + } + ``` + +* Invalid content: + + ```json + { + "status": "invalid", + "errors": [ + "variables config should be a hash of key value pairs" + ] + } + ``` + +* Without the content attribute: + + ```json + { + "error": "content is missing" + } + ``` + +[ce-5953]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5953 + |