@templmf/temp-solf-lmf 0.0.109 → 0.0.111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package//347/224/237/344/272/247/347/216/257/345/242/203CK/346/211/251/345/256/271/346/255/245/351/252/244052701.docx +0 -0
- package/gitlab-foss-8-17-stable/doc/api/README.md +0 -391
- package/gitlab-foss-8-17-stable/doc/api/access_requests.md +0 -139
- package/gitlab-foss-8-17-stable/doc/api/award_emoji.md +0 -374
- package/gitlab-foss-8-17-stable/doc/api/boards.md +0 -241
- package/gitlab-foss-8-17-stable/doc/api/branches.md +0 -260
- package/gitlab-foss-8-17-stable/doc/api/broadcast_messages.md +0 -154
- package/gitlab-foss-8-17-stable/doc/api/build_triggers.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/build_variables.md +0 -128
- package/gitlab-foss-8-17-stable/doc/api/builds.md +0 -610
- package/gitlab-foss-8-17-stable/doc/api/ci/README.md +0 -24
- package/gitlab-foss-8-17-stable/doc/api/ci/builds.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/ci/lint.md +0 -49
- package/gitlab-foss-8-17-stable/doc/api/ci/runners.md +0 -59
- package/gitlab-foss-8-17-stable/doc/api/commits.md +0 -479
- package/gitlab-foss-8-17-stable/doc/api/deploy_key_multiple_projects.md +0 -29
- package/gitlab-foss-8-17-stable/doc/api/deploy_keys.md +0 -216
- package/gitlab-foss-8-17-stable/doc/api/deployments.md +0 -218
- package/gitlab-foss-8-17-stable/doc/api/enviroments.md +0 -121
- package/gitlab-foss-8-17-stable/doc/api/groups.md +0 -484
- package/gitlab-foss-8-17-stable/doc/api/issues.md +0 -856
- package/gitlab-foss-8-17-stable/doc/api/keys.md +0 -46
- package/gitlab-foss-8-17-stable/doc/api/labels.md +0 -257
- package/gitlab-foss-8-17-stable/doc/api/members.md +0 -175
- package/gitlab-foss-8-17-stable/doc/api/merge_requests.md +0 -1158
- package/gitlab-foss-8-17-stable/doc/api/milestones.md +0 -105
- package/gitlab-foss-8-17-stable/doc/api/namespaces.md +0 -70
- package/gitlab-foss-8-17-stable/doc/api/notes.md +0 -407
- package/gitlab-foss-8-17-stable/doc/api/notification_settings.md +0 -177
- package/gitlab-foss-8-17-stable/doc/api/oauth2.md +0 -137
- package/gitlab-foss-8-17-stable/doc/api/pipelines.md +0 -259
- package/gitlab-foss-8-17-stable/doc/api/project_snippets.md +0 -118
- package/gitlab-foss-8-17-stable/doc/api/projects.md +0 -1402
- package/gitlab-foss-8-17-stable/doc/api/repositories.md +0 -200
- package/gitlab-foss-8-17-stable/doc/api/repository_files.md +0 -134
- package/gitlab-foss-8-17-stable/doc/api/runners.md +0 -322
- package/gitlab-foss-8-17-stable/doc/api/services.md +0 -812
- package/gitlab-foss-8-17-stable/doc/api/session.md +0 -56
- package/gitlab-foss-8-17-stable/doc/api/settings.md +0 -126
- package/gitlab-foss-8-17-stable/doc/api/sidekiq_metrics.md +0 -152
- package/gitlab-foss-8-17-stable/doc/api/snippets.md +0 -232
- package/gitlab-foss-8-17-stable/doc/api/system_hooks.md +0 -146
- package/gitlab-foss-8-17-stable/doc/api/tags.md +0 -191
- package/gitlab-foss-8-17-stable/doc/api/templates/gitignores.md +0 -579
- package/gitlab-foss-8-17-stable/doc/api/templates/gitlab_ci_ymls.md +0 -120
- package/gitlab-foss-8-17-stable/doc/api/templates/licenses.md +0 -147
- package/gitlab-foss-8-17-stable/doc/api/todos.md +0 -296
- package/gitlab-foss-8-17-stable/doc/api/users.md +0 -835
- package/gitlab-foss-8-17-stable/doc/api/v3_to_v4.md +0 -14
- package/gitlab-foss-8-17-stable/doc/api/version.md +0 -23
|
@@ -1,147 +0,0 @@
|
|
|
1
|
-
# Builds API
|
|
2
|
-
|
|
3
|
-
API used by runners to receive and update builds.
|
|
4
|
-
|
|
5
|
-
>**Note:**
|
|
6
|
-
This API is intended to be used only by Runners as their own
|
|
7
|
-
communication channel. For the consumer API see the
|
|
8
|
-
[Builds API](../builds.md).
|
|
9
|
-
|
|
10
|
-
## Authentication
|
|
11
|
-
|
|
12
|
-
This API uses two types of authentication:
|
|
13
|
-
|
|
14
|
-
1. Unique Runner's token which is the token assigned to the Runner after it
|
|
15
|
-
has been registered.
|
|
16
|
-
|
|
17
|
-
2. Using the build authorization token.
|
|
18
|
-
This is project's CI token that can be found under the **Builds** section of
|
|
19
|
-
a project's settings. The build authorization token can be passed as a
|
|
20
|
-
parameter or a value of `BUILD-TOKEN` header.
|
|
21
|
-
|
|
22
|
-
These two methods of authentication are interchangeable.
|
|
23
|
-
|
|
24
|
-
## Builds
|
|
25
|
-
|
|
26
|
-
### Runs oldest pending build by runner
|
|
27
|
-
|
|
28
|
-
```
|
|
29
|
-
POST /ci/api/v1/builds/register
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
| Attribute | Type | Required | Description |
|
|
33
|
-
|-----------|---------|----------|---------------------|
|
|
34
|
-
| `token` | string | yes | Unique runner token |
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
```
|
|
38
|
-
curl --request POST "https://gitlab.example.com/ci/api/v1/builds/register" --form "token=t0k3n"
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**Responses:**
|
|
42
|
-
|
|
43
|
-
| Status | Data |Description |
|
|
44
|
-
|--------|------|---------------------------------------------------------------------------|
|
|
45
|
-
| `201` | yes | When a build is scheduled for a runner |
|
|
46
|
-
| `204` | no | When no builds are scheduled for a runner (for GitLab Runner >= `v1.3.0`) |
|
|
47
|
-
| `403` | no | When invalid token is used or no token is sent |
|
|
48
|
-
| `404` | no | When no builds are scheduled for a runner (for GitLab Runner < `v1.3.0`) **or** when the runner is set to `paused` in GitLab runner's configuration page |
|
|
49
|
-
|
|
50
|
-
### Update details of an existing build
|
|
51
|
-
|
|
52
|
-
```
|
|
53
|
-
PUT /ci/api/v1/builds/:id
|
|
54
|
-
```
|
|
55
|
-
|
|
56
|
-
| Attribute | Type | Required | Description |
|
|
57
|
-
|-----------|---------|----------|----------------------|
|
|
58
|
-
| `id` | integer | yes | The ID of a project |
|
|
59
|
-
| `token` | string | yes | Unique runner token |
|
|
60
|
-
| `state` | string | no | The state of a build |
|
|
61
|
-
| `trace` | string | no | The trace of a build |
|
|
62
|
-
|
|
63
|
-
```
|
|
64
|
-
curl --request PUT "https://gitlab.example.com/ci/api/v1/builds/1234" --form "token=t0k3n" --form "state=running" --form "trace=Running git clone...\n"
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
### Incremental build trace update
|
|
68
|
-
|
|
69
|
-
Using this method you need to send trace content as a request body. You also need to provide the `Content-Range` header
|
|
70
|
-
with a range of sent trace part. Note that you need to send parts in the proper order, so the begining of the part
|
|
71
|
-
must start just after the end of the previous part. If you provide the wrong part, then GitLab CI API will return `416
|
|
72
|
-
Range Not Satisfiable` response with a header `Range: 0-X`, where `X` is the current trace length.
|
|
73
|
-
|
|
74
|
-
For example, if you receive `Range: 0-11` in the response, then your next part must contain a `Content-Range: 11-...`
|
|
75
|
-
header and a trace part covered by this range.
|
|
76
|
-
|
|
77
|
-
For a valid update API will return `202` response with:
|
|
78
|
-
* `Build-Status: {status}` header containing current status of the build,
|
|
79
|
-
* `Range: 0-{length}` header with the current trace length.
|
|
80
|
-
|
|
81
|
-
```
|
|
82
|
-
PATCH /ci/api/v1/builds/:id/trace.txt
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
Parameters:
|
|
86
|
-
|
|
87
|
-
| Attribute | Type | Required | Description |
|
|
88
|
-
|-----------|---------|----------|----------------------|
|
|
89
|
-
| `id` | integer | yes | The ID of a build |
|
|
90
|
-
|
|
91
|
-
Headers:
|
|
92
|
-
|
|
93
|
-
| Attribute | Type | Required | Description |
|
|
94
|
-
|-----------------|---------|----------|-----------------------------------|
|
|
95
|
-
| `BUILD-TOKEN` | string | yes | The build authorization token |
|
|
96
|
-
| `Content-Range` | string | yes | Bytes range of trace that is sent |
|
|
97
|
-
|
|
98
|
-
```
|
|
99
|
-
curl --request PATCH "https://gitlab.example.com/ci/api/v1/builds/1234/trace.txt" --header "BUILD-TOKEN=build_t0k3n" --header "Content-Range=0-21" --data "Running git clone...\n"
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
### Upload artifacts to build
|
|
104
|
-
|
|
105
|
-
```
|
|
106
|
-
POST /ci/api/v1/builds/:id/artifacts
|
|
107
|
-
```
|
|
108
|
-
|
|
109
|
-
| Attribute | Type | Required | Description |
|
|
110
|
-
|-----------|---------|----------|-------------------------------|
|
|
111
|
-
| `id` | integer | yes | The ID of a build |
|
|
112
|
-
| `token` | string | yes | The build authorization token |
|
|
113
|
-
| `file` | mixed | yes | Artifacts file |
|
|
114
|
-
|
|
115
|
-
```
|
|
116
|
-
curl --request POST "https://gitlab.example.com/ci/api/v1/builds/1234/artifacts" --form "token=build_t0k3n" --form "file=@/path/to/file"
|
|
117
|
-
```
|
|
118
|
-
|
|
119
|
-
### Download the artifacts file from build
|
|
120
|
-
|
|
121
|
-
```
|
|
122
|
-
GET /ci/api/v1/builds/:id/artifacts
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
| Attribute | Type | Required | Description |
|
|
126
|
-
|-----------|---------|----------|-------------------------------|
|
|
127
|
-
| `id` | integer | yes | The ID of a build |
|
|
128
|
-
| `token` | string | yes | The build authorization token |
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
curl "https://gitlab.example.com/ci/api/v1/builds/1234/artifacts" --form "token=build_t0k3n"
|
|
132
|
-
```
|
|
133
|
-
|
|
134
|
-
### Remove the artifacts file from build
|
|
135
|
-
|
|
136
|
-
```
|
|
137
|
-
DELETE /ci/api/v1/builds/:id/artifacts
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
| Attribute | Type | Required | Description |
|
|
141
|
-
|-----------|---------|----------|-------------------------------|
|
|
142
|
-
| ` id` | integer | yes | The ID of a build |
|
|
143
|
-
| `token` | string | yes | The build authorization token |
|
|
144
|
-
|
|
145
|
-
```
|
|
146
|
-
curl --request DELETE "https://gitlab.example.com/ci/api/v1/builds/1234/artifacts" --form "token=build_t0k3n"
|
|
147
|
-
```
|
|
@@ -1,49 +0,0 @@
|
|
|
1
|
-
# Validate the .gitlab-ci.yml
|
|
2
|
-
|
|
3
|
-
> [Introduced][ce-5953] in GitLab 8.12.
|
|
4
|
-
|
|
5
|
-
Checks if your .gitlab-ci.yml file is valid.
|
|
6
|
-
|
|
7
|
-
```
|
|
8
|
-
POST ci/lint
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
| Attribute | Type | Required | Description |
|
|
12
|
-
| ---------- | ------- | -------- | -------- |
|
|
13
|
-
| `content` | string | yes | the .gitlab-ci.yaml content|
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
curl --header "Content-Type: application/json" https://gitlab.example.com/api/v3/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\"]}}"}'
|
|
17
|
-
```
|
|
18
|
-
|
|
19
|
-
Be sure to copy paste the exact contents of `.gitlab-ci.yml` as YAML is very picky about indentation and spaces.
|
|
20
|
-
|
|
21
|
-
Example responses:
|
|
22
|
-
|
|
23
|
-
* Valid content:
|
|
24
|
-
|
|
25
|
-
```json
|
|
26
|
-
{
|
|
27
|
-
"status": "valid",
|
|
28
|
-
"errors": []
|
|
29
|
-
}
|
|
30
|
-
```
|
|
31
|
-
|
|
32
|
-
* Invalid content:
|
|
33
|
-
|
|
34
|
-
```json
|
|
35
|
-
{
|
|
36
|
-
"status": "invalid",
|
|
37
|
-
"errors": [
|
|
38
|
-
"variables config should be a hash of key value pairs"
|
|
39
|
-
]
|
|
40
|
-
}
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
* Without the content attribute:
|
|
44
|
-
|
|
45
|
-
```json
|
|
46
|
-
{
|
|
47
|
-
"error": "content is missing"
|
|
48
|
-
}
|
|
49
|
-
```
|
|
@@ -1,59 +0,0 @@
|
|
|
1
|
-
# Runners API
|
|
2
|
-
|
|
3
|
-
API used by Runners to register and delete themselves.
|
|
4
|
-
|
|
5
|
-
>**Note:**
|
|
6
|
-
This API is intended to be used only by Runners as their own
|
|
7
|
-
communication channel. For the consumer API see the
|
|
8
|
-
[new Runners API](../runners.md).
|
|
9
|
-
|
|
10
|
-
## Authentication
|
|
11
|
-
|
|
12
|
-
This API uses two types of authentication:
|
|
13
|
-
|
|
14
|
-
1. Unique Runner's token, which is the token assigned to the Runner after it
|
|
15
|
-
has been registered. This token can be found on the Runner's edit page (go to
|
|
16
|
-
**Project > Runners**, select one of the Runners listed under **Runners activated for
|
|
17
|
-
this project**).
|
|
18
|
-
|
|
19
|
-
2. Using Runners' registration token.
|
|
20
|
-
This is a token that can be found in project's settings.
|
|
21
|
-
It can also be found in the **Admin > Runners** settings area.
|
|
22
|
-
There are two types of tokens you can pass: shared Runner registration
|
|
23
|
-
token or project specific registration token.
|
|
24
|
-
|
|
25
|
-
## Register a new runner
|
|
26
|
-
|
|
27
|
-
Used to make GitLab CI aware of available runners.
|
|
28
|
-
|
|
29
|
-
```sh
|
|
30
|
-
POST /ci/api/v1/runners/register
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
| Attribute | Type | Required | Description |
|
|
34
|
-
| --------- | ------- | --------- | ----------- |
|
|
35
|
-
| `token` | string | yes | Runner's registration token |
|
|
36
|
-
|
|
37
|
-
Example request:
|
|
38
|
-
|
|
39
|
-
```sh
|
|
40
|
-
curl --request POST "https://gitlab.example.com/ci/api/v1/runners/register" --form "token=t0k3n"
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
## Delete a Runner
|
|
44
|
-
|
|
45
|
-
Used to remove a Runner.
|
|
46
|
-
|
|
47
|
-
```sh
|
|
48
|
-
DELETE /ci/api/v1/runners/delete
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
| Attribute | Type | Required | Description |
|
|
52
|
-
| --------- | ------- | --------- | ----------- |
|
|
53
|
-
| `token` | string | yes | Unique Runner's token |
|
|
54
|
-
|
|
55
|
-
Example request:
|
|
56
|
-
|
|
57
|
-
```sh
|
|
58
|
-
curl --request DELETE "https://gitlab.example.com/ci/api/v1/runners/delete" --form "token=t0k3n"
|
|
59
|
-
```
|