windmill-api 1.817.0

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410

# \GitSyncApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**assign_ghes_installation**](GitSyncApi.md#assign_ghes_installation) | **POST** /github_app/ghes/assign | Assign GHES installation to a workspace
[**delete_from_workspace**](GitSyncApi.md#delete_from_workspace) | **DELETE** /w/{workspace}/github_app/installation/{installation_id} | Delete a GitHub installation from a workspace
[**discover_ghes_installations**](GitSyncApi.md#discover_ghes_installations) | **GET** /github_app/ghes/discover | Discover GHES App installations
[**export_installation**](GitSyncApi.md#export_installation) | **GET** /w/{workspace}/github_app/export/{installationId} | Export GitHub installation JWT token
[**get_credential_origin**](GitSyncApi.md#get_credential_origin) | **GET** /w/{workspace}/git_sync/credential/origin | Where a repository's credential comes from
[**get_ghes_config**](GitSyncApi.md#get_ghes_config) | **GET** /github_app/ghes_config | Get GHES app config
[**get_global_connected_repositories**](GitSyncApi.md#get_global_connected_repositories) | **GET** /github_app/connected_repositories | get connected repositories
[**ghes_installation_callback**](GitSyncApi.md#ghes_installation_callback) | **POST** /w/{workspace}/github_app/ghes_installation_callback | GHES installation callback
[**import_installation**](GitSyncApi.md#import_installation) | **POST** /w/{workspace}/github_app/import | Import GitHub installation from JWT token
[**install_from_workspace**](GitSyncApi.md#install_from_workspace) | **POST** /w/{workspace}/github_app/install_from_workspace | Install a GitHub installation from another workspace
[**list_gitlab_projects**](GitSyncApi.md#list_gitlab_projects) | **POST** /w/{workspace}/git_sync/gitlab/projects | List the GitLab projects a token can sync
[**set_git_credential**](GitSyncApi.md#set_git_credential) | **POST** /w/{workspace}/git_sync/credential | Store the credential for a git repository
[**unassign_ghes_installation**](GitSyncApi.md#unassign_ghes_installation) | **DELETE** /github_app/ghes/assign/{workspace_id}/{installation_id} | Unassign GHES installation from a workspace



## assign_ghes_installation

> assign_ghes_installation(assign_ghes_installation_request)
Assign GHES installation to a workspace

Assigns a discovered GHES App installation to a workspace. The resulting installation is marked as admin-provisioned, so workspace admins cannot remove it. Super-admin only. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**assign_ghes_installation_request** | [**AssignGhesInstallationRequest**](AssignGhesInstallationRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_from_workspace

> delete_from_workspace(workspace, installation_id)
Delete a GitHub installation from a workspace

Removes a GitHub installation from the specified workspace. Requires admin privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**installation_id** | **i64** | The ID of the GitHub installation to delete | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## discover_ghes_installations

> Vec<models::DiscoverGhesInstallations200ResponseInner> discover_ghes_installations()
Discover GHES App installations

Lists every installation the configured self-managed GitHub App can see, annotated with the workspaces in this Windmill instance the installation is currently assigned to. Super-admin only. 

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::DiscoverGhesInstallations200ResponseInner>**](discoverGhesInstallations_200_response_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## export_installation

> models::ExportInstallation200Response export_installation(workspace, installation_id)
Export GitHub installation JWT token

Exports the JWT token for a specific GitHub installation in the workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**installation_id** | **i32** |  | [required] |

### Return type

[**models::ExportInstallation200Response**](exportInstallation_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_credential_origin

> models::GetCredentialOrigin200Response get_credential_origin(workspace, path)
Where a repository's credential comes from

Whether Windmill holds this repository's access token, and which host it talks to. `held` means this workspace stores it, `borrowed` means an ancestor does and it is not this workspace's to replace. Both absent means the repository authenticates with whatever its URL carries. Returns no secret. Requires workspace admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** | Path of the git repository resource, with or without the `$res:` prefix. A path rather than a URL, because a resource URL may carry a token and a URL in a query string lands in logs. | [required] |

### Return type

[**models::GetCredentialOrigin200Response**](getCredentialOrigin_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_ghes_config

> models::GetGhesConfig200Response get_ghes_config()
Get GHES app config

Returns the GitHub Enterprise Server app configuration (without private key) for constructing the installation URL

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::GetGhesConfig200Response**](getGhesConfig_200_response.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_global_connected_repositories

> Vec<models::GithubInstallationsInner> get_global_connected_repositories(page)
get connected repositories

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**page** | Option<**i32**> | Page number for pagination (default 1) |  |[default to 1]

### Return type

[**Vec<models::GithubInstallationsInner>**](GithubInstallations_inner.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## ghes_installation_callback

> ghes_installation_callback(workspace, ghes_installation_callback_request)
GHES installation callback

Register a self-managed GitHub App installation from GitHub Enterprise Server

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**ghes_installation_callback_request** | [**GhesInstallationCallbackRequest**](GhesInstallationCallbackRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## import_installation

> import_installation(workspace, import_installation_request)
Import GitHub installation from JWT token

Imports a GitHub installation from a JWT token exported from another instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**import_installation_request** | [**ImportInstallationRequest**](ImportInstallationRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## install_from_workspace

> install_from_workspace(workspace, install_from_workspace_request)
Install a GitHub installation from another workspace

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**install_from_workspace_request** | [**InstallFromWorkspaceRequest**](InstallFromWorkspaceRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_gitlab_projects

> Vec<models::GitlabProject> list_gitlab_projects(workspace, list_gitlab_projects_request)
List the GitLab projects a token can sync

Lists the projects the supplied GitLab token can push to, so a git repository resource can be filled in without hand-writing a project path. The token is used for this call only and is never stored. Requires workspace admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**list_gitlab_projects_request** | [**ListGitlabProjectsRequest**](ListGitlabProjectsRequest.md) |  | [required] |

### Return type

[**Vec<models::GitlabProject>**](GitlabProject.md)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## set_git_credential

> String set_git_credential(workspace, set_git_credential_request)
Store the credential for a git repository

Stores the access token a git repository authenticates with, so it does not have to be written into the repository URL or a workspace variable. The token is write-only: it is served only to a git-sync job that presents its own job token, and a fork of this workspace reads this copy instead of holding one of its own. Requires workspace admin.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**set_git_credential_request** | [**SetGitCredentialRequest**](SetGitCredentialRequest.md) |  | [required] |

### Return type

**String**

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: text/plain

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## unassign_ghes_installation

> unassign_ghes_installation(workspace_id, installation_id)
Unassign GHES installation from a workspace

Removes an installation (admin-provisioned or otherwise) from a workspace. Super-admin only. Does not affect the installation on the GitHub side. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace_id** | **String** |  | [required] |
**installation_id** | **i64** |  | [required] |

### Return type

 (empty response body)

### Authorization

[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: Not defined

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)