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

# \AssetApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_assets_graph**](AssetApi.md#get_assets_graph) | **GET** /w/{workspace}/assets/graph | Get the workspace-wide asset <-> runnable graph
[**get_dbt_column_lineage**](AssetApi.md#get_dbt_column_lineage) | **GET** /w/{workspace}/assets/column_lineage | Column-level lineage of a set of dbt relations
[**list_asset_partitions**](AssetApi.md#list_asset_partitions) | **GET** /w/{workspace}/assets/partitions | List materialized partitions for a ducklake asset
[**list_asset_partitions_in_range**](AssetApi.md#list_asset_partitions_in_range) | **GET** /w/{workspace}/assets/partitions_in_range | List expected partitions of a ducklake asset in a date range with their materialization status (enterprise)
[**list_asset_schemas**](AssetApi.md#list_asset_schemas) | **GET** /w/{workspace}/assets/asset_schemas | List captured output-schema versions for a ducklake asset
[**list_assets**](AssetApi.md#list_assets) | **GET** /w/{workspace}/assets/list | List all assets in the workspace with cursor pagination
[**list_assets_by_usage**](AssetApi.md#list_assets_by_usage) | **POST** /w/{workspace}/assets/list_by_usages | List all assets used by given usages paths
[**list_favorite_assets**](AssetApi.md#list_favorite_assets) | **GET** /w/{workspace}/assets/list_favorites | List all favorite assets for the authenticated user
[**list_pipeline_folders**](AssetApi.md#list_pipeline_folders) | **GET** /w/{workspace}/assets/pipelines | List folders that contain at least one pipeline-member script
[**list_workspace_macros**](AssetApi.md#list_workspace_macros) | **GET** /w/{workspace}/assets/macros | List every workspace DuckDB macro (deployed `// macros` libraries)



## get_assets_graph

> models::AssetGraph get_assets_graph(workspace, asset_kinds, folder, dbt_script_hash)
Get the workspace-wide asset <-> runnable graph

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**asset_kinds** | Option<**String**> | Filter by asset kinds (comma-separated list) |  |
**folder** | Option<**String**> | Scope the graph to runnables in a single folder |  |
**dbt_script_hash** | Option<**String**> | Render the dbt half of the graph as one version of a dbt script had it, rather than as the currently deployed one. Given this, `folder` no longer scopes the dbt nodes: the pinned version's own models and lineage are the answer, including models a later deploy removed.  |  |

### Return type

[**models::AssetGraph**](AssetGraph.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_dbt_column_lineage

> models::DbtColumnLineage get_dbt_column_lineage(workspace, asset_path, dbt_script_hash)
Column-level lineage of a set of dbt relations

The direct (`copy` / `mod`) column-to-column lineage the given relations' columns sit in — the connected component around them, from the engine's static analysis. Not their own edges, which would stop one hop out since a column trace walks transitively, and not a whole project's, which carries model families the selection cannot reach. Several relations, answered as one union, because one selection reaches several: a script's output column can derive from columns of several dbt models. Unpinned, the component crosses projects — a relation one project produces is another's source — and the caller's access is decided again for every project it reaches, so a trace ends where their grants do. A pinned answer, by version here or by job on the run route, is one project's. Its own endpoint rather than a field on the asset graph: the graph is folder-wide and polled by a run page, while this is rendered for one selection at a time. Empty for projects that did not opt into the analysis pass (`column_lineage: true`), which is the ordinary case. The indirect `scan` kind is stored but never served: it reaches every output column of its model. 

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**asset_path** | [**Vec<String>**](String.md) | The `dbt://` relations whose lineage to return. Repeated, once per relation, and answered as one union. At least one, and at most 1000 — a request naming none, or more than that, is refused rather than answered with an empty component.  | [required] |
**dbt_script_hash** | Option<**String**> | The deployed version a view is drawing, when it is drawing one — the dbt editor, which shows a single project as of a single deploy. A version-pinned answer is that version's project alone, the same as a job-pinned one, and only the unpinned answer crosses projects: a pin says which stored graph is on screen, and another project's live graph is not part of it. A run's or an editor buffer's own graph is not reachable here: that pins to a job, and costs the job-read gate — see `jobs/dbt_column_lineage/{id}`.  |  |

### Return type

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


## list_asset_partitions

> Vec<models::MaterializedPartition> list_asset_partitions(workspace, path)
List materialized partitions for a ducklake asset

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** | The materialized ducklake asset path (`<ducklake>/<table>`) | [required] |

### Return type

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


## list_asset_partitions_in_range

> models::PartitionsInRange list_asset_partitions_in_range(workspace, path, from, to)
List expected partitions of a ducklake asset in a date range with their materialization status (enterprise)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** | The materialized ducklake asset path (`<ducklake>/<table>`) | [required] |
**from** | **String** | Inclusive range start (YYYY-MM-DD), local to the producer's partition tz | [required] |
**to** | **String** | Inclusive range end (YYYY-MM-DD), local to the producer's partition tz | [required] |

### Return type

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


## list_asset_schemas

> Vec<models::AssetSchemaVersion> list_asset_schemas(workspace, path)
List captured output-schema versions for a ducklake asset

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**path** | **String** | The materialized ducklake asset path (`<ducklake>/<table>`) | [required] |

### Return type

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


## list_assets

> models::ListAssets200Response list_assets(workspace, per_page, cursor_created_at, cursor_id, asset_path, usage_path, asset_kinds, path, columns, broad_filter)
List all assets in the workspace with cursor pagination

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**per_page** | Option<**i32**> | Number of items per page (max 1000, default 50) |  |[default to 50]
**cursor_created_at** | Option<**String**> | Cursor timestamp for pagination (created_at of last item from previous page) |  |
**cursor_id** | Option<**i64**> | Cursor ID for pagination (id of last item from previous page) |  |
**asset_path** | Option<**String**> | Filter by asset path (case-insensitive partial match) |  |
**usage_path** | Option<**String**> | Filter by usage path (case-insensitive partial match) |  |
**asset_kinds** | Option<**String**> | Filter by asset kinds (multiple values allowed) |  |
**path** | Option<**String**> | exact path match filter |  |
**columns** | Option<**String**> | JSONB subset match filter for columns using base64 encoded JSON |  |
**broad_filter** | Option<**String**> | broad search across multiple fields (case-insensitive substring match) |  |

### Return type

[**models::ListAssets200Response**](listAssets_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)


## list_assets_by_usage

> Vec<Vec<models::ListAssetsByUsage200ResponseInnerInner>> list_assets_by_usage(workspace, list_assets_by_usage_request)
List all assets used by given usages paths

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**list_assets_by_usage_request** | [**ListAssetsByUsageRequest**](ListAssetsByUsageRequest.md) | list assets by usages | [required] |

### Return type

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


## list_favorite_assets

> Vec<models::ListFavoriteAssets200ResponseInner> list_favorite_assets(workspace)
List all favorite assets for the authenticated user

### Parameters


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

### Return type

[**Vec<models::ListFavoriteAssets200ResponseInner>**](listFavoriteAssets_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)


## list_pipeline_folders

> Vec<models::ListPipelineFolders200ResponseInner> list_pipeline_folders(workspace)
List folders that contain at least one pipeline-member script

### Parameters


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

### Return type

[**Vec<models::ListPipelineFolders200ResponseInner>**](listPipelineFolders_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)


## list_workspace_macros

> Vec<models::ListWorkspaceMacros200ResponseInner> list_workspace_macros(workspace)
List every workspace DuckDB macro (deployed `// macros` libraries)

### Parameters


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

### Return type

[**Vec<models::ListWorkspaceMacros200ResponseInner>**](listWorkspaceMacros_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)