diff options
Diffstat (limited to 'doc/api/ci/lint.md')
-rw-r--r-- | doc/api/ci/lint.md | 49 |
1 files changed, 0 insertions, 49 deletions
diff --git a/doc/api/ci/lint.md b/doc/api/ci/lint.md deleted file mode 100644 index 6a4dca92cfe..00000000000 --- a/doc/api/ci/lint.md +++ /dev/null @@ -1,49 +0,0 @@ -# Validate the .gitlab-ci.yml (API) - -> [Introduced][ce-5953] in GitLab 8.12. - -Checks if your .gitlab-ci.yml file is valid. - -``` -POST ci/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" - } - ``` |