qdrant

1
#@ load("openapi.lib.yml", "response", "reference", "type", "array")
2

3
paths:
4
  /collections:
5
    get:
6
      tags:
7
        - collections
8
      summary: List collections
9
      description: Get list name of all existing collections
10
      operationId: get_collections
11
      responses: #@ response(reference("CollectionsResponse"))
12

13
  /collections/{collection_name}:
14
    get:
15
      tags:
16
        - collections
17
      summary: Collection info
18
      description: Get detailed information about specified existing collection
19
      operationId: get_collection
20
      parameters:
21
        - name: collection_name
22
          in: path
23
          description: Name of the collection to retrieve
24
          required: true
25
          schema:
26
            type: string
27
      responses: #@ response(reference("CollectionInfo"))
28

29
    put:
30
      tags:
31
        - collections
32
      summary: Create collection
33
      description: Create new collection with given parameters
34
      operationId: create_collection
35
      requestBody:
36
        description: Parameters of a new collection
37
        content:
38
          application/json:
39
            schema:
40
              $ref: "#/components/schemas/CreateCollection"
41

42
      parameters:
43
        - name: collection_name
44
          in: path
45
          description: Name of the new collection
46
          required: true
47
          schema:
48
            type: string
49
        - name: timeout
50
          in: query
51
          description: |
52
            Wait for operation commit timeout in seconds. 
53
            If timeout is reached - request will return with service error.
54
          schema:
55
            type: integer
56
      responses: #@ response(type("boolean"))
57

58
    patch:
59
      tags:
60
        - collections
61
      summary: Update collection parameters
62
      description: Update parameters of the existing collection
63
      operationId: update_collection
64
      requestBody:
65
        description: New parameters
66
        content:
67
          application/json:
68
            schema:
69
              $ref: "#/components/schemas/UpdateCollection"
70

71
      parameters:
72
        - name: collection_name
73
          in: path
74
          description: Name of the collection to update
75
          required: true
76
          schema:
77
            type: string
78
        - name: timeout
79
          in: query
80
          description: |
81
            Wait for operation commit timeout in seconds. 
82
            If timeout is reached - request will return with service error.
83
          schema:
84
            type: integer
85
      responses: #@ response(type("boolean"))
86

87
    delete:
88
      tags:
89
        - collections
90
      summary: Delete collection
91
      description: Drop collection and all associated data
92
      operationId: delete_collection
93
      parameters:
94
        - name: collection_name
95
          in: path
96
          description: Name of the collection to delete
97
          required: true
98
          schema:
99
            type: string
100
        - name: timeout
101
          in: query
102
          description: |
103
            Wait for operation commit timeout in seconds. 
104
            If timeout is reached - request will return with service error.
105
          schema:
106
            type: integer
107
      responses: #@ response(type("boolean"))
108

109
  /collections/aliases:
110
    post:
111
      tags:
112
        - collections
113
      summary: Update aliases of the collections
114
      operationId: update_aliases
115
      requestBody:
116
        description: Alias update operations
117
        content:
118
          application/json:
119
            schema:
120
              $ref: "#/components/schemas/ChangeAliasesOperation"
121
      parameters:
122
        - name: timeout
123
          in: query
124
          description: |
125
            Wait for operation commit timeout in seconds. 
126
            If timeout is reached - request will return with service error.
127
          schema:
128
            type: integer
129
      responses: #@ response(type("boolean"))
130

131
  /collections/{collection_name}/index:
132
    put:
133
      tags:
134
        - collections
135
      summary: Create index for field in collection
136
      description: Create index for field in collection
137
      operationId: create_field_index
138
      parameters:
139
        - name: collection_name
140
          in: path
141
          description: Name of the collection
142
          required: true
143
          schema:
144
            type: string
145
        - name: wait
146
          in: query
147
          description: "If true, wait for changes to actually happen"
148
          required: false
149
          schema:
150
            type: boolean
151
        - name: ordering
152
          in: query
153
          description: "define ordering guarantees for the operation"
154
          required: false
155
          schema:
156
            $ref: "#/components/schemas/WriteOrdering"
157
      requestBody:
158
        description: Field name
159
        content:
160
          application/json:
161
            schema:
162
              $ref: "#/components/schemas/CreateFieldIndex"
163

164
      responses: #@ response(reference("UpdateResult"))
165

166
  /collections/{collection_name}/exists:
167
    get:
168
      tags:
169
        - collections
170
      summary: Check the existence of a collection
171
      description: Returns "true" if the given collection name exists, and "false" otherwise
172
      operationId: collection_exists
173
      parameters:
174
        - name: collection_name
175
          in: path
176
          description: Name of the collection
177
          required: true
178
          schema:
179
            type: string
180
      responses: #@ response(reference("CollectionExistence"))
181

182
  /collections/{collection_name}/index/{field_name}:
183
    delete:
184
      tags:
185
        - collections
186
      summary: Delete index for field in collection
187
      description: Delete field index for collection
188
      operationId: delete_field_index
189
      parameters:
190
        - name: collection_name
191
          in: path
192
          description: Name of the collection
193
          required: true
194
          schema:
195
            type: string
196
        - name: field_name
197
          in: path
198
          description: Name of the field where to delete the index
199
          required: true
200
          schema:
201
            type: string
202
        - name: wait
203
          in: query
204
          description: "If true, wait for changes to actually happen"
205
          required: false
206
          schema:
207
            type: boolean
208
        - name: ordering
209
          in: query
210
          description: "define ordering guarantees for the operation"
211
          required: false
212
          schema:
213
            $ref: "#/components/schemas/WriteOrdering"
214
      responses: #@ response(reference("UpdateResult"))
215

216
  /collections/{collection_name}/cluster:
217
    get:
218
      tags:
219
        - collections
220
        - cluster
221
      summary: Collection cluster info
222
      description: Get cluster information for a collection
223
      operationId: collection_cluster_info
224
      parameters:
225
        - name: collection_name
226
          in: path
227
          description: Name of the collection to retrieve the cluster info for
228
          required: true
229
          schema:
230
            type: string
231
      responses: #@ response(reference("CollectionClusterInfo"))
232

233
    post:
234
      tags:
235
        - collections
236
        - cluster
237
      summary: Update collection cluster setup
238
      operationId: update_collection_cluster
239
      requestBody:
240
        description: Collection cluster update operations
241
        content:
242
          application/json:
243
            schema:
244
              $ref: "#/components/schemas/ClusterOperations"
245
      parameters:
246
        - name: collection_name
247
          in: path
248
          description: Name of the collection on which to to apply the cluster update operation
249
          required: true
250
          schema:
251
            type: string
252
        - name: timeout
253
          in: query
254
          description: |
255
            Wait for operation commit timeout in seconds. 
256
            If timeout is reached - request will return with service error.
257
          schema:
258
            type: integer
259
      responses: #@ response(type("boolean"))
260

261
  /collections/{collection_name}/aliases:
262
    get:
263
      tags:
264
        - collections
265
      summary: List aliases for collection
266
      description: Get list of all aliases for a collection
267
      operationId: get_collection_aliases
268
      parameters:
269
        - name: collection_name
270
          in: path
271
          description: Name of the collection
272
          required: true
273
          schema:
274
            type: string
275
      responses: #@ response(reference("CollectionsAliasesResponse"))
276

277
  /aliases:
278
    get:
279
      tags:
280
        - collections
281
      summary: List collections aliases
282
      description: Get list of all existing collections aliases
283
      operationId: get_collections_aliases
284
      responses: #@ response(reference("CollectionsAliasesResponse"))
285