artifact-keeper-client 1.1.6

Rust client for the Artifact Keeper REST API
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

# \PeerInstanceLabelsApi

All URIs are relative to *http://localhost*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_label**](PeerInstanceLabelsApi.md#add_label) | **POST** /api/v1/peers/{id}/labels/{label_key} | Add or update a single label on a peer instance
[**delete_label**](PeerInstanceLabelsApi.md#delete_label) | **DELETE** /api/v1/peers/{id}/labels/{label_key} | Delete a label by key from a peer instance
[**list_labels**](PeerInstanceLabelsApi.md#list_labels) | **GET** /api/v1/peers/{id}/labels | List all labels on a peer instance
[**set_labels**](PeerInstanceLabelsApi.md#set_labels) | **PUT** /api/v1/peers/{id}/labels | Set all labels on a peer instance (replaces existing)



## add_label

> models::PeerLabelResponse add_label(id, label_key, add_peer_label_request)
Add or update a single label on a peer instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Peer instance ID | [required] |
**label_key** | **String** | Label key to set | [required] |
**add_peer_label_request** | [**AddPeerLabelRequest**](AddPeerLabelRequest.md) |  | [required] |

### Return type

[**models::PeerLabelResponse**](PeerLabelResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## delete_label

> delete_label(id, label_key)
Delete a label by key from a peer instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Peer instance ID | [required] |
**label_key** | **String** | Label key to remove | [required] |

### Return type

 (empty response body)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## list_labels

> models::PeerLabelsListResponse list_labels(id)
List all labels on a peer instance

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Peer instance ID | [required] |

### Return type

[**models::PeerLabelsListResponse**](PeerLabelsListResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)


## set_labels

> models::PeerLabelsListResponse set_labels(id, set_peer_labels_request)
Set all labels on a peer instance (replaces existing)

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Peer instance ID | [required] |
**set_peer_labels_request** | [**SetPeerLabelsRequest**](SetPeerLabelsRequest.md) |  | [required] |

### Return type

[**models::PeerLabelsListResponse**](PeerLabelsListResponse.md)

### Authorization

[bearer_auth](../README.md#bearer_auth)

### 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)