forked from qdrant/qdrant
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi-snapshots.ytt.yaml
257 lines (249 loc) · 8.1 KB
/
openapi-snapshots.ytt.yaml
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
#@ load("openapi.lib.yml", "response", "response_with_accepted", "reference", "type", "array")
paths:
/collections/{collection_name}/snapshots/upload:
post:
tags:
- snapshots
- collections
summary: Recover from an uploaded snapshot
description: Recover local collection data from an uploaded snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
operationId: recover_from_uploaded_snapshot
parameters:
- name: collection_name
in: path
description: Name of the collection
required: true
schema:
type: string
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
- name: priority
in: query
description: "Defines source of truth for snapshot recovery"
required: false
schema:
$ref: "#/components/schemas/SnapshotPriority"
requestBody:
description: Snapshot to recover from
content:
multipart/form-data:
schema:
type: object
properties:
snapshot:
type: string
format: binary
responses: #@ response_with_accepted(type("boolean"))
/collections/{collection_name}/snapshots/recover:
put:
tags:
- snapshots
- collections
summary: Recover from a snapshot
description: Recover local collection data from a snapshot. This will overwrite any data, stored on this node, for the collection. If collection does not exist - it will be created.
operationId: recover_from_snapshot
parameters:
- name: collection_name
in: path
description: Name of the collection
required: true
schema:
type: string
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
requestBody:
description: Snapshot to recover from
content:
application/json:
schema:
$ref: "#/components/schemas/SnapshotRecover"
responses: #@ response_with_accepted(type("boolean"))
/collections/{collection_name}/snapshots:
get:
tags:
- snapshots
- collections
summary: List collection snapshots
description: Get list of snapshots for a collection
operationId: list_snapshots
parameters:
- name: collection_name
in: path
description: Name of the collection
required: true
schema:
type: string
responses: #@ response(array(reference("SnapshotDescription")))
post:
tags:
- snapshots
- collections
summary: Create collection snapshot
description: Create new snapshot for a collection
operationId: create_snapshot
parameters:
- name: collection_name
in: path
description: Name of the collection for which to create a snapshot
required: true
schema:
type: string
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
responses: #@ response_with_accepted(reference("SnapshotDescription"))
/collections/{collection_name}/snapshots/{snapshot_name}:
delete:
tags:
- snapshots
- collections
summary: Delete collection snapshot
description: Delete snapshot for a collection
operationId: delete_snapshot
parameters:
- name: collection_name
in: path
description: Name of the collection for which to delete a snapshot
required: true
schema:
type: string
- name: snapshot_name
in: path
description: Name of the snapshot to delete
required: true
schema:
type: string
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
responses: #@ response_with_accepted(type("boolean"))
get:
tags:
- snapshots
- collections
summary: Download collection snapshot
description: Download specified snapshot from a collection as a file
operationId: get_snapshot
parameters:
- name: collection_name
in: path
description: Name of the collection
required: true
schema:
type: string
- name: snapshot_name
in: path
description: Name of the snapshot to download
required: true
schema:
type: string
responses:
default:
description: error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
4XX:
description: error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
'200':
description: Snapshot file
content:
application/octet-stream:
schema:
type: string
format: binary
/snapshots:
get:
tags:
- snapshots
summary: List of storage snapshots
description: Get list of snapshots of the whole storage
operationId: list_full_snapshots
responses: #@ response(array(reference("SnapshotDescription")))
post:
tags:
- snapshots
summary: Create storage snapshot
description: Create new snapshot of the whole storage
operationId: create_full_snapshot
parameters:
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
responses: #@ response_with_accepted(reference("SnapshotDescription"))
/snapshots/{snapshot_name}:
delete:
tags:
- snapshots
summary: Delete storage snapshot
description: Delete snapshot of the whole storage
operationId: delete_full_snapshot
parameters:
- name: snapshot_name
in: path
description: Name of the full snapshot to delete
required: true
schema:
type: string
- name: wait
in: query
description: "If true, wait for changes to actually happen. If false - let changes happen in background. Default is true."
required: false
schema:
type: boolean
responses: #@ response_with_accepted(type("boolean"))
get:
tags:
- snapshots
summary: Download storage snapshot
description: Download specified snapshot of the whole storage as a file
operationId: get_full_snapshot
parameters:
- name: snapshot_name
in: path
description: Name of the snapshot to download
required: true
schema:
type: string
responses:
default:
description: error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
4XX:
description: error
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorResponse"
'200':
description: Snapshot file
content:
application/octet-stream:
schema:
type: string
format: binary