Skip to content

G
gitlab-ce
Commit 968ec8f7 authored by Craig Norris's avatar Craig Norris
Browse files
Options

Merge branch 'docs-update-master-main-verify-2' into 'master' 

Update master references to main in Verify API docs

See merge request gitlab-org/gitlab!62642
parents 11a4bfc7 59ae0091
Hide whitespace changes
Inline Side-by-side
Showing with 36 additions and 36 deletions
doc/api/jobs.md
View file @ 968ec8f7
...@@ -63,11 +63,11 @@ Example of response ...@@ -63,11 +63,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"runner": null, "runner": null,
"stage": "test", "stage": "test",
"status": "failed", "status": "failed",
...@@ -117,11 +117,11 @@ Example of response ...@@ -117,11 +117,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -198,11 +198,11 @@ Example of response ...@@ -198,11 +198,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -263,11 +263,11 @@ Example of response ...@@ -263,11 +263,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"runner": null, "runner": null,
"stage": "test", "stage": "test",
"status": "failed", "status": "failed",
...@@ -348,14 +348,14 @@ Example of response ...@@ -348,14 +348,14 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending", "status": "pending",
"created_at": "2015-12-24T15:50:16.123Z", "created_at": "2015-12-24T15:50:16.123Z",
"updated_at": "2015-12-24T18:00:44.432Z", "updated_at": "2015-12-24T18:00:44.432Z",
"web_url": "https://example.com/foo/bar/pipelines/6" "web_url": "https://example.com/foo/bar/pipelines/6"
}, },
"ref": "master", "ref": "main",
"stage": "test", "stage": "test",
"status": "pending", "status": "pending",
"tag": false, "tag": false,
...@@ -380,7 +380,7 @@ Example of response ...@@ -380,7 +380,7 @@ Example of response
"downstream_pipeline": { "downstream_pipeline": {
"id": 5, "id": 5,
"sha": "f62a4b2fb89754372a346f24659212eb8da13601", "sha": "f62a4b2fb89754372a346f24659212eb8da13601",
"ref": "master", "ref": "main",
"status": "pending", "status": "pending",
"created_at": "2015-12-24T17:54:27.722Z", "created_at": "2015-12-24T17:54:27.722Z",
"updated_at": "2015-12-24T17:58:27.896Z", "updated_at": "2015-12-24T17:58:27.896Z",
...@@ -433,11 +433,11 @@ Example of response ...@@ -433,11 +433,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -518,7 +518,7 @@ Example response: ...@@ -518,7 +518,7 @@ Example response:
"id": 1, "id": 1,
"project_id": 1, "project_id": 1,
"sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0", "sha": "b83d6e391c22777fca1ed3012fce84f633d7fed0",
"ref": "master", "ref": "main",
"status": "pending", "status": "pending",
"created_at": "2021-03-26T14:51:51.107Z", "created_at": "2021-03-26T14:51:51.107Z",
"updated_at": "2021-03-26T14:51:51.107Z", "updated_at": "2021-03-26T14:51:51.107Z",
...@@ -590,11 +590,11 @@ Example of response ...@@ -590,11 +590,11 @@ Example of response
"pipeline": { "pipeline": {
"id": 6, "id": 6,
"project_id": 1, "project_id": 1,
"ref": "master", "ref": "main",
"sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd", "sha": "0ff3ae198f8601a285adcf5c0fff204ee6fba5fd",
"status": "pending" "status": "pending"
}, },
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -684,7 +684,7 @@ Example of response ...@@ -684,7 +684,7 @@ Example of response
"queued_duration": 0.010, "queued_duration": 0.010,
"id": 42, "id": 42,
"name": "rubocop", "name": "rubocop",
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -734,7 +734,7 @@ Example of response ...@@ -734,7 +734,7 @@ Example of response
"queued_duration": 0.010, "queued_duration": 0.010,
"id": 42, "id": 42,
"name": "rubocop", "name": "rubocop",
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -784,7 +784,7 @@ Example of response ...@@ -784,7 +784,7 @@ Example of response
"download_url": null, "download_url": null,
"id": 42, "id": 42,
"name": "rubocop", "name": "rubocop",
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
...@@ -839,7 +839,7 @@ Example of response ...@@ -839,7 +839,7 @@ Example of response
"queued_duration": 0.010, "queued_duration": 0.010,
"id": 42, "id": 42,
"name": "rubocop", "name": "rubocop",
"ref": "master", "ref": "main",
"artifacts": [], "artifacts": [],
"runner": null, "runner": null,
"stage": "test", "stage": "test",
......
doc/api/pipeline_schedules.md
View file @ 968ec8f7
...@@ -30,7 +30,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a ...@@ -30,7 +30,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{ {
"id": 13, "id": 13,
"description": "Test schedule pipeline", "description": "Test schedule pipeline",
"ref": "master", "ref": "main",
"cron": "* * * * *", "cron": "* * * * *",
"cron_timezone": "Asia/Tokyo", "cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T13:41:00.000Z", "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 ...@@ -70,7 +70,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
{ {
"id": 13, "id": 13,
"description": "Test schedule pipeline", "description": "Test schedule pipeline",
"ref": "master", "ref": "main",
"cron": "* * * * *", "cron": "* * * * *",
"cron_timezone": "Asia/Tokyo", "cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T13:41:00.000Z", "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 ...@@ -80,7 +80,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/a
"last_pipeline": { "last_pipeline": {
"id": 332, "id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db", "sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master", "ref": "main",
"status": "pending" "status": "pending"
}, },
"owner": { "owner": {
...@@ -119,14 +119,14 @@ POST /projects/:id/pipeline_schedules ...@@ -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`). | | `active` | boolean | no | The activation of pipeline schedule. If false is set, the pipeline schedule is initially deactivated (default: `true`). |
```shell ```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 ```json
{ {
"id": 14, "id": 14,
"description": "Build packages", "description": "Build packages",
"ref": "master", "ref": "main",
"cron": "0 1 * * 5", "cron": "0 1 * * 5",
"cron_timezone": "UTC", "cron_timezone": "UTC",
"next_run_at": "2017-05-26T01:00:00.000Z", "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 ...@@ -171,7 +171,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form cron="0
{ {
"id": 13, "id": 13,
"description": "Test schedule pipeline", "description": "Test schedule pipeline",
"ref": "master", "ref": "main",
"cron": "0 2 * * *", "cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo", "cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z", "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 ...@@ -181,7 +181,7 @@ curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --form cron="0
"last_pipeline": { "last_pipeline": {
"id": 332, "id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db", "sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master", "ref": "main",
"status": "pending" "status": "pending"
}, },
"owner": { "owner": {
...@@ -216,7 +216,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla ...@@ -216,7 +216,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
{ {
"id": 13, "id": 13,
"description": "Test schedule pipeline", "description": "Test schedule pipeline",
"ref": "master", "ref": "main",
"cron": "0 2 * * *", "cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo", "cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z", "next_run_at": "2017-05-19T17:00:00.000Z",
...@@ -226,7 +226,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla ...@@ -226,7 +226,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitla
"last_pipeline": { "last_pipeline": {
"id": 332, "id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db", "sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master", "ref": "main",
"status": "pending" "status": "pending"
}, },
"owner": { "owner": {
...@@ -261,7 +261,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ...@@ -261,7 +261,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
{ {
"id": 13, "id": 13,
"description": "Test schedule pipeline", "description": "Test schedule pipeline",
"ref": "master", "ref": "main",
"cron": "0 2 * * *", "cron": "0 2 * * *",
"cron_timezone": "Asia/Tokyo", "cron_timezone": "Asia/Tokyo",
"next_run_at": "2017-05-19T17:00:00.000Z", "next_run_at": "2017-05-19T17:00:00.000Z",
...@@ -271,7 +271,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git ...@@ -271,7 +271,7 @@ curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://git
"last_pipeline": { "last_pipeline": {
"id": 332, "id": 332,
"sha": "0e788619d0b5ec17388dffb973ecd505946156db", "sha": "0e788619d0b5ec17388dffb973ecd505946156db",
"ref": "master", "ref": "main",
"status": "pending" "status": "pending"
}, },
"owner": { "owner": {
......
doc/api/pipelines.md
View file @ 968ec8f7
...@@ -99,7 +99,7 @@ Example of response ...@@ -99,7 +99,7 @@ Example of response
"id": 46, "id": 46,
"project_id": 1, "project_id": 1,
"status": "success", "status": "success",
"ref": "master", "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false, "tag": false,
...@@ -226,7 +226,7 @@ POST /projects/:id/pipeline ...@@ -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' }]` | | `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 ```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 Example of response
...@@ -236,7 +236,7 @@ Example of response ...@@ -236,7 +236,7 @@ Example of response
"id": 61, "id": 61,
"project_id": 1, "project_id": 1,
"sha": "384c444e840a515b23f21915ee5766b87068a70d", "sha": "384c444e840a515b23f21915ee5766b87068a70d",
"ref": "master", "ref": "main",
"status": "pending", "status": "pending",
"before_sha": "0000000000000000000000000000000000000000", "before_sha": "0000000000000000000000000000000000000000",
"tag": false, "tag": false,
...@@ -285,7 +285,7 @@ Response: ...@@ -285,7 +285,7 @@ Response:
"id": 46, "id": 46,
"project_id": 1, "project_id": 1,
"status": "pending", "status": "pending",
"ref": "master", "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false, "tag": false,
...@@ -334,7 +334,7 @@ Response: ...@@ -334,7 +334,7 @@ Response:
"id": 46, "id": 46,
"project_id": 1, "project_id": 1,
"status": "canceled", "status": "canceled",
"ref": "master", "ref": "main",
"sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a", "before_sha": "a91957a858320c0e17f3a0eca7cfacbff50ea29a",
"tag": false, "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