windmill-api 1.776.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

# \DbtApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**dbt_warehouse_exists**](DbtApi.md#dbt_warehouse_exists) | **GET** /w/{workspace}/dbt/warehouse_exists/{name} | check that a dbt warehouse is configured, without resolving it
[**get_dbt_warehouse**](DbtApi.md#get_dbt_warehouse) | **GET** /w/{workspace}/dbt/warehouse/{name} | resolve a dbt warehouse to the connection it names
[**record_dbt_run_progress**](DbtApi.md#record_dbt_run_progress) | **POST** /w/{workspace}/dbt/run_progress | record the running job's settled dbt nodes



## dbt_warehouse_exists

> dbt_warehouse_exists(workspace, name)
check that a dbt warehouse is configured, without resolving it

Job-scoped: needs a job token. For a project bringing its own `profiles.yml`, which names a warehouse only to say where its assets belong and never opens the connection.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**name** | **String** |  | [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)


## get_dbt_warehouse

> models::DbtWarehouseConnection get_dbt_warehouse(workspace, name)
resolve a dbt warehouse to the connection it names

Job-scoped: needs a job token, because the response carries the warehouse's credentials. dbt is unpermissioned by design, so a running job reaches any warehouse the workspace configures.

### Parameters


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

### Return type

[**models::DbtWarehouseConnection**](DbtWarehouseConnection.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)


## record_dbt_run_progress

> record_dbt_run_progress(workspace, record_dbt_run_progress_request_inner)
record the running job's settled dbt nodes

Job-scoped: needs a job token, and the job is taken from the token rather than the body. For workers with no database access.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**record_dbt_run_progress_request_inner** | [**Vec<models::RecordDbtRunProgressRequestInner>**](recordDbtRunProgress_request_inner.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)