Skip to content

G
gitlab-ce
Commit 59ae0091 authored by Marcel Amirault's avatar Marcel Amirault
Browse files
Options

Update master references to main 

We are moving to main by default, so we need to
update the docs to match.
parent 1f28d0e8
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 36 deletions
doc/api/jobs.md
View file @ 59ae0091
......@@ -63,11 +63,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"runner": null,
"stage": "test",
"status": "failed",
......@@ -117,11 +117,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -198,11 +198,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -263,11 +263,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"runner": null,
"stage": "test",
"status": "failed",
......@@ -348,14 +348,14 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending",
"created_at": "2015-12-24T15:50:16.123Z",
"updated_at": "2015-12-24T18:00:44.432Z",
"web_url": "https://example.com/foo/bar/pipelines/6"
},
"ref": "master",
"ref": "main",
"stage": "test",
"status": "pending",
"tag": false,
......@@ -380,7 +380,7 @@ Example of response
"downstream_pipeline": {
"id": 5,
"sha": "f62a4b2fb89754372a346f24659212eb8da13601",
"ref": "master",
"ref": "main",
"status": "pending",
"created_at": "2015-12-24T17:54:27.722Z",
"updated_at": "2015-12-24T17:58:27.896Z",
......@@ -433,11 +433,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -518,7 +518,7 @@ Example response:
"id": 1,
"project_id": 1,
"sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
"ref": "master",
"ref": "main",
"status": "pending",
"created_at": "2021-03-26T14:51:51.107Z",
"updated_at": "2021-03-26T14:51:51.107Z",
......@@ -590,11 +590,11 @@ Example of response
"pipeline": {
"id": 6,
"project_id": 1,
"ref": "master",
"ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending"
},
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -684,7 +684,7 @@ Example of response
"queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -734,7 +734,7 @@ Example of response
"queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -784,7 +784,7 @@ Example of response
"download_url": null,
"id": 42,
"name": "rubocop",
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......@@ -839,7 +839,7 @@ Example of response
"queued_duration": 0.010,
"id": 42,
"name": "rubocop",
"ref": "master",
"ref": "main",
"artifacts": [],
"runner": null,
"stage": "test",
......
doc/api/pipeline_schedules.md
View file @ 59ae0091
......@@ -30,7 +30,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{
"id": 13,
"description": "Test schedule pipeline",
"ref": "master",
"ref": "main",
"cron": "* * * * *",
"cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T13:41:00.000Z",
......@@ -70,7 +70,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{
"id": 13,
"description": "Test schedule pipeline",
"ref": "master",
"ref": "main",
"cron": "* * * * *",
"cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T13:41:00.000Z",
......@@ -80,7 +80,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
"last_pipeline": {
"id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master",
"ref": "main",
"status": "pending"
},
"owner": {
......@@ -119,14 +119,14 @@ POST /projects/:id/pipeline_schedules
| `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule is initially deactivated (default: `true`). |
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --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"
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form description="Build packages" --form ref="main" --form cron="0 1 * * 5" --form cron_timezone="UTC" --form active="true" "https://gitlab.example.com/api/v4/projects/29/pipeline_schedules"
```
```json
{
"id": 14,
"description": "Build packages",
"ref": "master",
"ref": "main",
"cron": "0 1 * * 5",
"cron_timezone": "UTC",
"next_run_at": "2017-05-26T01:00:00.000Z",
......@@ -171,7 +171,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form cron="0
{
"id": 13,
"description": "Test schedule pipeline",
"ref": "master",
"ref": "main",
"cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z",
......@@ -181,7 +181,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form cron="0
"last_pipeline": {
"id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master",
"ref": "main",
"status": "pending"
},
"owner": {
......@@ -216,7 +216,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
{
"id": 13,
"description": "Test schedule pipeline",
"ref": "master",
"ref": "main",
"cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z",
......@@ -226,7 +226,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
"last_pipeline": {
"id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master",
"ref": "main",
"status": "pending"
},
"owner": {
......@@ -261,7 +261,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
{
"id": 13,
"description": "Test schedule pipeline",
"ref": "master",
"ref": "main",
"cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z",
......@@ -271,7 +271,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
"last_pipeline": {
"id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master",
"ref": "main",
"status": "pending"
},
"owner": {
......
doc/api/pipelines.md
View file @ 59ae0091
......@@ -99,7 +99,7 @@ Example of response
"id": 46,
"project_id": 1,
"status": "success",
"ref": "master",
"ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,
......@@ -226,7 +226,7 @@ POST /projects/:id/pipeline
| `variables` | array | no | An array containing the variables available in the pipeline, matching the structure `[{ 'key': 'UPLOAD_TO_S3', 'variable_type': 'file', 'value': 'true' }]` |
```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=master"
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/1/pipeline?ref=main"
```
Example of response
......@@ -236,7 +236,7 @@ Example of response
"id": 61,
"project_id": 1,
"sha": "384c444e840a515b23f21915ee5766b87068a70d",
"ref": "master",
"ref": "main",
"status": "pending",
"before_sha": "0000000000000000000000000000000000000000",
"tag": false,
......@@ -285,7 +285,7 @@ Response:
"id": 46,
"project_id": 1,
"status": "pending",
"ref": "master",
"ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,
......@@ -334,7 +334,7 @@ Response:
"id": 46,
"project_id": 1,
"status": "canceled",
"ref": "master",
"ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7