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

# \DraftApi

All URIs are relative to */api*

Method | HTTP request | Description
------------- | ------------- | -------------
[**get_draft_for_user**](DraftApi.md#get_draft_for_user) | **GET** /w/{workspace}/drafts/get/{kind}/{path} | fetch a single draft's content by workspace username (or the legacy workspace-level row)
[**list_drafts**](DraftApi.md#list_drafts) | **GET** /w/{workspace}/drafts/list | list every draft the current user has in this workspace, across all kinds
[**update_draft**](DraftApi.md#update_draft) | **POST** /w/{workspace}/drafts/update/{kind}/{path} | upsert (or clear) the current user's draft at a path



## get_draft_for_user

> models::GetDraftForUser200Response get_draft_for_user(workspace, kind, path, username)
fetch a single draft's content by workspace username (or the legacy workspace-level row)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**kind** | [**UserDraftItemKind**](.md) |  | [required] |
**path** | **String** |  | [required] |
**username** | Option<**String**> | Workspace username of the draft owner. Omit to fetch the legacy workspace-level (NULL email) row. |  |

### Return type

[**models::GetDraftForUser200Response**](getDraftForUser_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_drafts

> Vec<models::ListDrafts200ResponseInner> list_drafts(workspace)
list every draft the current user has in this workspace, across all kinds

### Parameters


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

### Return type

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


## update_draft

> models::UpdateDraft200Response update_draft(workspace, kind, path, update_draft_request)
upsert (or clear) the current user's draft at a path

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**workspace** | **String** |  | [required] |
**kind** | [**UserDraftItemKind**](.md) |  | [required] |
**path** | **String** |  | [required] |
**update_draft_request** | [**UpdateDraftRequest**](UpdateDraftRequest.md) |  | [required] |

### Return type

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