diff options
| author | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-05-29 15:03:07 +0900 |
|---|---|---|
| committer | Shinya Maeda <gitlab.shinyamaeda@gmail.com> | 2017-05-30 23:55:09 +0900 |
| commit | 0e0e278196801cb9b42791ad4ef9707ad52c4896 (patch) | |
| tree | 38e53e53430cd53038eb7e0052ab0ef14ac03127 /doc | |
| parent | 3b61451c46f462b392783b282fe63dbddd8b6c2e (diff) | |
| download | gitlab-ce-0e0e278196801cb9b42791ad4ef9707ad52c4896.tar.gz | |
Fix document according to the new change
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/pipeline_schedules.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api/pipeline_schedules.md b/doc/api/pipeline_schedules.md index 73b4f345a62..433654c18cc 100644 --- a/doc/api/pipeline_schedules.md +++ b/doc/api/pipeline_schedules.md @@ -13,6 +13,7 @@ GET /projects/:id/pipeline_schedules | Attribute | Type | required | Description | |-----------|---------|----------|---------------------| | `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user | +| `scope` | string | no | The scope of pipeline schedules, one of: `active`, `inactive` | ```sh curl --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules" @@ -101,8 +102,8 @@ POST /projects/:id/pipeline_schedules | `description` | string | yes | The description of pipeline schedule | | `ref` | string | yes | The branch/tag name will be triggered | | `cron ` | string | yes | The cron (e.g. `0 1 * * *`) ([Cron syntax](https://en.wikipedia.org/wiki/Cron)) | -| `cron_timezone ` | string | yes | The timezone supproted by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) or `TZInfo::Timezone` (e.g. `America/Los_Angeles`) | -| `active ` | boolean | yes | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially. | +| `cron_timezone ` | string | no | The timezone supproted by `ActiveSupport::TimeZone` (e.g. `Pacific Time (US & Canada)`) (default: `'UTC'`) | +| `active ` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule will deactivated initially (default: `true`) | ```sh curl --request POST --header "PRIVATE-TOKEN: k5ESFgWY2Qf5xEvDcFxZ" --form description="Build packages" --form ref="master" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules" |