weaviate

1
{
2
  "basePath": "/v1",
3
  "consumes": [
4
    "application/yaml",
5
    "application/json"
6
  ],
7
  "definitions": {
8
    "Link": {
9
      "type": "object",
10
      "properties": {
11
        "href": {
12
          "type": "string",
13
          "description": "target of the link"
14
        },
15
        "rel": {
16
          "type": "string",
17
          "description": "relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc."
18
        },
19
        "name": {
20
          "type": "string",
21
          "description": "human readable name of the resource group"
22
        },
23
        "documentationHref": {
24
          "type": "string",
25
          "description": "weaviate documentation about this resource group"
26
        }
27
      }
28
    },
29
    "Principal": {
30
      "type": "object",
31
      "properties": {
32
        "username": {
33
          "type": "string",
34
          "description": "The username that was extracted either from the authentication information"
35
        },
36
        "groups": {
37
          "type": "array",
38
          "items": {
39
            "type": "string"
40
          }
41
        }
42
      }
43
    },
44
    "C11yWordsResponse": {
45
      "description": "An array of available words and contexts.",
46
      "properties": {
47
        "concatenatedWord": {
48
          "description": "Weighted results for all words",
49
          "type": "object",
50
          "properties": {
51
            "concatenatedWord": {
52
              "type": "string"
53
            },
54
            "singleWords": {
55
              "type": "array",
56
              "items": {
57
                "format": "string"
58
              }
59
            },
60
            "concatenatedVector": {
61
              "$ref": "#/definitions/C11yVector"
62
            },
63
            "concatenatedNearestNeighbors": {
64
              "$ref": "#/definitions/C11yNearestNeighbors"
65
            }
66
          }
67
        },
68
        "individualWords": {
69
          "description": "Weighted results for per individual word",
70
          "type": "array",
71
          "items": {
72
            "type": "object",
73
            "properties": {
74
              "word": {
75
                "type": "string"
76
              },
77
              "present": {
78
                "type": "boolean"
79
              },
80
              "info": {
81
                "type": "object",
82
                "properties": {
83
                  "vector": {
84
                    "$ref": "#/definitions/C11yVector"
85
                  },
86
                  "nearestNeighbors": {
87
                    "$ref": "#/definitions/C11yNearestNeighbors"
88
                  }
89
                }
90
              }
91
            }
92
          }
93
        }
94
      }
95
    },
96
    "C11yExtension": {
97
      "description": "A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension",
98
      "properties": {
99
        "concept": {
100
          "description": "The new concept you want to extend. Must be an all-lowercase single word, or a space delimited compound word. Examples: 'foobarium', 'my custom concept'",
101
          "type": "string",
102
          "example": "foobarium"
103
        },
104
        "definition": {
105
          "description": "A list of space-delimited words or a sentence describing what the custom concept is about. Avoid using the custom concept itself. An Example definition for the custom concept 'foobarium': would be 'a naturally occurring element which can only be seen by programmers'",
106
          "type": "string"
107
        },
108
        "weight": {
109
          "description": "Weight of the definition of the new concept where 1='override existing definition entirely' and 0='ignore custom definition'. Note that if the custom concept is not present in the contextionary yet, the weight cannot be less than 1.",
110
          "type": "number",
111
          "format": "float"
112
        }
113
      }
114
    },
115
    "C11yNearestNeighbors": {
116
      "description": "C11y function to show the nearest neighbors to a word.",
117
      "type": "array",
118
      "items": {
119
        "type": "object",
120
        "properties": {
121
          "word": {
122
            "type": "string"
123
          },
124
          "distance": {
125
            "type": "number",
126
            "format": "float"
127
          }
128
        }
129
      }
130
    },
131
    "C11yVector": {
132
      "description": "A Vector in the Contextionary",
133
      "type": "array",
134
      "items": {
135
        "type": "number",
136
        "format": "float"
137
      }
138
    },
139
    "Vector": {
140
      "description": "A Vector object",
141
      "type": "array",
142
      "items": {
143
        "type": "number",
144
        "format": "float"
145
      }
146
    },
147
    "Vectors": {
148
      "description": "A Multi Vector map of named vectors",
149
      "type": "object",
150
      "additionalProperties": {
151
        "$ref": "#/definitions/Vector"
152
      }
153
    },
154
    "C11yVectorBasedQuestion": {
155
      "description": "Receive question based on array of classes, properties and values.",
156
      "type": "array",
157
      "items": {
158
        "type": "object",
159
        "properties": {
160
          "classVectors": {
161
            "description": "Vectorized classname.",
162
            "type": "array",
163
            "items": {
164
              "type": "number",
165
              "format": "float"
166
            },
167
            "minItems": 300,
168
            "maxItems": 300
169
          },
170
          "classProps": {
171
            "description": "Vectorized properties.",
172
            "type": "array",
173
            "items": {
174
              "type": "object",
175
              "properties": {
176
                "propsVectors": {
177
                  "type": "array",
178
                  "items": {
179
                    "type": "number",
180
                    "format": "float"
181
                  }
182
                },
183
                "value": {
184
                  "description": "String with valuename.",
185
                  "type": "string"
186
                }
187
              }
188
            },
189
            "minItems": 300,
190
            "maxItems": 300
191
          }
192
        }
193
      }
194
    },
195
    "Deprecation": {
196
      "type": "object",
197
      "properties": {
198
        "id": {
199
          "type": "string",
200
          "description": "The id that uniquely identifies this particular deprecations (mostly used internally)"
201
        },
202
        "status": {
203
          "type": "string",
204
          "description": "Whether the problematic API functionality is deprecated (planned to be removed) or already removed"
205
        },
206
        "apiType": {
207
          "type": "string",
208
          "description": "Describes which API is effected, usually one of: REST, GraphQL"
209
        },
210
        "msg": {
211
          "type": "string",
212
          "description": "What this deprecation is about"
213
        },
214
        "mitigation": {
215
          "type": "string",
216
          "description": "User-required object to not be affected by the (planned) removal"
217
        },
218
        "sinceVersion": {
219
          "type": "string",
220
          "description": "The deprecation was introduced in this version"
221
        },
222
        "plannedRemovalVersion": {
223
          "type": "string",
224
          "description": "A best-effort guess of which upcoming version will remove the feature entirely"
225
        },
226
        "removedIn": {
227
          "type": "string",
228
          "description": "If the feature has already been removed, it was removed in this version",
229
          "x-nullable": true
230
        },
231
        "removedTime": {
232
          "type": "string",
233
          "format": "date-time",
234
          "description": "If the feature has already been removed, it was removed at this timestamp",
235
          "x-nullable": true
236
        },
237
        "sinceTime": {
238
          "type": "string",
239
          "format": "date-time",
240
          "description": "The deprecation was introduced in this version"
241
        },
242
        "locations": {
243
          "type": "array",
244
          "description": "The locations within the specified API affected by this deprecation",
245
          "items": {
246
            "type": "string"
247
          }
248
        }
249
      }
250
    },
251
    "ErrorResponse": {
252
      "description": "An error response given by Weaviate end-points.",
253
      "properties": {
254
        "error": {
255
          "items": {
256
            "properties": {
257
              "message": {
258
                "type": "string"
259
              }
260
            },
261
            "type": "object"
262
          },
263
          "type": "array"
264
        }
265
      },
266
      "type": "object"
267
    },
268
    "GraphQLError": {
269
      "description": "An error response caused by a GraphQL query.",
270
      "properties": {
271
        "locations": {
272
          "items": {
273
            "properties": {
274
              "column": {
275
                "format": "int64",
276
                "type": "integer"
277
              },
278
              "line": {
279
                "format": "int64",
280
                "type": "integer"
281
              }
282
            },
283
            "type": "object"
284
          },
285
          "type": "array"
286
        },
287
        "message": {
288
          "type": "string"
289
        },
290
        "path": {
291
          "items": {
292
            "type": "string"
293
          },
294
          "type": "array"
295
        }
296
      }
297
    },
298
    "GraphQLQuery": {
299
      "description": "GraphQL query based on: http://facebook.github.io/graphql/.",
300
      "properties": {
301
        "operationName": {
302
          "description": "The name of the operation if multiple exist in the query.",
303
          "type": "string"
304
        },
305
        "query": {
306
          "description": "Query based on GraphQL syntax.",
307
          "type": "string"
308
        },
309
        "variables": {
310
          "description": "Additional variables for the query.",
311
          "type": "object"
312
        }
313
      },
314
      "type": "object"
315
    },
316
    "GraphQLQueries": {
317
      "description": "A list of GraphQL queries.",
318
      "items": {
319
        "$ref": "#/definitions/GraphQLQuery"
320
      },
321
      "type": "array"
322
    },
323
    "GraphQLResponse": {
324
      "description": "GraphQL based response: http://facebook.github.io/graphql/.",
325
      "properties": {
326
        "data": {
327
          "additionalProperties": {
328
            "$ref": "#/definitions/JsonObject"
329
          },
330
          "description": "GraphQL data object.",
331
          "type": "object"
332
        },
333
        "errors": {
334
          "description": "Array with errors.",
335
          "items": {
336
            "$ref": "#/definitions/GraphQLError"
337
          },
338
          "x-omitempty": true,
339
          "type": "array"
340
        }
341
      }
342
    },
343
    "GraphQLResponses": {
344
      "description": "A list of GraphQL responses.",
345
      "items": {
346
        "$ref": "#/definitions/GraphQLResponse"
347
      },
348
      "type": "array"
349
    },
350
    "InvertedIndexConfig": {
351
      "description": "Configure the inverted index built into Weaviate",
352
      "properties": {
353
        "cleanupIntervalSeconds": {
354
          "description": "Asynchronous index clean up happens every n seconds",
355
          "format": "int",
356
          "type": "number"
357
        },
358
        "bm25": {
359
          "$ref": "#/definitions/BM25Config"
360
        },
361
        "stopwords": {
362
          "$ref": "#/definitions/StopwordConfig"
363
        },
364
        "indexTimestamps": {
365
          "description": "Index each object by its internal timestamps",
366
          "type": "boolean"
367
        },
368
        "indexNullState": {
369
          "description": "Index each object with the null state",
370
          "type": "boolean"
371
        },
372
        "indexPropertyLength": {
373
          "description": "Index length of properties",
374
          "type": "boolean"
375
        }
376
      },
377
      "type": "object"
378
    },
379
    "ReplicationConfig": {
380
      "description": "Configure how replication is executed in a cluster",
381
      "properties": {
382
        "factor": {
383
          "description": "Number of times a class is replicated",
384
          "type": "integer"
385
        }
386
      },
387
      "type": "object"
388
    },
389
    "BM25Config": {
390
      "description": "tuning parameters for the BM25 algorithm",
391
      "properties": {
392
        "k1": {
393
          "description": "calibrates term-weight scaling based on the term frequency within a document",
394
          "format": "float",
395
          "type": "number"
396
        },
397
        "b": {
398
          "description": "calibrates term-weight scaling based on the document length",
399
          "format": "float",
400
          "type": "number"
401
        }
402
      },
403
      "type": "object"
404
    },
405
    "StopwordConfig": {
406
      "description": "fine-grained control over stopword list usage",
407
      "properties": {
408
        "preset": {
409
          "description": "pre-existing list of common words by language",
410
          "type": "string"
411
        },
412
        "additions": {
413
          "description": "stopwords to be considered additionally",
414
          "type": "array",
415
          "items": {
416
            "type": "string"
417
          }
418
        },
419
        "removals": {
420
          "description": "stopwords to be removed from consideration",
421
          "type": "array",
422
          "items": {
423
            "type": "string"
424
          }
425
        }
426
      },
427
      "type": "object"
428
    },
429
    "MultiTenancyConfig": {
430
      "description": "Configuration related to multi-tenancy within a class",
431
      "properties": {
432
        "enabled": {
433
          "description": "Whether or not multi-tenancy is enabled for this class",
434
          "type": "boolean",
435
          "x-omitempty": false
436
        },
437
        "autoTenantCreation": {
438
          "description": "Nonexistent tenants should (not) be created implicitly",
439
          "type": "boolean",
440
          "x-omitempty": false
441
        }
442
      }
443
    },
444
    "JsonObject": {
445
      "description": "JSON object value.",
446
      "type": "object"
447
    },
448
    "Meta": {
449
      "description": "Contains meta information of the current Weaviate instance.",
450
      "properties": {
451
        "hostname": {
452
          "description": "The url of the host.",
453
          "format": "url",
454
          "type": "string"
455
        },
456
        "version": {
457
          "description": "Version of weaviate you are currently running",
458
          "type": "string"
459
        },
460
        "modules": {
461
          "description": "Module-specific meta information",
462
          "type": "object"
463
        }
464
      },
465
      "type": "object"
466
    },
467
    "MultipleRef": {
468
      "description": "Multiple instances of references to other objects.",
469
      "items": {
470
        "$ref": "#/definitions/SingleRef"
471
      },
472
      "type": "array"
473
    },
474
    "PatchDocumentObject": {
475
      "description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).",
476
      "properties": {
477
        "from": {
478
          "description": "A string containing a JSON Pointer value.",
479
          "type": "string"
480
        },
481
        "op": {
482
          "description": "The operation to be performed.",
483
          "enum": [
484
            "add",
485
            "remove",
486
            "replace",
487
            "move",
488
            "copy",
489
            "test"
490
          ],
491
          "type": "string"
492
        },
493
        "path": {
494
          "description": "A JSON-Pointer.",
495
          "type": "string"
496
        },
497
        "value": {
498
          "description": "The value to be used within the operations.",
499
          "type": "object"
500
        },
501
        "merge": {
502
          "$ref": "#/definitions/Object"
503
        }
504
      },
505
      "required": [
506
        "op",
507
        "path"
508
      ]
509
    },
510
    "PatchDocumentAction": {
511
      "description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).",
512
      "properties": {
513
        "from": {
514
          "description": "A string containing a JSON Pointer value.",
515
          "type": "string"
516
        },
517
        "op": {
518
          "description": "The operation to be performed.",
519
          "enum": [
520
            "add",
521
            "remove",
522
            "replace",
523
            "move",
524
            "copy",
525
            "test"
526
          ],
527
          "type": "string"
528
        },
529
        "path": {
530
          "description": "A JSON-Pointer.",
531
          "type": "string"
532
        },
533
        "value": {
534
          "description": "The value to be used within the operations.",
535
          "type": "object"
536
        },
537
        "merge": {
538
          "$ref": "#/definitions/Object"
539
        }
540
      },
541
      "required": [
542
        "op",
543
        "path"
544
      ]
545
    },
546
    "PeerUpdate": {
547
      "description": "A single peer in the network.",
548
      "properties": {
549
        "id": {
550
          "description": "The session ID of the peer.",
551
          "type": "string",
552
          "format": "uuid"
553
        },
554
        "name": {
555
          "description": "Human readable name.",
556
          "type": "string"
557
        },
558
        "uri": {
559
          "description": "The location where the peer is exposed to the internet.",
560
          "type": "string",
561
          "format": "uri"
562
        },
563
        "schemaHash": {
564
          "description": "The latest known hash of the peer's schema.",
565
          "type": "string"
566
        }
567
      }
568
    },
569
    "PeerUpdateList": {
570
      "description": "List of known peers.",
571
      "items": {
572
        "$ref": "#/definitions/PeerUpdate"
573
      },
574
      "type": "array"
575
    },
576
    "VectorWeights": {
577
      "description": "Allow custom overrides of vector weights as math expressions. E.g. \"pancake\": \"7\" will set the weight for the word pancake to 7 in the vectorization, whereas \"w * 3\" would triple the originally calculated word. This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value (string/string) object.",
578
      "type": "object"
579
    },
580
    "PropertySchema": {
581
      "description": "This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition.",
582
      "type": "object"
583
    },
584
    "SchemaHistory": {
585
      "description": "This is an open object, with OpenAPI Specification 3.0 this will be more detailed. See Weaviate docs for more info. In the future this will become a key/value OR a SingleRef definition.",
586
      "type": "object"
587
    },
588
    "Schema": {
589
      "description": "Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).",
590
      "properties": {
591
        "classes": {
592
          "description": "Semantic classes that are available.",
593
          "items": {
594
            "$ref": "#/definitions/Class"
595
          },
596
          "type": "array"
597
        },
598
        "maintainer": {
599
          "description": "Email of the maintainer.",
600
          "format": "email",
601
          "type": "string"
602
        },
603
        "name": {
604
          "description": "Name of the schema.",
605
          "type": "string"
606
        }
607
      },
608
      "type": "object"
609
    },
610
    "SchemaClusterStatus": {
611
      "description": "Indicates the health of the schema in a cluster.",
612
      "properties": {
613
        "healthy": {
614
          "description": "True if the cluster is in sync, false if there is an issue (see error).",
615
          "type": "boolean",
616
          "x-omitempty": false
617
        },
618
        "error": {
619
          "description": "Contains the sync check error if one occurred",
620
          "type": "string",
621
          "x-omitempty": true
622
        },
623
        "hostname": {
624
          "description": "Hostname of the coordinating node, i.e. the one that received the cluster. This can be useful information if the error message contains phrases such as 'other nodes agree, but local does not', etc.",
625
          "type": "string"
626
        },
627
        "nodeCount": {
628
          "description": "Number of nodes that participated in the sync check",
629
          "type": "number",
630
          "format": "int"
631
        },
632
        "ignoreSchemaSync": {
633
          "description": "The cluster check at startup can be ignored (to recover from an out-of-sync situation).",
634
          "type": "boolean",
635
          "x-omitempty": false
636
        }
637
      },
638
      "type": "object"
639
    },
640
    "Class": {
641
      "properties": {
642
        "class": {
643
          "description": "Name of the class as URI relative to the schema URL.",
644
          "type": "string"
645
        },
646
        "vectorConfig": {
647
          "type": "object",
648
          "additionalProperties": {
649
            "$ref": "#/definitions/VectorConfig"
650
          }
651
        },
652
        "vectorIndexType": {
653
          "description": "Name of the vector index to use, eg. (HNSW)",
654
          "type": "string"
655
        },
656
        "vectorIndexConfig": {
657
          "description": "Vector-index config, that is specific to the type of index selected in vectorIndexType",
658
          "type": "object"
659
        },
660
        "shardingConfig": {
661
          "description": "Manage how the index should be sharded and distributed in the cluster",
662
          "type": "object"
663
        },
664
        "replicationConfig": {
665
          "$ref": "#/definitions/ReplicationConfig"
666
        },
667
        "invertedIndexConfig": {
668
          "$ref": "#/definitions/InvertedIndexConfig"
669
        },
670
        "multiTenancyConfig": {
671
          "$ref": "#/definitions/MultiTenancyConfig"
672
        },
673
        "vectorizer": {
674
          "description": "Specify how the vectors for this class should be determined. The options are either 'none' - this means you have to import a vector with each object yourself - or the name of a module that provides vectorization capabilities, such as 'text2vec-contextionary'. If left empty, it will use the globally configured default which can itself either be 'none' or a specific module.",
675
          "type": "string"
676
        },
677
        "moduleConfig": {
678
          "description": "Configuration specific to modules this Weaviate instance has installed",
679
          "type": "object"
680
        },
681
        "description": {
682
          "description": "Description of the class.",
683
          "type": "string"
684
        },
685
        "properties": {
686
          "description": "The properties of the class.",
687
          "items": {
688
            "$ref": "#/definitions/Property"
689
          },
690
          "type": "array"
691
        }
692
      },
693
      "type": "object"
694
    },
695
    "Property": {
696
      "properties": {
697
        "dataType": {
698
          "description": "Can be a reference to another type when it starts with a capital (for example Person), otherwise \"string\" or \"int\".",
699
          "items": {
700
            "type": "string"
701
          },
702
          "type": "array"
703
        },
704
        "description": {
705
          "description": "Description of the property.",
706
          "type": "string"
707
        },
708
        "moduleConfig": {
709
          "description": "Configuration specific to modules this Weaviate instance has installed",
710
          "type": "object"
711
        },
712
        "name": {
713
          "description": "Name of the property as URI relative to the schema URL.",
714
          "type": "string"
715
        },
716
        "indexInverted": {
717
          "description": "Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters, bm25 or hybrid search. This property has no affect on vectorization decisions done by modules (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)",
718
          "type": "boolean",
719
          "x-nullable": true
720
        },
721
        "indexFilterable": {
722
          "description": "Optional. Should this property be indexed in the inverted index. Defaults to true. If you choose false, you will not be able to use this property in where filters. This property has no affect on vectorization decisions done by modules",
723
          "type": "boolean",
724
          "x-nullable": true
725
        },
726
        "indexSearchable": {
727
          "description": "Optional. Should this property be indexed in the inverted index. Defaults to true. Applicable only to properties of data type text and text[]. If you choose false, you will not be able to use this property in bm25 or hybrid search. This property has no affect on vectorization decisions done by modules",
728
          "type": "boolean",
729
          "x-nullable": true
730
        },
731
        "tokenization": {
732
          "description": "Determines tokenization of the property as separate words or whole field. Optional. Applies to text and text[] data types. Allowed values are `word` (default; splits on any non-alphanumerical, lowercases), `lowercase` (splits on white spaces, lowercases), `whitespace` (splits on white spaces), `field` (trims). Not supported for remaining data types",
733
          "type": "string",
734
          "enum": [
735
            "word",
736
            "lowercase",
737
            "whitespace",
738
            "field",
739
            "trigram",
740
            "gse"
741
          ]
742
        },
743
        "nestedProperties": {
744
            "description": "The properties of the nested object(s). Applies to object and object[] data types.",
745
            "items": {
746
              "$ref": "#/definitions/NestedProperty"
747
            },
748
            "type": "array",
749
            "x-omitempty": true
750
          }
751
      },
752
      "type": "object"
753
    },
754
    "VectorConfig": {
755
      "properties": {
756
        "vectorizer": {
757
          "description": "Configuration of a specific vectorizer used by this vector",
758
          "type": "object"
759
        },
760
        "vectorIndexType": {
761
          "description": "Name of the vector index to use, eg. (HNSW)",
762
          "type": "string"
763
        },
764
        "vectorIndexConfig": {
765
          "description": "Vector-index config, that is specific to the type of index selected in vectorIndexType",
766
          "type": "object"
767
        }
768
      },
769
      "type": "object"
770
    },
771
    "NestedProperty": {
772
      "properties": {
773
        "dataType": {
774
          "items": {
775
            "type": "string"
776
          },
777
          "type": "array"
778
        },
779
        "description": {
780
          "type": "string"
781
        },
782
        "name": {
783
          "type": "string"
784
        },
785
        "indexFilterable": {
786
          "type": "boolean",
787
          "x-nullable": true
788
        },
789
        "indexSearchable": {
790
          "type": "boolean",
791
          "x-nullable": true
792
        },
793
        "tokenization": {
794
          "type": "string",
795
          "enum": [
796
            "word",
797
            "lowercase",
798
            "whitespace",
799
            "field"
800
          ]
801
        },
802
        "nestedProperties": {
803
            "items": {
804
              "$ref": "#/definitions/NestedProperty"
805
            },
806
            "type": "array",
807
            "x-omitempty": true
808
          }
809
      },
810
      "type": "object"
811
    },
812
    "ShardStatusList": {
813
      "description": "The status of all the shards of a Class",
814
      "items": {
815
        "$ref": "#/definitions/ShardStatusGetResponse"
816
      },
817
      "type": "array"
818
    },
819
    "ShardStatusGetResponse": {
820
      "description": "Response body of shard status get request",
821
      "properties": {
822
        "name": {
823
          "description": "Name of the shard",
824
          "type": "string"
825
        },
826
        "status": {
827
          "description": "Status of the shard",
828
          "type": "string"
829
        },
830
        "vectorQueueSize": {
831
          "description": "Size of the vector queue of the shard",
832
          "type": "integer",
833
          "x-omitempty": false
834
        }
835
      }
836
    },
837
    "ShardStatus": {
838
      "description": "The status of a single shard",
839
      "properties": {
840
        "status": {
841
          "description": "Status of the shard",
842
          "type": "string"
843
        }
844
      }
845
    },
846
    "BackupCreateStatusResponse": {
847
      "description": "The definition of a backup create metadata",
848
      "properties": {
849
        "id": {
850
          "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
851
          "type": "string"
852
        },
853
        "backend": {
854
          "description": "Backup backend name e.g. filesystem, gcs, s3.",
855
          "type": "string"
856
        },
857
        "path": {
858
          "description": "destination path of backup files proper to selected backend",
859
          "type": "string"
860
        },
861
        "error": {
862
          "description": "error message if creation failed",
863
          "type": "string"
864
        },
865
        "status": {
866
          "description": "phase of backup creation process",
867
          "type": "string",
868
          "default": "STARTED",
869
          "enum": [
870
            "STARTED",
871
            "TRANSFERRING",
872
            "TRANSFERRED",
873
            "SUCCESS",
874
            "FAILED"
875
          ]
876
        }
877
      }
878
    },
879
    "BackupRestoreStatusResponse": {
880
      "description": "The definition of a backup restore metadata",
881
      "properties": {
882
        "id": {
883
          "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
884
          "type": "string"
885
        },
886
        "backend": {
887
          "description": "Backup backend name e.g. filesystem, gcs, s3.",
888
          "type": "string"
889
        },
890
        "path": {
891
          "description": "destination path of backup files proper to selected backup backend",
892
          "type": "string"
893
        },
894
        "error": {
895
          "description": "error message if restoration failed",
896
          "type": "string"
897
        },
898
        "status": {
899
          "description": "phase of backup restoration process",
900
          "type": "string",
901
          "default": "STARTED",
902
          "enum": [
903
            "STARTED",
904
            "TRANSFERRING",
905
            "TRANSFERRED",
906
            "SUCCESS",
907
            "FAILED"
908
          ]
909
        }
910
      }
911
    },
912
    "BackupConfig": {
913
      "description": "Backup custom configuration",
914
      "type": "object",      
915
      "properties": {
916
        "CPUPercentage": {
917
          "description": "Desired CPU core utilization ranging from 1%-80%",
918
          "type": "integer",
919
          "default": 50,
920
          "minimum": 1,
921
          "maximum": 80,
922
          "x-nullable": false
923
        },
924
        "ChunkSize": {
925
          "description": "Weaviate will attempt to come close the specified size, with a minimum of 2MB, default of 128MB, and a maximum of 512MB",
926
          "type": "integer",
927
          "default": 128,
928
          "minimum": 2,
929
          "maximum": 512,
930
          "x-nullable": false
931
        },
932
        "CompressionLevel": {
933
          "description": "compression level used by compression algorithm",
934
          "type": "string",
935
          "default": "DefaultCompression",
936
          "x-nullable": false,
937
          "enum": [
938
            "DefaultCompression",
939
            "BestSpeed",
940
            "BestCompression"
941
          ]
942
        }
943
      }
944
    },
945
    "RestoreConfig": {
946
      "description": "Backup custom configuration",
947
      "type": "object",      
948
      "properties": {
949
        "CPUPercentage": {
950
          "description": "Desired CPU core utilization ranging from 1%-80%",
951
          "type": "integer",
952
          "default": 50,
953
          "minimum": 1,
954
          "maximum": 80,
955
          "x-nullable": false
956
        }       
957
      }
958
    },
959
    "BackupCreateRequest": {
960
      "description": "Request body for creating a backup of a set of classes",
961
      "properties": {
962
        "id": {
963
          "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
964
          "type": "string"
965
        },
966
        "config": {
967
          "description": "Custom configuration for the backup creation process",
968
          "type": "object",
969
          "$ref": "#/definitions/BackupConfig"
970
        },
971
        "include": {
972
          "description": "List of classes to include in the backup creation process",
973
          "type": "array",
974
          "items": {
975
            "type": "string"
976
          }
977
        },
978
        "exclude": {
979
          "description": "List of classes to exclude from the backup creation process",
980
          "type": "array",
981
          "items": {
982
            "type": "string"
983
          }
984
        }
985
      }
986
    },
987
    "BackupCreateResponse": {
988
      "description": "The definition of a backup create response body",
989
      "properties": {
990
        "id": {
991
          "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
992
          "type": "string"
993
        },
994
        "classes": {
995
          "description": "The list of classes for which the backup creation process was started",
996
          "type": "array",
997
          "items": {
998
            "type": "string"
999
          }
1000
        },
1001
        "backend": {
1002
          "description": "Backup backend name e.g. filesystem, gcs, s3.",
1003
          "type": "string"
1004
        },
1005
        "path": {
1006
          "description": "destination path of backup files proper to selected backend",
1007
          "type": "string"
1008
        },
1009
        "error": {
1010
          "description": "error message if creation failed",
1011
          "type": "string"
1012
        },
1013
        "status": {
1014
          "description": "phase of backup creation process",
1015
          "type": "string",
1016
          "default": "STARTED",
1017
          "enum": [
1018
            "STARTED",
1019
            "TRANSFERRING",
1020
            "TRANSFERRED",
1021
            "SUCCESS",
1022
            "FAILED"
1023
          ]
1024
        }
1025
      }
1026
    },
1027
    "BackupRestoreRequest": {
1028
      "description": "Request body for restoring a backup for a set of classes",
1029
      "properties": {
1030
        "config": {
1031
          "description": "Custom configuration for the backup restoration process",
1032
          "type": "object",
1033
          "$ref": "#/definitions/RestoreConfig"
1034
        },
1035
        "include": {
1036
          "description": "List of classes to include in the backup restoration process",
1037
          "type": "array",
1038
          "items": {
1039
            "type": "string"
1040
          }
1041
        },
1042
        "exclude": {
1043
          "description": "List of classes to exclude from the backup restoration process",
1044
          "type": "array",
1045
          "items": {
1046
            "type": "string"
1047
          }
1048
        },
1049
        "node_mapping": {
1050
          "description": "Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment.",
1051
          "type": "object",
1052
          "additionalProperties": {
1053
            "type": "string"
1054
          }
1055
        }
1056
      }
1057
    },
1058
    "BackupRestoreResponse": {
1059
      "description": "The definition of a backup restore response body",
1060
      "properties": {
1061
        "id": {
1062
          "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.",
1063
          "type": "string"
1064
        },
1065
        "classes": {
1066
          "description": "The list of classes for which the backup restoration process was started",
1067
          "type": "array",
1068
          "items": {
1069
            "type": "string"
1070
          }
1071
        },
1072
        "backend": {
1073
          "description": "Backup backend name e.g. filesystem, gcs, s3.",
1074
          "type": "string"
1075
        },
1076
        "path": {
1077
          "description": "destination path of backup files proper to selected backend",
1078
          "type": "string"
1079
        },
1080
        "error": {
1081
          "description": "error message if restoration failed",
1082
          "type": "string"
1083
        },
1084
        "status": {
1085
          "description": "phase of backup restoration process",
1086
          "type": "string",
1087
          "default": "STARTED",
1088
          "enum": [
1089
            "STARTED",
1090
            "TRANSFERRING",
1091
            "TRANSFERRED",
1092
            "SUCCESS",
1093
            "FAILED"
1094
          ]
1095
        }
1096
      }
1097
    },
1098
    "NodeStats": {
1099
      "description": "The summary of Weaviate's statistics.",
1100
      "properties": {
1101
        "shardCount": {
1102
          "description": "The count of Weaviate's shards.",
1103
          "format": "int",
1104
          "type": "number",
1105
          "x-omitempty": false
1106
        },
1107
        "objectCount": {
1108
          "description": "The total number of objects in DB.",
1109
          "format": "int64",
1110
          "type": "number",
1111
          "x-omitempty": false
1112
        }
1113
      }
1114
    },
1115
    "BatchStats": {
1116
      "description": "The summary of a nodes batch queue congestion status.",
1117
      "properties": {
1118
        "queueLength": {
1119
          "description": "How many objects are currently in the batch queue.",
1120
          "format": "int",
1121
          "type": "number",
1122
          "x-omitempty": true,
1123
          "x-nullable": true
1124
        },
1125
        "ratePerSecond": {
1126
          "description": "How many objects are approximately processed from the batch queue per second.",
1127
          "format": "int",
1128
          "type": "number",
1129
          "x-omitempty": false
1130
        }
1131
      }
1132
    },
1133
    "NodeShardStatus": {
1134
      "description": "The definition of a node shard status response body",
1135
      "properties": {
1136
        "name": {
1137
          "description": "The name of the shard.",
1138
          "type": "string",
1139
          "x-omitempty": false
1140
        },
1141
        "class": {
1142
          "description": "The name of shard's class.",
1143
          "type": "string",
1144
          "x-omitempty": false
1145
        },
1146
        "objectCount": {
1147
          "description": "The number of objects in shard.",
1148
          "format": "int64",
1149
          "type": "number",
1150
          "x-omitempty": false
1151
        },
1152
        "vectorIndexingStatus": {
1153
          "description": "The status of the vector indexing process.",
1154
          "format": "string",
1155
          "x-omitempty": false
1156
        },
1157
        "compressed": {
1158
          "description": "The status of vector compression/quantization.",
1159
          "format": "boolean",
1160
          "x-omitempty": false
1161
        },
1162
        "vectorQueueLength": {
1163
          "description": "The length of the vector indexing queue.",
1164
          "format": "int64",
1165
          "type": "number",
1166
          "x-omitempty": false
1167
        },
1168
        "loaded": {
1169
          "description": "The load status of the shard.",
1170
          "type": "boolean",
1171
          "x-omitempty": false
1172
        }
1173
      }
1174
    },
1175
    "NodeStatus": {
1176
      "description": "The definition of a backup node status response body",
1177
      "properties": {
1178
        "name": {
1179
          "description": "The name of the node.",
1180
          "type": "string"
1181
        },
1182
        "status": {
1183
          "description": "Node's status.",
1184
          "type": "string",
1185
          "default": "HEALTHY",
1186
          "enum": [
1187
            "HEALTHY",
1188
            "UNHEALTHY",
1189
            "UNAVAILABLE",
1190
            "TIMEOUT"
1191
          ]
1192
        },
1193
        "version": {
1194
          "description": "The version of Weaviate.",
1195
          "type": "string"
1196
        },
1197
        "gitHash": {
1198
          "description": "The gitHash of Weaviate.",
1199
          "type": "string"
1200
        },
1201
        "stats": {
1202
          "description": "Weaviate overall statistics.",
1203
          "type": "object",
1204
          "$ref": "#/definitions/NodeStats"
1205
        },
1206
        "batchStats": {
1207
          "description": "Weaviate batch statistics.",
1208
          "type": "object",
1209
          "$ref": "#/definitions/BatchStats"
1210
        },
1211
        "shards": {
1212
          "description": "The list of the shards with it's statistics.",
1213
          "type": "array",
1214
          "items": {
1215
            "$ref": "#/definitions/NodeShardStatus"
1216
          }
1217
        }
1218
      }
1219
    },
1220
    "NodesStatusResponse": {
1221
      "description": "The status of all of the Weaviate nodes",
1222
      "type": "object",
1223
      "properties": {
1224
        "nodes": {
1225
          "type": "array",
1226
          "items": {
1227
            "$ref": "#/definitions/NodeStatus"
1228
          }
1229
        }
1230
      }
1231
    },
1232
    "RaftStatistics": {
1233
      "description": "The definition of Raft statistics.",
1234
      "properties": {
1235
        "appliedIndex": {
1236
          "type": "string"
1237
        },
1238
        "commitIndex": {
1239
          "type": "string"
1240
        },
1241
        "fsmPending": {
1242
          "type": "string"
1243
        },
1244
        "lastContact": {
1245
          "type": "string"
1246
        },
1247
        "lastLogIndex": {
1248
          "type": "string"
1249
        },
1250
        "lastLogTerm": {
1251
          "type": "string"
1252
        },
1253
        "lastSnapshotIndex": {
1254
          "type": "string"
1255
        },
1256
        "lastSnapshotTerm": {
1257
          "type": "string"
1258
        },
1259
        "latestConfiguration": {
1260
          "description": "Weaviate Raft nodes.",
1261
          "type": "object"
1262
        },
1263
        "latestConfigurationIndex": {
1264
          "type": "string"
1265
        },
1266
        "numPeers": {
1267
          "type": "string"
1268
        },
1269
        "protocolVersion": {
1270
          "type": "string"
1271
        },
1272
        "protocolVersionMax": {
1273
          "type": "string"
1274
        },
1275
        "protocolVersionMin": {
1276
          "type": "string"
1277
        },
1278
        "snapshotVersionMax": {
1279
          "type": "string"
1280
        },
1281
        "snapshotVersionMin": {
1282
          "type": "string"
1283
        },
1284
        "state": {
1285
          "type": "string"
1286
        },
1287
        "term": {
1288
          "type": "string"
1289
        }
1290
      }
1291
    },
1292
    "Statistics": {
1293
      "description": "The definition of node statistics.",
1294
      "properties": {
1295
        "name": {
1296
          "description": "The name of the node.",
1297
          "type": "string"
1298
        },
1299
        "status": {
1300
          "description": "Node's status.",
1301
          "type": "string",
1302
          "default": "HEALTHY",
1303
          "enum": [
1304
            "HEALTHY",
1305
            "UNHEALTHY",
1306
            "UNAVAILABLE",
1307
            "TIMEOUT"
1308
          ]
1309
        },
1310
        "bootstrapped": {
1311
          "type": "boolean"
1312
        },
1313
        "dbLoaded": {
1314
          "type": "boolean"
1315
        },
1316
        "initialLastAppliedIndex": {
1317
          "type": "number",
1318
          "format": "uint64"
1319
        },
1320
        "lastAppliedIndex": {
1321
          "type": "number"
1322
        },
1323
        "isVoter": {
1324
          "type": "boolean"
1325
        },
1326
        "leaderId": {
1327
          "type": "object"
1328
        },
1329
        "leaderAddress": {
1330
          "type": "object"
1331
        },
1332
        "open": {
1333
          "type": "boolean"
1334
        },
1335
        "ready": {
1336
          "type": "boolean"
1337
        },
1338
        "candidates": {
1339
          "type": "object"
1340
        },
1341
        "raft": {
1342
          "description": "Weaviate Raft statistics.",
1343
          "type": "object",
1344
          "$ref": "#/definitions/RaftStatistics"
1345
        }
1346
      }
1347
    },
1348
    "ClusterStatisticsResponse": {
1349
      "description": "The cluster statistics of all of the Weaviate nodes",
1350
      "type": "object",
1351
      "properties": {
1352
        "statistics": {
1353
          "type": "array",
1354
          "items": {
1355
            "$ref": "#/definitions/Statistics"
1356
          }
1357
        },
1358
        "synchronized": {
1359
          "type": "boolean",
1360
          "x-omitempty": false
1361
        }
1362
      }
1363
    },
1364
    "SingleRef": {
1365
      "description": "Either set beacon (direct reference) or set class and schema (concept reference)",
1366
      "properties": {
1367
        "class": {
1368
          "description": "If using a concept reference (rather than a direct reference), specify the desired class name here",
1369
          "format": "uri",
1370
          "type": "string"
1371
        },
1372
        "schema": {
1373
          "description": "If using a concept reference (rather than a direct reference), specify the desired properties here",
1374
          "$ref": "#/definitions/PropertySchema"
1375
        },
1376
        "beacon": {
1377
          "description": "If using a direct reference, specify the URI to point to the cross-ref here. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object",
1378
          "format": "uri",
1379
          "type": "string"
1380
        },
1381
        "href": {
1382
          "description": "If using a direct reference, this read-only fields provides a link to the referenced resource. If 'origin' is globally configured, an absolute URI is shown - a relative URI otherwise.",
1383
          "format": "uri",
1384
          "type": "string"
1385
        },
1386
        "classification": {
1387
          "description": "Additional Meta information about classifications if the item was part of one",
1388
          "$ref": "#/definitions/ReferenceMetaClassification"
1389
        }
1390
      }
1391
    },
1392
    "AdditionalProperties": {
1393
      "description": "Additional Meta information about a single object object.",
1394
      "type": "object",
1395
      "additionalProperties": {
1396
        "type": "object"
1397
      }
1398
    },
1399
    "ReferenceMetaClassification": {
1400
      "description": "This meta field contains additional info about the classified reference property",
1401
      "properties": {
1402
        "overallCount": {
1403
          "description": "overall neighbors checked as part of the classification. In most cases this will equal k, but could be lower than k - for example if not enough data was present",
1404
          "type": "number",
1405
          "format": "int64"
1406
        },
1407
        "winningCount": {
1408
          "description": "size of the winning group, a number between 1..k",
1409
          "type": "number",
1410
          "format": "int64"
1411
        },
1412
        "losingCount": {
1413
          "description": "size of the losing group, can be 0 if the winning group size equals k",
1414
          "type": "number",
1415
          "format": "int64"
1416
        },
1417
        "closestOverallDistance": {
1418
          "description": "The lowest distance of any neighbor, regardless of whether they were in the winning or losing group",
1419
          "type": "number",
1420
          "format": "float32"
1421
        },
1422
        "winningDistance": {
1423
          "description": "deprecated - do not use, to be removed in 0.23.0",
1424
          "type": "number",
1425
          "format": "float32"
1426
        },
1427
        "meanWinningDistance": {
1428
          "description": "Mean distance of all neighbors from the winning group",
1429
          "type": "number",
1430
          "format": "float32"
1431
        },
1432
        "closestWinningDistance": {
1433
          "description": "Closest distance of a neighbor from the winning group",
1434
          "type": "number",
1435
          "format": "float32"
1436
        },
1437
        "closestLosingDistance": {
1438
          "description": "The lowest distance of a neighbor in the losing group. Optional. If k equals the size of the winning group, there is no losing group",
1439
          "type": "number",
1440
          "format": "float32",
1441
          "x-nullable": true
1442
        },
1443
        "losingDistance": {
1444
          "description": "deprecated - do not use, to be removed in 0.23.0",
1445
          "type": "number",
1446
          "format": "float32",
1447
          "x-nullable": true
1448
        },
1449
        "meanLosingDistance": {
1450
          "description": "Mean distance of all neighbors from the losing group. Optional. If k equals the size of the winning group, there is no losing group.",
1451
          "type": "number",
1452
          "format": "float32",
1453
          "x-nullable": true
1454
        }
1455
      }
1456
    },
1457
    "BatchReference": {
1458
      "properties": {
1459
        "from": {
1460
          "description": "Long-form beacon-style URI to identify the source of the cross-ref including the property name. Should be in the form of weaviate://localhost/<kinds>/<uuid>/<className>/<propertyName>, where <kinds> must be one of 'objects', 'objects' and <className> and <propertyName> must represent the cross-ref property of source class to be used.",
1461
          "format": "uri",
1462
          "type": "string",
1463
          "example": "weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals"
1464
        },
1465
        "to": {
1466
          "description": "Short-form URI to point to the cross-ref. Should be in the form of weaviate://localhost/<uuid> for the example of a local cross-ref to an object",
1467
          "example": "weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f",
1468
          "format": "uri",
1469
          "type": "string"
1470
        },
1471
        "tenant": {
1472
          "type": "string",
1473
          "description": "Name of the reference tenant."
1474
        }
1475
      }
1476
    },
1477
    "BatchReferenceResponse": {
1478
      "allOf": [
1479
        {
1480
          "$ref": "#/definitions/BatchReference"
1481
        },
1482
        {
1483
          "properties": {
1484
            "result": {
1485
              "description": "Results for this specific reference.",
1486
              "format": "object",
1487
              "properties": {
1488
                "status": {
1489
                  "type": "string",
1490
                  "default": "SUCCESS",
1491
                  "enum": [
1492
                    "SUCCESS",
1493
                    "PENDING",
1494
                    "FAILED"
1495
                  ]
1496
                },
1497
                "errors": {
1498
                  "$ref": "#/definitions/ErrorResponse"
1499
                }
1500
              }
1501
            }
1502
          }
1503
        }
1504
      ],
1505
      "type": "object"
1506
    },
1507
    "GeoCoordinates": {
1508
      "properties": {
1509
        "latitude": {
1510
          "description": "The latitude of the point on earth in decimal form",
1511
          "format": "float",
1512
          "type": "number",
1513
          "x-nullable": true
1514
        },
1515
        "longitude": {
1516
          "description": "The longitude of the point on earth in decimal form",
1517
          "format": "float",
1518
          "type": "number",
1519
          "x-nullable": true
1520
        }
1521
      }
1522
    },
1523
    "PhoneNumber": {
1524
      "properties": {
1525
        "input": {
1526
          "description": "The raw input as the phone number is present in your raw data set. It will be parsed into the standardized formats if valid.",
1527
          "type": "string"
1528
        },
1529
        "internationalFormatted": {
1530
          "description": "Read-only. Parsed result in the international format (e.g. +49 123 ...)",
1531
          "type": "string"
1532
        },
1533
        "defaultCountry": {
1534
          "description": "Optional. The ISO 3166-1 alpha-2 country code. This is used to figure out the correct countryCode and international format if only a national number (e.g. 0123 4567) is provided",
1535
          "type": "string"
1536
        },
1537
        "countryCode": {
1538
          "description": "Read-only. The numerical country code (e.g. 49)",
1539
          "format": "uint64",
1540
          "type": "number"
1541
        },
1542
        "national": {
1543
          "description": "Read-only. The numerical representation of the national part",
1544
          "format": "uint64",
1545
          "type": "number"
1546
        },
1547
        "nationalFormatted": {
1548
          "description": "Read-only. Parsed result in the national format (e.g. 0123 456789)",
1549
          "type": "string"
1550
        },
1551
        "valid": {
1552
          "description": "Read-only. Indicates whether the parsed number is a valid phone number",
1553
          "type": "boolean"
1554
        }
1555
      }
1556
    },
1557
    "Object": {
1558
      "properties": {
1559
        "class": {
1560
          "description": "Class of the Object, defined in the schema.",
1561
          "type": "string"
1562
        },
1563
        "vectorWeights": {
1564
          "$ref": "#/definitions/VectorWeights"
1565
        },
1566
        "properties": {
1567
          "$ref": "#/definitions/PropertySchema"
1568
        },
1569
        "id": {
1570
          "description": "ID of the Object.",
1571
          "format": "uuid",
1572
          "type": "string"
1573
        },
1574
        "creationTimeUnix": {
1575
          "description": "Timestamp of creation of this Object in milliseconds since epoch UTC.",
1576
          "format": "int64",
1577
          "type": "integer"
1578
        },
1579
        "lastUpdateTimeUnix": {
1580
          "description": "Timestamp of the last Object update in milliseconds since epoch UTC.",
1581
          "format": "int64",
1582
          "type": "integer"
1583
        },
1584
        "vector": {
1585
          "description": "This field returns vectors associated with the Object. C11yVector, Vector or Vectors values are possible.",
1586
          "$ref": "#/definitions/C11yVector"
1587
        },
1588
        "vectors": {
1589
          "description": "This field returns vectors associated with the Object.",
1590
          "$ref": "#/definitions/Vectors"
1591
        },
1592
        "tenant": {
1593
          "description": "Name of the Objects tenant.",
1594
          "type": "string"
1595
        },
1596
        "additional": {
1597
          "$ref": "#/definitions/AdditionalProperties"
1598
        }
1599
      },
1600
      "type": "object"
1601
    },
1602
    "ObjectsGetResponse": {
1603
      "allOf": [
1604
        {
1605
          "$ref": "#/definitions/Object"
1606
        },
1607
        {
1608
          "properties": {
1609
            "deprecations": {
1610
              "type": "array",
1611
              "items": {
1612
                "$ref": "#/definitions/Deprecation"
1613
              }
1614
            }
1615
          }
1616
        },
1617
        {
1618
          "properties": {
1619
            "result": {
1620
              "description": "Results for this specific Object.",
1621
              "format": "object",
1622
              "properties": {
1623
                "status": {
1624
                  "type": "string",
1625
                  "default": "SUCCESS",
1626
                  "enum": [
1627
                    "SUCCESS",
1628
                    "PENDING",
1629
                    "FAILED"
1630
                  ]
1631
                },
1632
                "errors": {
1633
                  "$ref": "#/definitions/ErrorResponse"
1634
                }
1635
              }
1636
            }
1637
          }
1638
        }
1639
      ],
1640
      "type": "object"
1641
    },
1642
    "BatchDelete": {
1643
      "type": "object",
1644
      "properties": {
1645
        "match": {
1646
          "description": "Outlines how to find the objects to be deleted.",
1647
          "type": "object",
1648
          "properties": {
1649
            "class": {
1650
              "description": "Class (name) which objects will be deleted.",
1651
              "type": "string",
1652
              "example": "City"
1653
            },
1654
            "where": {
1655
              "description": "Filter to limit the objects to be deleted.",
1656
              "type": "object",
1657
              "$ref": "#/definitions/WhereFilter"
1658
            }
1659
          }
1660
        },
1661
        "output": {
1662
          "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".",
1663
          "type": "string",
1664
          "default": "minimal"
1665
        },
1666
        "dryRun": {
1667
          "description": "If true, objects will not be deleted yet, but merely listed. Defaults to false.",
1668
          "type": "boolean",
1669
          "default": false
1670
        }
1671
      }
1672
    },
1673
    "BatchDeleteResponse": {
1674
      "description": "Delete Objects response.",
1675
      "type": "object",
1676
      "properties": {
1677
        "match": {
1678
          "description": "Outlines how to find the objects to be deleted.",
1679
          "type": "object",
1680
          "properties": {
1681
            "class": {
1682
              "description": "Class (name) which objects will be deleted.",
1683
              "type": "string",
1684
              "example": "City"
1685
            },
1686
            "where": {
1687
              "description": "Filter to limit the objects to be deleted.",
1688
              "type": "object",
1689
              "$ref": "#/definitions/WhereFilter"
1690
            }
1691
          }
1692
        },
1693
        "output": {
1694
          "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".",
1695
          "type": "string",
1696
          "default": "minimal"
1697
        },
1698
        "dryRun": {
1699
          "description": "If true, objects will not be deleted yet, but merely listed. Defaults to false.",
1700
          "type": "boolean",
1701
          "default": false
1702
        },
1703
        "results": {
1704
          "type": "object",
1705
          "properties": {
1706
            "matches": {
1707
              "description": "How many objects were matched by the filter.",
1708
              "type": "number",
1709
              "format": "int64",
1710
              "x-omitempty": false
1711
            },
1712
            "limit": {
1713
              "description": "The most amount of objects that can be deleted in a single query, equals QUERY_MAXIMUM_RESULTS.",
1714
              "type": "number",
1715
              "format": "int64",
1716
              "x-omitempty": false
1717
            },
1718
            "successful": {
1719
              "description": "How many objects were successfully deleted in this round.",
1720
              "type": "number",
1721
              "format": "int64",
1722
              "x-omitempty": false
1723
            },
1724
            "failed": {
1725
              "description": "How many objects should have been deleted but could not be deleted.",
1726
              "type": "number",
1727
              "format": "int64",
1728
              "x-omitempty": false
1729
            },
1730
            "objects": {
1731
              "description": "With output set to \"minimal\" only objects with error occurred will the be described. Successfully deleted objects would be omitted. Output set to \"verbose\" will list all of the objets with their respective statuses.",
1732
              "type": "array",
1733
              "items": {
1734
                "description": "Results for this specific Object.",
1735
                "format": "object",
1736
                "properties": {
1737
                  "id": {
1738
                    "description": "ID of the Object.",
1739
                    "format": "uuid",
1740
                    "type": "string"
1741
                  },
1742
                  "status": {
1743
                    "type": "string",
1744
                    "default": "SUCCESS",
1745
                    "enum": [
1746
                      "SUCCESS",
1747
                      "DRYRUN",
1748
                      "FAILED"
1749
                    ]
1750
                  },
1751
                  "errors": {
1752
                    "$ref": "#/definitions/ErrorResponse"
1753
                  }
1754
                }
1755
              }
1756
            }
1757
          }
1758
        }
1759
      }
1760
    },
1761
    "ObjectsListResponse": {
1762
      "description": "List of Objects.",
1763
      "properties": {
1764
        "objects": {
1765
          "description": "The actual list of Objects.",
1766
          "items": {
1767
            "$ref": "#/definitions/Object"
1768
          },
1769
          "type": "array"
1770
        },
1771
        "deprecations": {
1772
          "type": "array",
1773
          "items": {
1774
            "$ref": "#/definitions/Deprecation"
1775
          }
1776
        },
1777
        "totalResults": {
1778
          "description": "The total number of Objects for the query. The number of items in a response may be smaller due to paging.",
1779
          "format": "int64",
1780
          "type": "integer"
1781
        }
1782
      },
1783
      "type": "object"
1784
    },
1785
    "Classification": {
1786
      "description": "Manage classifications, trigger them and view status of past classifications.",
1787
      "properties": {
1788
        "id": {
1789
          "description": "ID to uniquely identify this classification run",
1790
          "format": "uuid",
1791
          "type": "string",
1792
          "example": "ee722219-b8ec-4db1-8f8d-5150bb1a9e0c"
1793
        },
1794
        "class": {
1795
          "description": "class (name) which is used in this classification",
1796
          "type": "string",
1797
          "example": "City"
1798
        },
1799
        "classifyProperties": {
1800
          "description": "which ref-property to set as part of the classification",
1801
          "type": "array",
1802
          "items": {
1803
            "type": "string"
1804
          },
1805
          "example": [
1806
            "inCountry"
1807
          ]
1808
        },
1809
        "basedOnProperties": {
1810
          "description": "base the text-based classification on these fields (of type text)",
1811
          "type": "array",
1812
          "items": {
1813
            "type": "string"
1814
          },
1815
          "example": [
1816
            "description"
1817
          ]
1818
        },
1819
        "status": {
1820
          "description": "status of this classification",
1821
          "type": "string",
1822
          "enum": [
1823
            "running",
1824
            "completed",
1825
            "failed"
1826
          ],
1827
          "example": "running"
1828
        },
1829
        "meta": {
1830
          "description": "additional meta information about the classification",
1831
          "type": "object",
1832
          "$ref": "#/definitions/ClassificationMeta"
1833
        },
1834
        "type": {
1835
          "description": "which algorithm to use for classifications",
1836
          "type": "string"
1837
        },
1838
        "settings": {
1839
          "description": "classification-type specific settings",
1840
          "type": "object"
1841
        },
1842
        "error": {
1843
          "description": "error message if status == failed",
1844
          "type": "string",
1845
          "default": "",
1846
          "example": "classify xzy: something went wrong"
1847
        },
1848
        "filters": {
1849
          "type": "object",
1850
          "properties": {
1851
            "sourceWhere": {
1852
              "description": "limit the objects to be classified",
1853
              "type": "object",
1854
              "$ref": "#/definitions/WhereFilter"
1855
            },
1856
            "trainingSetWhere": {
1857
              "description": "Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn'",
1858
              "type": "object",
1859
              "$ref": "#/definitions/WhereFilter"
1860
            },
1861
            "targetWhere": {
1862
              "description": "Limit the possible sources when using an algorithm which doesn't really on training data, e.g. 'contextual'. When using an algorithm with a training set, such as 'knn', limit the training set instead",
1863
              "type": "object",
1864
              "$ref": "#/definitions/WhereFilter"
1865
            }
1866
          }
1867
        }
1868
      },
1869
      "type": "object"
1870
    },
1871
    "ClassificationMeta": {
1872
      "description": "Additional information to a specific classification",
1873
      "properties": {
1874
        "started": {
1875
          "description": "time when this classification was started",
1876
          "type": "string",
1877
          "format": "date-time",
1878
          "example": "2017-07-21T17:32:28Z"
1879
        },
1880
        "completed": {
1881
          "description": "time when this classification finished",
1882
          "type": "string",
1883
          "format": "date-time",
1884
          "example": "2017-07-21T17:32:28Z"
1885
        },
1886
        "count": {
1887
          "description": "number of objects which were taken into consideration for classification",
1888
          "type": "integer",
1889
          "example": 147
1890
        },
1891
        "countSucceeded": {
1892
          "description": "number of objects successfully classified",
1893
          "type": "integer",
1894
          "example": 140
1895
        },
1896
        "countFailed": {
1897
          "description": "number of objects which could not be classified - see error message for details",
1898
          "type": "integer",
1899
          "example": 7
1900
        }
1901
      },
1902
      "type": "object"
1903
    },
1904
    "WhereFilter": {
1905
      "description": "Filter search results using a where filter",
1906
      "properties": {
1907
        "operands": {
1908
          "description": "combine multiple where filters, requires 'And' or 'Or' operator",
1909
          "type": "array",
1910
          "items": {
1911
            "$ref": "#/definitions/WhereFilter"
1912
          }
1913
        },
1914
        "operator": {
1915
          "description": "operator to use",
1916
          "type": "string",
1917
          "enum": [
1918
            "And",
1919
            "Or",
1920
            "Equal",
1921
            "Like",
1922
            "NotEqual",
1923
            "GreaterThan",
1924
            "GreaterThanEqual",
1925
            "LessThan",
1926
            "LessThanEqual",
1927
            "WithinGeoRange",
1928
            "IsNull",
1929
            "ContainsAny",
1930
            "ContainsAll"
1931
          ],
1932
          "example": "GreaterThanEqual"
1933
        },
1934
        "path": {
1935
          "description": "path to the property currently being filtered",
1936
          "type": "array",
1937
          "items": {
1938
            "type": "string"
1939
          },
1940
          "example": [
1941
            "inCity",
1942
            "City",
1943
            "name"
1944
          ]
1945
        },
1946
        "valueInt": {
1947
          "description": "value as integer",
1948
          "type": "integer",
1949
          "format": "int64",
1950
          "example": 2000,
1951
          "x-nullable": true
1952
        },
1953
        "valueNumber": {
1954
          "description": "value as number/float",
1955
          "type": "number",
1956
          "format": "float64",
1957
          "example": 3.14,
1958
          "x-nullable": true
1959
        },
1960
        "valueBoolean": {
1961
          "description": "value as boolean",
1962
          "type": "boolean",
1963
          "example": false,
1964
          "x-nullable": true
1965
        },
1966
        "valueString": {
1967
          "description": "value as text (deprecated as of v1.19; alias for valueText)",
1968
          "type": "string",
1969
          "example": "my search term",
1970
          "x-nullable": true
1971
        },
1972
        "valueText": {
1973
          "description": "value as text",
1974
          "type": "string",
1975
          "example": "my search term",
1976
          "x-nullable": true
1977
        },
1978
        "valueDate": {
1979
          "description": "value as date (as string)",
1980
          "type": "string",
1981
          "example": "TODO",
1982
          "x-nullable": true
1983
        },
1984
        "valueIntArray": {
1985
          "description": "value as integer",
1986
          "type": "array",
1987
          "items": {
1988
            "type": "integer",
1989
            "format": "int64"
1990
          },
1991
          "example": "[100, 200]",
1992
          "x-nullable": true,
1993
          "x-omitempty": true
1994
        },
1995
        "valueNumberArray": {
1996
          "description": "value as number/float",
1997
          "type": "array",
1998
          "items": {
1999
            "type": "number",
2000
            "format": "float64"
2001
          },
2002
          "example": [
2003
            3.14
2004
          ],
2005
          "x-nullable": true,
2006
          "x-omitempty": true
2007
        },
2008
        "valueBooleanArray": {
2009
          "description": "value as boolean",
2010
          "type": "array",
2011
          "items": {
2012
            "type": "boolean"
2013
          },
2014
          "example": [
2015
            true,
2016
            false
2017
          ],
2018
          "x-nullable": true,
2019
          "x-omitempty": true
2020
        },
2021
        "valueStringArray": {
2022
          "description": "value as text (deprecated as of v1.19; alias for valueText)",
2023
          "type": "array",
2024
          "items": {
2025
            "type": "string"
2026
          },
2027
          "example": [
2028
            "my search term"
2029
          ],
2030
          "x-nullable": true,
2031
          "x-omitempty": true
2032
        },
2033
        "valueTextArray": {
2034
          "description": "value as text",
2035
          "type": "array",
2036
          "items": {
2037
            "type": "string"
2038
          },
2039
          "example": [
2040
            "my search term"
2041
          ],
2042
          "x-nullable": true,
2043
          "x-omitempty": true
2044
        },
2045
        "valueDateArray": {
2046
          "description": "value as date (as string)",
2047
          "type": "array",
2048
          "items": {
2049
            "type": "string"
2050
          },
2051
          "example": "TODO",
2052
          "x-nullable": true,
2053
          "x-omitempty": true
2054
        },
2055
        "valueGeoRange": {
2056
          "description": "value as geo coordinates and distance",
2057
          "type": "object",
2058
          "$ref": "#/definitions/WhereFilterGeoRange",
2059
          "x-nullable": true
2060
        }
2061
      },
2062
      "type": "object"
2063
    },
2064
    "WhereFilterGeoRange": {
2065
      "type": "object",
2066
      "description": "filter within a distance of a georange",
2067
      "properties": {
2068
        "geoCoordinates": {
2069
          "$ref": "#/definitions/GeoCoordinates",
2070
          "x-nullable": false
2071
        },
2072
        "distance": {
2073
          "type": "object",
2074
          "properties": {
2075
            "max": {
2076
              "type": "number",
2077
              "format": "float64"
2078
            }
2079
          }
2080
        }
2081
      }
2082
    },
2083
    "Tenant": {
2084
      "type": "object",
2085
      "description": "attributes representing a single tenant within weaviate",
2086
      "properties": {
2087
        "name": {
2088
          "description": "name of the tenant",
2089
          "type": "string"
2090
        },
2091
        "activityStatus": {
2092
          "description": "activity status of the tenant's shard. Optional for creating tenant (implicit `HOT`) and required for updating tenant. Allowed values are `HOT` - tenant is fully active, `WARM` - tenant is active, some restrictions are imposed (TBD; not supported yet), `COLD` - tenant is inactive; no actions can be performed on tenant, tenant's files are stored locally, `FROZEN` - as COLD, but files are stored on cloud storage (not supported yet)",
2093
          "type": "string",
2094
          "enum": [
2095
            "HOT",
2096
            "WARM",
2097
            "COLD",
2098
            "FROZEN"
2099
          ]
2100
        }
2101
      }
2102
    }
2103
  },
2104
  "externalDocs": {
2105
    "url": "https://github.com/weaviate/weaviate"
2106
  },
2107
  "info": {
2108
    "contact": {
2109
      "email": "hello@weaviate.io",
2110
      "name": "Weaviate",
2111
      "url": "https://github.com/weaviate"
2112
    },
2113
    "description": "Cloud-native, modular vector database",
2114
    "title": "Weaviate",
2115
    "version": "1.25.0-raft"
2116
  },
2117
  "parameters": {
2118
    "CommonAfterParameterQuery": {
2119
      "description": "The starting ID of the result window.",
2120
      "in": "query",
2121
      "name": "after",
2122
      "required": false,
2123
      "type": "string"
2124
    },
2125
    "CommonOffsetParameterQuery": {
2126
      "description": "The starting index of the result window. Default value is 0.",
2127
      "format": "int64",
2128
      "in": "query",
2129
      "name": "offset",
2130
      "required": false,
2131
      "type": "integer",
2132
      "default": 0
2133
    },
2134
    "CommonLimitParameterQuery": {
2135
      "description": "The maximum number of items to be returned per page. Default value is set in Weaviate config.",
2136
      "format": "int64",
2137
      "in": "query",
2138
      "name": "limit",
2139
      "required": false,
2140
      "type": "integer"
2141
    },
2142
    "CommonIncludeParameterQuery": {
2143
      "description": "Include additional information, such as classification infos. Allowed values include: classification, vector, interpretation",
2144
      "in": "query",
2145
      "name": "include",
2146
      "required": false,
2147
      "type": "string"
2148
    },
2149
    "CommonConsistencyLevelParameterQuery": {
2150
      "description": "Determines how many replicas must acknowledge a request before it is considered successful",
2151
      "in": "query",
2152
      "name": "consistency_level",
2153
      "required": false,
2154
      "type": "string"
2155
    },
2156
    "CommonTenantParameterQuery": {
2157
      "description": "Specifies the tenant in a request targeting a multi-tenant class",
2158
      "in": "query",
2159
      "name": "tenant",
2160
      "required": false,
2161
      "type": "string"
2162
    },
2163
    "CommonNodeNameParameterQuery": {
2164
      "description": "The target node which should fulfill the request",
2165
      "in": "query",
2166
      "name": "node_name",
2167
      "required": false,
2168
      "type": "string"
2169
    },
2170
    "CommonSortParameterQuery": {
2171
      "description": "Sort parameter to pass an information about the names of the sort fields",
2172
      "in": "query",
2173
      "name": "sort",
2174
      "required": false,
2175
      "type": "string"
2176
    },
2177
    "CommonOrderParameterQuery": {
2178
      "description": "Order parameter to tell how to order (asc or desc) data within given field",
2179
      "in": "query",
2180
      "name": "order",
2181
      "required": false,
2182
      "type": "string"
2183
    },
2184
    "CommonClassParameterQuery": {
2185
      "description": "Class parameter specifies the class from which to query objects",
2186
      "in": "query",
2187
      "name": "class",
2188
      "required": false,
2189
      "type": "string"
2190
    },
2191
    "CommonOutputVerbosityParameterQuery": {
2192
      "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".",
2193
      "in": "query",
2194
      "name": "output",
2195
      "required": false,
2196
      "type": "string",
2197
      "default": "minimal"
2198
    }
2199
  },
2200
  "paths": {
2201
    "/": {
2202
      "get": {
2203
        "description": "Home. Discover the REST API",
2204
        "operationId": "weaviate.root",
2205
        "responses": {
2206
          "200": {
2207
            "description": "Weaviate is alive and ready to serve content",
2208
            "schema": {
2209
              "type": "object",
2210
              "properties": {
2211
                "links": {
2212
                  "type": "array",
2213
                  "items": {
2214
                    "$ref": "#/definitions/Link"
2215
                  }
2216
                }
2217
              }
2218
            }
2219
          }
2220
        }
2221
      }
2222
    },
2223
    "/.well-known/live": {
2224
      "get": {
2225
        "description": "Determines whether the application is alive. Can be used for kubernetes liveness probe",
2226
        "operationId": "weaviate.wellknown.liveness",
2227
        "responses": {
2228
          "200": {
2229
            "description": "The application is able to respond to HTTP requests"
2230
          }
2231
        }
2232
      }
2233
    },
2234
    "/.well-known/ready": {
2235
      "get": {
2236
        "description": "Determines whether the application is ready to receive traffic. Can be used for kubernetes readiness probe.",
2237
        "operationId": "weaviate.wellknown.readiness",
2238
        "responses": {
2239
          "200": {
2240
            "description": "The application has completed its start-up routine and is ready to accept traffic."
2241
          },
2242
          "503": {
2243
            "description": "The application is currently not able to serve traffic. If other horizontal replicas of weaviate are available and they are capable of receiving traffic, all traffic should be redirected there instead."
2244
          }
2245
        }
2246
      }
2247
    },
2248
    "/.well-known/openid-configuration": {
2249
      "get": {
2250
        "description": "OIDC Discovery page, redirects to the token issuer if one is configured",
2251
        "responses": {
2252
          "200": {
2253
            "description": "Successful response, inspect body",
2254
            "schema": {
2255
              "type": "object",
2256
              "properties": {
2257
                "href": {
2258
                  "description": "The Location to redirect to",
2259
                  "type": "string"
2260
                },
2261
                "clientId": {
2262
                  "description": "OAuth Client ID",
2263
                  "type": "string"
2264
                },
2265
                "scopes": {
2266
                  "description": "OAuth Scopes",
2267
                  "type": "array",
2268
                  "items": {
2269
                    "type": "string"
2270
                  },
2271
                  "x-omitempty": true
2272
                }
2273
              }
2274
            }
2275
          },
2276
          "404": {
2277
            "description": "Not found, no oidc provider present"
2278
          },
2279
          "500": {
2280
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2281
            "schema": {
2282
              "$ref": "#/definitions/ErrorResponse"
2283
            }
2284
          }
2285
        },
2286
        "summary": "OIDC discovery information if OIDC auth is enabled",
2287
        "tags": [
2288
          "well-known",
2289
          "oidc",
2290
          "discovery"
2291
        ],
2292
        "x-available-in-mqtt": false,
2293
        "x-available-in-websocket": false
2294
      }
2295
    },
2296
    "/objects": {
2297
      "get": {
2298
        "description": "Lists all Objects in reverse order of creation, owned by the user that belongs to the used token.",
2299
        "operationId": "objects.list",
2300
        "x-serviceIds": [
2301
          "weaviate.local.query"
2302
        ],
2303
        "parameters": [
2304
          {
2305
            "$ref": "#/parameters/CommonAfterParameterQuery"
2306
          },
2307
          {
2308
            "$ref": "#/parameters/CommonOffsetParameterQuery"
2309
          },
2310
          {
2311
            "$ref": "#/parameters/CommonLimitParameterQuery"
2312
          },
2313
          {
2314
            "$ref": "#/parameters/CommonIncludeParameterQuery"
2315
          },
2316
          {
2317
            "$ref": "#/parameters/CommonSortParameterQuery"
2318
          },
2319
          {
2320
            "$ref": "#/parameters/CommonOrderParameterQuery"
2321
          },
2322
          {
2323
            "$ref": "#/parameters/CommonClassParameterQuery"
2324
          },
2325
          {
2326
            "$ref": "#/parameters/CommonTenantParameterQuery"
2327
          }
2328
        ],
2329
        "responses": {
2330
          "200": {
2331
            "description": "Successful response.",
2332
            "schema": {
2333
              "$ref": "#/definitions/ObjectsListResponse"
2334
            }
2335
          },
2336
          "400": {
2337
            "description": "Malformed request.",
2338
            "schema": {
2339
              "$ref": "#/definitions/ErrorResponse"
2340
            }
2341
          },
2342
          "401": {
2343
            "description": "Unauthorized or invalid credentials."
2344
          },
2345
          "403": {
2346
            "description": "Forbidden",
2347
            "schema": {
2348
              "$ref": "#/definitions/ErrorResponse"
2349
            }
2350
          },
2351
          "404": {
2352
            "description": "Successful query result but no resource was found."
2353
          },
2354
          "422": {
2355
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
2356
            "schema": {
2357
              "$ref": "#/definitions/ErrorResponse"
2358
            }
2359
          },
2360
          "500": {
2361
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2362
            "schema": {
2363
              "$ref": "#/definitions/ErrorResponse"
2364
            }
2365
          }
2366
        },
2367
        "summary": "Get a list of Objects.",
2368
        "tags": [
2369
          "objects"
2370
        ],
2371
        "x-available-in-mqtt": false,
2372
        "x-available-in-websocket": false
2373
      },
2374
      "post": {
2375
        "description": "Registers a new Object. Provided meta-data and schema values are validated.",
2376
        "operationId": "objects.create",
2377
        "x-serviceIds": [
2378
          "weaviate.local.add"
2379
        ],
2380
        "parameters": [
2381
          {
2382
            "in": "body",
2383
            "name": "body",
2384
            "required": true,
2385
            "schema": {
2386
              "$ref": "#/definitions/Object"
2387
            }
2388
          },
2389
          {
2390
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2391
          }
2392
        ],
2393
        "responses": {
2394
          "200": {
2395
            "description": "Object created.",
2396
            "schema": {
2397
              "$ref": "#/definitions/Object"
2398
            }
2399
          },
2400
          "400": {
2401
            "description": "Malformed request.",
2402
            "schema": {
2403
              "$ref": "#/definitions/ErrorResponse"
2404
            }
2405
          },
2406
          "401": {
2407
            "description": "Unauthorized or invalid credentials."
2408
          },
2409
          "403": {
2410
            "description": "Forbidden",
2411
            "schema": {
2412
              "$ref": "#/definitions/ErrorResponse"
2413
            }
2414
          },
2415
          "422": {
2416
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
2417
            "schema": {
2418
              "$ref": "#/definitions/ErrorResponse"
2419
            }
2420
          },
2421
          "500": {
2422
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2423
            "schema": {
2424
              "$ref": "#/definitions/ErrorResponse"
2425
            }
2426
          }
2427
        },
2428
        "summary": "Create Objects between two Objects (object and subject).",
2429
        "tags": [
2430
          "objects"
2431
        ],
2432
        "x-available-in-mqtt": false,
2433
        "x-available-in-websocket": false
2434
      }
2435
    },
2436
    "/objects/{id}": {
2437
      "delete": {
2438
        "description": "Deletes an Object from the system.",
2439
        "operationId": "objects.delete",
2440
        "x-serviceIds": [
2441
          "weaviate.local.manipulate"
2442
        ],
2443
        "parameters": [
2444
          {
2445
            "description": "Unique ID of the Object.",
2446
            "format": "uuid",
2447
            "in": "path",
2448
            "name": "id",
2449
            "required": true,
2450
            "type": "string"
2451
          },
2452
          {
2453
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2454
          },
2455
          {
2456
            "$ref": "#/parameters/CommonTenantParameterQuery"
2457
          }
2458
        ],
2459
        "responses": {
2460
          "204": {
2461
            "description": "Successfully deleted."
2462
          },
2463
          "401": {
2464
            "description": "Unauthorized or invalid credentials."
2465
          },
2466
          "403": {
2467
            "description": "Forbidden",
2468
            "schema": {
2469
              "$ref": "#/definitions/ErrorResponse"
2470
            }
2471
          },
2472
          "404": {
2473
            "description": "Successful query result but no resource was found."
2474
          },
2475
          "500": {
2476
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2477
            "schema": {
2478
              "$ref": "#/definitions/ErrorResponse"
2479
            }
2480
          }
2481
        },
2482
        "summary": "Delete an Object based on its UUID.",
2483
        "tags": [
2484
          "objects"
2485
        ],
2486
        "x-available-in-mqtt": true,
2487
        "x-available-in-websocket": true,
2488
        "deprecated": true
2489
      },
2490
      "get": {
2491
        "description": "Lists Objects.",
2492
        "operationId": "objects.get",
2493
        "x-serviceIds": [
2494
          "weaviate.local.query"
2495
        ],
2496
        "parameters": [
2497
          {
2498
            "description": "Unique ID of the Object.",
2499
            "format": "uuid",
2500
            "in": "path",
2501
            "name": "id",
2502
            "required": true,
2503
            "type": "string"
2504
          },
2505
          {
2506
            "$ref": "#/parameters/CommonIncludeParameterQuery"
2507
          }
2508
        ],
2509
        "responses": {
2510
          "200": {
2511
            "description": "Successful response.",
2512
            "schema": {
2513
              "$ref": "#/definitions/Object"
2514
            }
2515
          },
2516
          "400": {
2517
            "description": "Malformed request.",
2518
            "schema": {
2519
              "$ref": "#/definitions/ErrorResponse"
2520
            }
2521
          },
2522
          "401": {
2523
            "description": "Unauthorized or invalid credentials."
2524
          },
2525
          "403": {
2526
            "description": "Forbidden",
2527
            "schema": {
2528
              "$ref": "#/definitions/ErrorResponse"
2529
            }
2530
          },
2531
          "404": {
2532
            "description": "Successful query result but no resource was found."
2533
          },
2534
          "500": {
2535
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2536
            "schema": {
2537
              "$ref": "#/definitions/ErrorResponse"
2538
            }
2539
          }
2540
        },
2541
        "summary": "Get a specific Object based on its UUID and a Object UUID. Also available as Websocket bus.",
2542
        "tags": [
2543
          "objects"
2544
        ],
2545
        "x-available-in-mqtt": false,
2546
        "x-available-in-websocket": false,
2547
        "deprecated": true
2548
      },
2549
      "patch": {
2550
        "description": "Updates an Object. This method supports json-merge style patch semantics (RFC 7396). Provided meta-data and schema values are validated. LastUpdateTime is set to the time this function is called.",
2551
        "operationId": "objects.patch",
2552
        "x-serviceIds": [
2553
          "weaviate.local.manipulate"
2554
        ],
2555
        "parameters": [
2556
          {
2557
            "description": "Unique ID of the Object.",
2558
            "format": "uuid",
2559
            "in": "path",
2560
            "name": "id",
2561
            "required": true,
2562
            "type": "string"
2563
          },
2564
          {
2565
            "description": "RFC 7396-style patch, the body contains the object to merge into the existing object.",
2566
            "in": "body",
2567
            "name": "body",
2568
            "required": false,
2569
            "schema": {
2570
              "$ref": "#/definitions/Object"
2571
            }
2572
          },
2573
          {
2574
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2575
          }
2576
        ],
2577
        "responses": {
2578
          "204": {
2579
            "description": "Successfully applied. No content provided."
2580
          },
2581
          "400": {
2582
            "description": "The patch-JSON is malformed."
2583
          },
2584
          "401": {
2585
            "description": "Unauthorized or invalid credentials."
2586
          },
2587
          "403": {
2588
            "description": "Forbidden",
2589
            "schema": {
2590
              "$ref": "#/definitions/ErrorResponse"
2591
            }
2592
          },
2593
          "404": {
2594
            "description": "Successful query result but no resource was found."
2595
          },
2596
          "422": {
2597
            "description": "The patch-JSON is valid but unprocessable.",
2598
            "schema": {
2599
              "$ref": "#/definitions/ErrorResponse"
2600
            }
2601
          },
2602
          "500": {
2603
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2604
            "schema": {
2605
              "$ref": "#/definitions/ErrorResponse"
2606
            }
2607
          }
2608
        },
2609
        "summary": "Update an Object based on its UUID (using patch semantics).",
2610
        "tags": [
2611
          "objects"
2612
        ],
2613
        "x-available-in-mqtt": false,
2614
        "x-available-in-websocket": false,
2615
        "deprecated": true
2616
      },
2617
      "put": {
2618
        "description": "Updates an Object's data. Given meta-data and schema values are validated. LastUpdateTime is set to the time this function is called.",
2619
        "operationId": "objects.update",
2620
        "x-serviceIds": [
2621
          "weaviate.local.manipulate"
2622
        ],
2623
        "parameters": [
2624
          {
2625
            "description": "Unique ID of the Object.",
2626
            "format": "uuid",
2627
            "in": "path",
2628
            "name": "id",
2629
            "required": true,
2630
            "type": "string"
2631
          },
2632
          {
2633
            "in": "body",
2634
            "name": "body",
2635
            "required": true,
2636
            "schema": {
2637
              "$ref": "#/definitions/Object"
2638
            }
2639
          },
2640
          {
2641
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2642
          }
2643
        ],
2644
        "responses": {
2645
          "200": {
2646
            "description": "Successfully received.",
2647
            "schema": {
2648
              "$ref": "#/definitions/Object"
2649
            }
2650
          },
2651
          "401": {
2652
            "description": "Unauthorized or invalid credentials."
2653
          },
2654
          "403": {
2655
            "description": "Forbidden",
2656
            "schema": {
2657
              "$ref": "#/definitions/ErrorResponse"
2658
            }
2659
          },
2660
          "404": {
2661
            "description": "Successful query result but no resource was found."
2662
          },
2663
          "422": {
2664
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
2665
            "schema": {
2666
              "$ref": "#/definitions/ErrorResponse"
2667
            }
2668
          },
2669
          "500": {
2670
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2671
            "schema": {
2672
              "$ref": "#/definitions/ErrorResponse"
2673
            }
2674
          }
2675
        },
2676
        "summary": "Update an Object based on its UUID.",
2677
        "tags": [
2678
          "objects"
2679
        ],
2680
        "x-available-in-mqtt": false,
2681
        "x-available-in-websocket": false,
2682
        "deprecated": true
2683
      },
2684
      "head": {
2685
        "description": "Checks if an Object exists in the system.",
2686
        "operationId": "objects.head",
2687
        "x-serviceIds": [
2688
          "weaviate.local.manipulate"
2689
        ],
2690
        "parameters": [
2691
          {
2692
            "description": "Unique ID of the Object.",
2693
            "format": "uuid",
2694
            "in": "path",
2695
            "name": "id",
2696
            "required": true,
2697
            "type": "string"
2698
          }
2699
        ],
2700
        "responses": {
2701
          "204": {
2702
            "description": "Object exists."
2703
          },
2704
          "401": {
2705
            "description": "Unauthorized or invalid credentials."
2706
          },
2707
          "403": {
2708
            "description": "Forbidden",
2709
            "schema": {
2710
              "$ref": "#/definitions/ErrorResponse"
2711
            }
2712
          },
2713
          "404": {
2714
            "description": "Object doesn't exist."
2715
          },
2716
          "500": {
2717
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2718
            "schema": {
2719
              "$ref": "#/definitions/ErrorResponse"
2720
            }
2721
          }
2722
        },
2723
        "summary": "Checks Object's existence based on its UUID.",
2724
        "tags": [
2725
          "objects"
2726
        ],
2727
        "x-available-in-mqtt": true,
2728
        "x-available-in-websocket": true,
2729
        "deprecated": true
2730
      }
2731
    },
2732
    "/objects/{className}/{id}": {
2733
      "get": {
2734
        "description": "Get a single data object",
2735
        "operationId": "objects.class.get",
2736
        "x-serviceIds": [
2737
          "weaviate.local.query"
2738
        ],
2739
        "parameters": [
2740
          {
2741
            "name": "className",
2742
            "in": "path",
2743
            "required": true,
2744
            "type": "string"
2745
          },
2746
          {
2747
            "description": "Unique ID of the Object.",
2748
            "format": "uuid",
2749
            "in": "path",
2750
            "name": "id",
2751
            "required": true,
2752
            "type": "string"
2753
          },
2754
          {
2755
            "$ref": "#/parameters/CommonIncludeParameterQuery"
2756
          },
2757
          {
2758
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2759
          },
2760
          {
2761
            "$ref": "#/parameters/CommonNodeNameParameterQuery"
2762
          },
2763
          {
2764
            "$ref": "#/parameters/CommonTenantParameterQuery"
2765
          }
2766
        ],
2767
        "responses": {
2768
          "200": {
2769
            "description": "Successful response.",
2770
            "schema": {
2771
              "$ref": "#/definitions/Object"
2772
            }
2773
          },
2774
          "400": {
2775
            "description": "Malformed request.",
2776
            "schema": {
2777
              "$ref": "#/definitions/ErrorResponse"
2778
            }
2779
          },
2780
          "401": {
2781
            "description": "Unauthorized or invalid credentials."
2782
          },
2783
          "403": {
2784
            "description": "Forbidden",
2785
            "schema": {
2786
              "$ref": "#/definitions/ErrorResponse"
2787
            }
2788
          },
2789
          "404": {
2790
            "description": "Successful query result but no resource was found."
2791
          },
2792
          "422": {
2793
            "description": "Request is well-formed (i.e., syntactically correct), but erroneous.",
2794
            "schema": {
2795
              "$ref": "#/definitions/ErrorResponse"
2796
            }
2797
          },
2798
          "500": {
2799
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2800
            "schema": {
2801
              "$ref": "#/definitions/ErrorResponse"
2802
            }
2803
          }
2804
        },
2805
        "summary": "Get a specific Object based on its class and UUID. Also available as Websocket bus.",
2806
        "tags": [
2807
          "objects"
2808
        ],
2809
        "x-available-in-mqtt": false,
2810
        "x-available-in-websocket": false
2811
      },
2812
      "delete": {
2813
        "description": "Delete a single data object.",
2814
        "operationId": "objects.class.delete",
2815
        "x-serviceIds": [
2816
          "weaviate.local.manipulate"
2817
        ],
2818
        "parameters": [
2819
          {
2820
            "name": "className",
2821
            "in": "path",
2822
            "required": true,
2823
            "type": "string"
2824
          },
2825
          {
2826
            "description": "Unique ID of the Object.",
2827
            "format": "uuid",
2828
            "in": "path",
2829
            "name": "id",
2830
            "required": true,
2831
            "type": "string"
2832
          },
2833
          {
2834
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2835
          },
2836
          {
2837
            "$ref": "#/parameters/CommonTenantParameterQuery"
2838
          }
2839
        ],
2840
        "responses": {
2841
          "204": {
2842
            "description": "Successfully deleted."
2843
          },
2844
          "400": {
2845
            "description": "Malformed request.",
2846
            "schema": {
2847
              "$ref": "#/definitions/ErrorResponse"
2848
            }
2849
          },
2850
          "401": {
2851
            "description": "Unauthorized or invalid credentials."
2852
          },
2853
          "403": {
2854
            "description": "Forbidden",
2855
            "schema": {
2856
              "$ref": "#/definitions/ErrorResponse"
2857
            }
2858
          },
2859
          "404": {
2860
            "description": "Successful query result but no resource was found."
2861
          },
2862
          "422": {
2863
            "description": "Request is well-formed (i.e., syntactically correct), but erroneous.",
2864
            "schema": {
2865
              "$ref": "#/definitions/ErrorResponse"
2866
            }
2867
          },
2868
          "500": {
2869
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2870
            "schema": {
2871
              "$ref": "#/definitions/ErrorResponse"
2872
            }
2873
          }
2874
        },
2875
        "summary": "Delete object based on its class and UUID.",
2876
        "tags": [
2877
          "objects"
2878
        ],
2879
        "x-available-in-mqtt": true,
2880
        "x-available-in-websocket": true
2881
      },
2882
      "put": {
2883
        "description": "Update an individual data object based on its class and uuid.",
2884
        "operationId": "objects.class.put",
2885
        "x-serviceIds": [
2886
          "weaviate.local.manipulate"
2887
        ],
2888
        "parameters": [
2889
          {
2890
            "name": "className",
2891
            "in": "path",
2892
            "required": true,
2893
            "type": "string"
2894
          },
2895
          {
2896
            "description": "The uuid of the data object to update.",
2897
            "format": "uuid",
2898
            "in": "path",
2899
            "name": "id",
2900
            "required": true,
2901
            "type": "string"
2902
          },
2903
          {
2904
            "in": "body",
2905
            "name": "body",
2906
            "required": true,
2907
            "schema": {
2908
              "$ref": "#/definitions/Object"
2909
            }
2910
          },
2911
          {
2912
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2913
          }
2914
        ],
2915
        "responses": {
2916
          "200": {
2917
            "description": "Successfully received.",
2918
            "schema": {
2919
              "$ref": "#/definitions/Object"
2920
            }
2921
          },
2922
          "401": {
2923
            "description": "Unauthorized or invalid credentials."
2924
          },
2925
          "403": {
2926
            "description": "Forbidden",
2927
            "schema": {
2928
              "$ref": "#/definitions/ErrorResponse"
2929
            }
2930
          },
2931
          "404": {
2932
            "description": "Successful query result but no resource was found."
2933
          },
2934
          "422": {
2935
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
2936
            "schema": {
2937
              "$ref": "#/definitions/ErrorResponse"
2938
            }
2939
          },
2940
          "500": {
2941
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
2942
            "schema": {
2943
              "$ref": "#/definitions/ErrorResponse"
2944
            }
2945
          }
2946
        },
2947
        "summary": "Update a class object based on its uuid",
2948
        "tags": [
2949
          "objects"
2950
        ],
2951
        "x-available-in-mqtt": false,
2952
        "x-available-in-websocket": false
2953
      },
2954
      "patch": {
2955
        "description": "Update an individual data object based on its class and uuid. This method supports json-merge style patch semantics (RFC 7396). Provided meta-data and schema values are validated. LastUpdateTime is set to the time this function is called.",
2956
        "operationId": "objects.class.patch",
2957
        "x-serviceIds": [
2958
          "weaviate.local.manipulate"
2959
        ],
2960
        "parameters": [
2961
          {
2962
            "description": "The class name as defined in the schema",
2963
            "name": "className",
2964
            "in": "path",
2965
            "required": true,
2966
            "type": "string"
2967
          },
2968
          {
2969
            "description": "The uuid of the data object to update.",
2970
            "format": "uuid",
2971
            "in": "path",
2972
            "name": "id",
2973
            "required": true,
2974
            "type": "string"
2975
          },
2976
          {
2977
            "description": "RFC 7396-style patch, the body contains the object to merge into the existing object.",
2978
            "in": "body",
2979
            "name": "body",
2980
            "required": false,
2981
            "schema": {
2982
              "$ref": "#/definitions/Object"
2983
            }
2984
          },
2985
          {
2986
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
2987
          }
2988
        ],
2989
        "responses": {
2990
          "204": {
2991
            "description": "Successfully applied. No content provided."
2992
          },
2993
          "400": {
2994
            "description": "The patch-JSON is malformed.",
2995
            "schema": {
2996
              "$ref": "#/definitions/ErrorResponse"
2997
            }
2998
          },
2999
          "401": {
3000
            "description": "Unauthorized or invalid credentials."
3001
          },
3002
          "403": {
3003
            "description": "Forbidden",
3004
            "schema": {
3005
              "$ref": "#/definitions/ErrorResponse"
3006
            }
3007
          },
3008
          "404": {
3009
            "description": "Successful query result but no resource was found."
3010
          },
3011
          "422": {
3012
            "description": "The patch-JSON is valid but unprocessable.",
3013
            "schema": {
3014
              "$ref": "#/definitions/ErrorResponse"
3015
            }
3016
          },
3017
          "500": {
3018
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3019
            "schema": {
3020
              "$ref": "#/definitions/ErrorResponse"
3021
            }
3022
          }
3023
        },
3024
        "summary": "Update an Object based on its UUID (using patch semantics).",
3025
        "tags": [
3026
          "objects"
3027
        ],
3028
        "x-available-in-mqtt": false,
3029
        "x-available-in-websocket": false
3030
      },
3031
      "head": {
3032
        "description": "Checks if a data object exists without retrieving it.",
3033
        "operationId": "objects.class.head",
3034
        "x-serviceIds": [
3035
          "weaviate.local.manipulate"
3036
        ],
3037
        "parameters": [
3038
          {
3039
            "description": "The class name as defined in the schema",
3040
            "name": "className",
3041
            "in": "path",
3042
            "required": true,
3043
            "type": "string"
3044
          },
3045
          {
3046
            "description": "The uuid of the data object",
3047
            "format": "uuid",
3048
            "in": "path",
3049
            "name": "id",
3050
            "required": true,
3051
            "type": "string"
3052
          },
3053
          {
3054
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3055
          },
3056
          {
3057
            "$ref": "#/parameters/CommonTenantParameterQuery"
3058
          }
3059
        ],
3060
        "responses": {
3061
          "204": {
3062
            "description": "Object exists."
3063
          },
3064
          "401": {
3065
            "description": "Unauthorized or invalid credentials."
3066
          },
3067
          "403": {
3068
            "description": "Forbidden",
3069
            "schema": {
3070
              "$ref": "#/definitions/ErrorResponse"
3071
            }
3072
          },
3073
          "404": {
3074
            "description": "Object doesn't exist."
3075
          },
3076
          "422": {
3077
            "description": "Request is well-formed (i.e., syntactically correct), but erroneous.",
3078
            "schema": {
3079
              "$ref": "#/definitions/ErrorResponse"
3080
            }
3081
          },
3082
          "500": {
3083
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3084
            "schema": {
3085
              "$ref": "#/definitions/ErrorResponse"
3086
            }
3087
          }
3088
        },
3089
        "summary": "Checks object's existence based on its class and uuid.",
3090
        "tags": [
3091
          "objects"
3092
        ],
3093
        "x-available-in-mqtt": true,
3094
        "x-available-in-websocket": true
3095
      }
3096
    },
3097
    "/objects/{id}/references/{propertyName}": {
3098
      "post": {
3099
        "description": "Add a single reference to a class-property.",
3100
        "operationId": "objects.references.create",
3101
        "x-serviceIds": [
3102
          "weaviate.local.manipulate"
3103
        ],
3104
        "parameters": [
3105
          {
3106
            "description": "Unique ID of the Object.",
3107
            "format": "uuid",
3108
            "in": "path",
3109
            "name": "id",
3110
            "required": true,
3111
            "type": "string"
3112
          },
3113
          {
3114
            "description": "Unique name of the property related to the Object.",
3115
            "in": "path",
3116
            "name": "propertyName",
3117
            "required": true,
3118
            "type": "string"
3119
          },
3120
          {
3121
            "in": "body",
3122
            "name": "body",
3123
            "required": true,
3124
            "schema": {
3125
              "$ref": "#/definitions/SingleRef"
3126
            }
3127
          },
3128
          {
3129
            "$ref": "#/parameters/CommonTenantParameterQuery"
3130
          }
3131
        ],
3132
        "responses": {
3133
          "200": {
3134
            "description": "Successfully added the reference."
3135
          },
3136
          "401": {
3137
            "description": "Unauthorized or invalid credentials."
3138
          },
3139
          "403": {
3140
            "description": "Forbidden",
3141
            "schema": {
3142
              "$ref": "#/definitions/ErrorResponse"
3143
            }
3144
          },
3145
          "422": {
3146
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the property exists or that it is a class?",
3147
            "schema": {
3148
              "$ref": "#/definitions/ErrorResponse"
3149
            }
3150
          },
3151
          "500": {
3152
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3153
            "schema": {
3154
              "$ref": "#/definitions/ErrorResponse"
3155
            }
3156
          }
3157
        },
3158
        "summary": "Add a single reference to a class-property.",
3159
        "tags": [
3160
          "objects"
3161
        ],
3162
        "x-available-in-mqtt": false,
3163
        "x-available-in-websocket": false,
3164
        "deprecated": true
3165
      },
3166
      "put": {
3167
        "description": "Replace all references to a class-property.",
3168
        "operationId": "objects.references.update",
3169
        "x-serviceIds": [
3170
          "weaviate.local.manipulate"
3171
        ],
3172
        "parameters": [
3173
          {
3174
            "description": "Unique ID of the Object.",
3175
            "format": "uuid",
3176
            "in": "path",
3177
            "name": "id",
3178
            "required": true,
3179
            "type": "string"
3180
          },
3181
          {
3182
            "description": "Unique name of the property related to the Object.",
3183
            "in": "path",
3184
            "name": "propertyName",
3185
            "required": true,
3186
            "type": "string"
3187
          },
3188
          {
3189
            "in": "body",
3190
            "name": "body",
3191
            "required": true,
3192
            "schema": {
3193
              "$ref": "#/definitions/MultipleRef"
3194
            }
3195
          },
3196
          {
3197
            "$ref": "#/parameters/CommonTenantParameterQuery"
3198
          }
3199
        ],
3200
        "responses": {
3201
          "200": {
3202
            "description": "Successfully replaced all the references."
3203
          },
3204
          "401": {
3205
            "description": "Unauthorized or invalid credentials."
3206
          },
3207
          "403": {
3208
            "description": "Forbidden",
3209
            "schema": {
3210
              "$ref": "#/definitions/ErrorResponse"
3211
            }
3212
          },
3213
          "422": {
3214
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the property exists or that it is a class?",
3215
            "schema": {
3216
              "$ref": "#/definitions/ErrorResponse"
3217
            }
3218
          },
3219
          "500": {
3220
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3221
            "schema": {
3222
              "$ref": "#/definitions/ErrorResponse"
3223
            }
3224
          }
3225
        },
3226
        "summary": "Replace all references to a class-property.",
3227
        "tags": [
3228
          "objects"
3229
        ],
3230
        "x-available-in-mqtt": false,
3231
        "x-available-in-websocket": false,
3232
        "deprecated": true
3233
      },
3234
      "delete": {
3235
        "description": "Delete the single reference that is given in the body from the list of references that this property has.",
3236
        "operationId": "objects.references.delete",
3237
        "x-serviceIds": [
3238
          "weaviate.local.manipulate"
3239
        ],
3240
        "parameters": [
3241
          {
3242
            "description": "Unique ID of the Object.",
3243
            "format": "uuid",
3244
            "in": "path",
3245
            "name": "id",
3246
            "required": true,
3247
            "type": "string"
3248
          },
3249
          {
3250
            "description": "Unique name of the property related to the Object.",
3251
            "in": "path",
3252
            "name": "propertyName",
3253
            "required": true,
3254
            "type": "string"
3255
          },
3256
          {
3257
            "in": "body",
3258
            "name": "body",
3259
            "required": true,
3260
            "schema": {
3261
              "$ref": "#/definitions/SingleRef"
3262
            }
3263
          },
3264
          {
3265
            "$ref": "#/parameters/CommonTenantParameterQuery"
3266
          }
3267
        ],
3268
        "responses": {
3269
          "204": {
3270
            "description": "Successfully deleted."
3271
          },
3272
          "401": {
3273
            "description": "Unauthorized or invalid credentials."
3274
          },
3275
          "403": {
3276
            "description": "Forbidden",
3277
            "schema": {
3278
              "$ref": "#/definitions/ErrorResponse"
3279
            }
3280
          },
3281
          "404": {
3282
            "description": "Successful query result but no resource was found.",
3283
            "schema": {
3284
              "$ref": "#/definitions/ErrorResponse"
3285
            }
3286
          },
3287
          "500": {
3288
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3289
            "schema": {
3290
              "$ref": "#/definitions/ErrorResponse"
3291
            }
3292
          }
3293
        },
3294
        "summary": "Delete the single reference that is given in the body from the list of references that this property has.",
3295
        "tags": [
3296
          "objects"
3297
        ],
3298
        "x-available-in-mqtt": false,
3299
        "x-available-in-websocket": false,
3300
        "deprecated": true
3301
      }
3302
    },
3303
    "/objects/{className}/{id}/references/{propertyName}": {
3304
      "post": {
3305
        "description": "Add a single reference to a class-property.",
3306
        "operationId": "objects.class.references.create",
3307
        "x-serviceIds": [
3308
          "weaviate.local.manipulate"
3309
        ],
3310
        "parameters": [
3311
          {
3312
            "description": "The class name as defined in the schema",
3313
            "name": "className",
3314
            "in": "path",
3315
            "required": true,
3316
            "type": "string"
3317
          },
3318
          {
3319
            "description": "Unique ID of the Object.",
3320
            "format": "uuid",
3321
            "in": "path",
3322
            "name": "id",
3323
            "required": true,
3324
            "type": "string"
3325
          },
3326
          {
3327
            "description": "Unique name of the property related to the Object.",
3328
            "in": "path",
3329
            "name": "propertyName",
3330
            "required": true,
3331
            "type": "string"
3332
          },
3333
          {
3334
            "in": "body",
3335
            "name": "body",
3336
            "required": true,
3337
            "schema": {
3338
              "$ref": "#/definitions/SingleRef"
3339
            }
3340
          },
3341
          {
3342
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3343
          },
3344
          {
3345
            "$ref": "#/parameters/CommonTenantParameterQuery"
3346
          }
3347
        ],
3348
        "responses": {
3349
          "200": {
3350
            "description": "Successfully added the reference."
3351
          },
3352
          "400": {
3353
            "description": "Malformed request.",
3354
            "schema": {
3355
              "$ref": "#/definitions/ErrorResponse"
3356
            }
3357
          },
3358
          "401": {
3359
            "description": "Unauthorized or invalid credentials."
3360
          },
3361
          "403": {
3362
            "description": "Forbidden",
3363
            "schema": {
3364
              "$ref": "#/definitions/ErrorResponse"
3365
            }
3366
          },
3367
          "404": {
3368
            "description": "Source object doesn't exist."
3369
          },
3370
          "422": {
3371
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the property exists or that it is a class?",
3372
            "schema": {
3373
              "$ref": "#/definitions/ErrorResponse"
3374
            }
3375
          },
3376
          "500": {
3377
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3378
            "schema": {
3379
              "$ref": "#/definitions/ErrorResponse"
3380
            }
3381
          }
3382
        },
3383
        "summary": "Add a single reference to a class-property.",
3384
        "tags": [
3385
          "objects"
3386
        ],
3387
        "x-available-in-mqtt": false,
3388
        "x-available-in-websocket": false
3389
      },
3390
      "put": {
3391
        "description": "Update all references of a property of a data object.",
3392
        "operationId": "objects.class.references.put",
3393
        "x-serviceIds": [
3394
          "weaviate.local.manipulate"
3395
        ],
3396
        "parameters": [
3397
          {
3398
            "description": "The class name as defined in the schema",
3399
            "name": "className",
3400
            "in": "path",
3401
            "required": true,
3402
            "type": "string"
3403
          },
3404
          {
3405
            "description": "Unique ID of the Object.",
3406
            "format": "uuid",
3407
            "in": "path",
3408
            "name": "id",
3409
            "required": true,
3410
            "type": "string"
3411
          },
3412
          {
3413
            "description": "Unique name of the property related to the Object.",
3414
            "in": "path",
3415
            "name": "propertyName",
3416
            "required": true,
3417
            "type": "string"
3418
          },
3419
          {
3420
            "in": "body",
3421
            "name": "body",
3422
            "required": true,
3423
            "schema": {
3424
              "$ref": "#/definitions/MultipleRef"
3425
            }
3426
          },
3427
          {
3428
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3429
          },
3430
          {
3431
            "$ref": "#/parameters/CommonTenantParameterQuery"
3432
          }
3433
        ],
3434
        "responses": {
3435
          "200": {
3436
            "description": "Successfully replaced all the references."
3437
          },
3438
          "400": {
3439
            "description": "Malformed request.",
3440
            "schema": {
3441
              "$ref": "#/definitions/ErrorResponse"
3442
            }
3443
          },
3444
          "401": {
3445
            "description": "Unauthorized or invalid credentials."
3446
          },
3447
          "403": {
3448
            "description": "Forbidden",
3449
            "schema": {
3450
              "$ref": "#/definitions/ErrorResponse"
3451
            }
3452
          },
3453
          "404": {
3454
            "description": "Source object doesn't exist."
3455
          },
3456
          "422": {
3457
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the property exists or that it is a class?",
3458
            "schema": {
3459
              "$ref": "#/definitions/ErrorResponse"
3460
            }
3461
          },
3462
          "500": {
3463
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3464
            "schema": {
3465
              "$ref": "#/definitions/ErrorResponse"
3466
            }
3467
          }
3468
        },
3469
        "summary": "Replace all references to a class-property.",
3470
        "tags": [
3471
          "objects"
3472
        ],
3473
        "x-available-in-mqtt": false,
3474
        "x-available-in-websocket": false
3475
      },
3476
      "delete": {
3477
        "description": "Delete the single reference that is given in the body from the list of references that this property of a data object has",
3478
        "operationId": "objects.class.references.delete",
3479
        "x-serviceIds": [
3480
          "weaviate.local.manipulate"
3481
        ],
3482
        "parameters": [
3483
          {
3484
            "description": "The class name as defined in the schema",
3485
            "name": "className",
3486
            "in": "path",
3487
            "required": true,
3488
            "type": "string"
3489
          },
3490
          {
3491
            "description": "Unique ID of the Object.",
3492
            "format": "uuid",
3493
            "in": "path",
3494
            "name": "id",
3495
            "required": true,
3496
            "type": "string"
3497
          },
3498
          {
3499
            "description": "Unique name of the property related to the Object.",
3500
            "in": "path",
3501
            "name": "propertyName",
3502
            "required": true,
3503
            "type": "string"
3504
          },
3505
          {
3506
            "in": "body",
3507
            "name": "body",
3508
            "required": true,
3509
            "schema": {
3510
              "$ref": "#/definitions/SingleRef"
3511
            }
3512
          },
3513
          {
3514
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3515
          },
3516
          {
3517
            "$ref": "#/parameters/CommonTenantParameterQuery"
3518
          }
3519
        ],
3520
        "responses": {
3521
          "204": {
3522
            "description": "Successfully deleted."
3523
          },
3524
          "400": {
3525
            "description": "Malformed request.",
3526
            "schema": {
3527
              "$ref": "#/definitions/ErrorResponse"
3528
            }
3529
          },
3530
          "401": {
3531
            "description": "Unauthorized or invalid credentials."
3532
          },
3533
          "403": {
3534
            "description": "Forbidden",
3535
            "schema": {
3536
              "$ref": "#/definitions/ErrorResponse"
3537
            }
3538
          },
3539
          "404": {
3540
            "description": "Successful query result but no resource was found.",
3541
            "schema": {
3542
              "$ref": "#/definitions/ErrorResponse"
3543
            }
3544
          },
3545
          "422": {
3546
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the property exists or that it is a class?",
3547
            "schema": {
3548
              "$ref": "#/definitions/ErrorResponse"
3549
            }
3550
          },
3551
          "500": {
3552
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3553
            "schema": {
3554
              "$ref": "#/definitions/ErrorResponse"
3555
            }
3556
          }
3557
        },
3558
        "summary": "Delete the single reference that is given in the body from the list of references that this property has.",
3559
        "tags": [
3560
          "objects"
3561
        ],
3562
        "x-available-in-mqtt": false,
3563
        "x-available-in-websocket": false
3564
      }
3565
    },
3566
    "/objects/validate": {
3567
      "post": {
3568
        "description": "Validate an Object's schema and meta-data. It has to be based on a schema, which is related to the given Object to be accepted by this validation.",
3569
        "operationId": "objects.validate",
3570
        "x-serviceIds": [
3571
          "weaviate.local.query.meta"
3572
        ],
3573
        "parameters": [
3574
          {
3575
            "in": "body",
3576
            "name": "body",
3577
            "required": true,
3578
            "schema": {
3579
              "$ref": "#/definitions/Object"
3580
            }
3581
          }
3582
        ],
3583
        "responses": {
3584
          "200": {
3585
            "description": "Successfully validated."
3586
          },
3587
          "401": {
3588
            "description": "Unauthorized or invalid credentials."
3589
          },
3590
          "403": {
3591
            "description": "Forbidden",
3592
            "schema": {
3593
              "$ref": "#/definitions/ErrorResponse"
3594
            }
3595
          },
3596
          "422": {
3597
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3598
            "schema": {
3599
              "$ref": "#/definitions/ErrorResponse"
3600
            }
3601
          },
3602
          "500": {
3603
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3604
            "schema": {
3605
              "$ref": "#/definitions/ErrorResponse"
3606
            }
3607
          }
3608
        },
3609
        "summary": "Validate an Object based on a schema.",
3610
        "tags": [
3611
          "objects"
3612
        ],
3613
        "x-available-in-mqtt": false,
3614
        "x-available-in-websocket": false
3615
      }
3616
    },
3617
    "/batch/objects": {
3618
      "post": {
3619
        "description": "Register new Objects in bulk. Provided meta-data and schema values are validated.",
3620
        "operationId": "batch.objects.create",
3621
        "x-serviceIds": [
3622
          "weaviate.local.add"
3623
        ],
3624
        "parameters": [
3625
          {
3626
            "in": "body",
3627
            "name": "body",
3628
            "required": true,
3629
            "schema": {
3630
              "type": "object",
3631
              "properties": {
3632
                "fields": {
3633
                  "description": "Define which fields need to be returned. Default value is ALL",
3634
                  "type": "array",
3635
                  "items": {
3636
                    "type": "string",
3637
                    "default": "ALL",
3638
                    "enum": [
3639
                      "ALL",
3640
                      "class",
3641
                      "schema",
3642
                      "id",
3643
                      "creationTimeUnix"
3644
                    ]
3645
                  }
3646
                },
3647
                "objects": {
3648
                  "type": "array",
3649
                  "items": {
3650
                    "$ref": "#/definitions/Object"
3651
                  }
3652
                }
3653
              }
3654
            }
3655
          },
3656
          {
3657
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3658
          }
3659
        ],
3660
        "responses": {
3661
          "200": {
3662
            "description": "Request succeeded, see response body to get detailed information about each batched item.",
3663
            "schema": {
3664
              "type": "array",
3665
              "items": {
3666
                "$ref": "#/definitions/ObjectsGetResponse"
3667
              }
3668
            }
3669
          },
3670
          "400": {
3671
            "description": "Malformed request.",
3672
            "schema": {
3673
              "$ref": "#/definitions/ErrorResponse"
3674
            }
3675
          },
3676
          "401": {
3677
            "description": "Unauthorized or invalid credentials."
3678
          },
3679
          "403": {
3680
            "description": "Forbidden",
3681
            "schema": {
3682
              "$ref": "#/definitions/ErrorResponse"
3683
            }
3684
          },
3685
          "422": {
3686
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3687
            "schema": {
3688
              "$ref": "#/definitions/ErrorResponse"
3689
            }
3690
          },
3691
          "500": {
3692
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3693
            "schema": {
3694
              "$ref": "#/definitions/ErrorResponse"
3695
            }
3696
          }
3697
        },
3698
        "summary": "Creates new Objects based on a Object template as a batch.",
3699
        "tags": [
3700
          "batch",
3701
          "objects"
3702
        ],
3703
        "x-available-in-mqtt": false,
3704
        "x-available-in-websocket": false
3705
      },
3706
      "delete": {
3707
        "description": "Delete Objects in bulk that match a certain filter.",
3708
        "operationId": "batch.objects.delete",
3709
        "x-serviceIds": [
3710
          "weaviate.local.manipulate"
3711
        ],
3712
        "parameters": [
3713
          {
3714
            "in": "body",
3715
            "name": "body",
3716
            "required": true,
3717
            "schema": {
3718
              "$ref": "#/definitions/BatchDelete"
3719
            }
3720
          },
3721
          {
3722
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3723
          },
3724
          {
3725
            "$ref": "#/parameters/CommonTenantParameterQuery"
3726
          }
3727
        ],
3728
        "responses": {
3729
          "200": {
3730
            "description": "Request succeeded, see response body to get detailed information about each batched item.",
3731
            "schema": {
3732
              "$ref": "#/definitions/BatchDeleteResponse"
3733
            }
3734
          },
3735
          "400": {
3736
            "description": "Malformed request.",
3737
            "schema": {
3738
              "$ref": "#/definitions/ErrorResponse"
3739
            }
3740
          },
3741
          "401": {
3742
            "description": "Unauthorized or invalid credentials."
3743
          },
3744
          "403": {
3745
            "description": "Forbidden",
3746
            "schema": {
3747
              "$ref": "#/definitions/ErrorResponse"
3748
            }
3749
          },
3750
          "422": {
3751
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3752
            "schema": {
3753
              "$ref": "#/definitions/ErrorResponse"
3754
            }
3755
          },
3756
          "500": {
3757
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3758
            "schema": {
3759
              "$ref": "#/definitions/ErrorResponse"
3760
            }
3761
          }
3762
        },
3763
        "summary": "Deletes Objects based on a match filter as a batch.",
3764
        "tags": [
3765
          "batch",
3766
          "objects"
3767
        ],
3768
        "x-available-in-mqtt": false,
3769
        "x-available-in-websocket": false
3770
      }
3771
    },
3772
    "/batch/references": {
3773
      "post": {
3774
        "description": "Register cross-references between any class items (objects or objects) in bulk.",
3775
        "operationId": "batch.references.create",
3776
        "x-serviceIds": [
3777
          "weaviate.local.add"
3778
        ],
3779
        "parameters": [
3780
          {
3781
            "in": "body",
3782
            "name": "body",
3783
            "description": "A list of references to be batched. The ideal size depends on the used database connector. Please see the documentation of the used connector for help",
3784
            "required": true,
3785
            "schema": {
3786
              "type": "array",
3787
              "items": {
3788
                "$ref": "#/definitions/BatchReference"
3789
              }
3790
            }
3791
          },
3792
          {
3793
            "$ref": "#/parameters/CommonConsistencyLevelParameterQuery"
3794
          }
3795
        ],
3796
        "responses": {
3797
          "200": {
3798
            "description": "Request Successful. Warning: A successful request does not guarantee that every batched reference was successfully created. Inspect the response body to see which references succeeded and which failed.",
3799
            "schema": {
3800
              "type": "array",
3801
              "items": {
3802
                "$ref": "#/definitions/BatchReferenceResponse"
3803
              }
3804
            }
3805
          },
3806
          "400": {
3807
            "description": "Malformed request.",
3808
            "schema": {
3809
              "$ref": "#/definitions/ErrorResponse"
3810
            }
3811
          },
3812
          "401": {
3813
            "description": "Unauthorized or invalid credentials."
3814
          },
3815
          "403": {
3816
            "description": "Forbidden",
3817
            "schema": {
3818
              "$ref": "#/definitions/ErrorResponse"
3819
            }
3820
          },
3821
          "422": {
3822
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3823
            "schema": {
3824
              "$ref": "#/definitions/ErrorResponse"
3825
            }
3826
          },
3827
          "500": {
3828
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3829
            "schema": {
3830
              "$ref": "#/definitions/ErrorResponse"
3831
            }
3832
          }
3833
        },
3834
        "summary": "Creates new Cross-References between arbitrary classes in bulk.",
3835
        "tags": [
3836
          "batch",
3837
          "references"
3838
        ],
3839
        "x-available-in-mqtt": false,
3840
        "x-available-in-websocket": false
3841
      }
3842
    },
3843
    "/graphql": {
3844
      "post": {
3845
        "description": "Get an object based on GraphQL",
3846
        "operationId": "graphql.post",
3847
        "x-serviceIds": [
3848
          "weaviate.local.query",
3849
          "weaviate.local.query.meta",
3850
          "weaviate.network.query",
3851
          "weaviate.network.query.meta"
3852
        ],
3853
        "parameters": [
3854
          {
3855
            "description": "The GraphQL query request parameters.",
3856
            "in": "body",
3857
            "name": "body",
3858
            "required": true,
3859
            "schema": {
3860
              "$ref": "#/definitions/GraphQLQuery"
3861
            }
3862
          }
3863
        ],
3864
        "responses": {
3865
          "200": {
3866
            "description": "Successful query (with select).",
3867
            "schema": {
3868
              "$ref": "#/definitions/GraphQLResponse"
3869
            }
3870
          },
3871
          "401": {
3872
            "description": "Unauthorized or invalid credentials."
3873
          },
3874
          "403": {
3875
            "description": "Forbidden",
3876
            "schema": {
3877
              "$ref": "#/definitions/ErrorResponse"
3878
            }
3879
          },
3880
          "422": {
3881
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3882
            "schema": {
3883
              "$ref": "#/definitions/ErrorResponse"
3884
            }
3885
          },
3886
          "500": {
3887
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3888
            "schema": {
3889
              "$ref": "#/definitions/ErrorResponse"
3890
            }
3891
          }
3892
        },
3893
        "summary": "Get a response based on GraphQL",
3894
        "tags": [
3895
          "graphql"
3896
        ],
3897
        "x-available-in-mqtt": false,
3898
        "x-available-in-websocket": false
3899
      }
3900
    },
3901
    "/graphql/batch": {
3902
      "post": {
3903
        "description": "Perform a batched GraphQL query",
3904
        "operationId": "graphql.batch",
3905
        "x-serviceIds": [
3906
          "weaviate.local.query",
3907
          "weaviate.local.query.meta",
3908
          "weaviate.network.query",
3909
          "weaviate.network.query.meta"
3910
        ],
3911
        "parameters": [
3912
          {
3913
            "description": "The GraphQL queries.",
3914
            "in": "body",
3915
            "name": "body",
3916
            "required": true,
3917
            "schema": {
3918
              "$ref": "#/definitions/GraphQLQueries"
3919
            }
3920
          }
3921
        ],
3922
        "responses": {
3923
          "200": {
3924
            "description": "Successful query (with select).",
3925
            "schema": {
3926
              "$ref": "#/definitions/GraphQLResponses"
3927
            }
3928
          },
3929
          "401": {
3930
            "description": "Unauthorized or invalid credentials."
3931
          },
3932
          "403": {
3933
            "description": "Forbidden",
3934
            "schema": {
3935
              "$ref": "#/definitions/ErrorResponse"
3936
            }
3937
          },
3938
          "422": {
3939
            "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?",
3940
            "schema": {
3941
              "$ref": "#/definitions/ErrorResponse"
3942
            }
3943
          },
3944
          "500": {
3945
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3946
            "schema": {
3947
              "$ref": "#/definitions/ErrorResponse"
3948
            }
3949
          }
3950
        },
3951
        "summary": "Get a response based on GraphQL.",
3952
        "tags": [
3953
          "graphql"
3954
        ],
3955
        "x-available-in-mqtt": false,
3956
        "x-available-in-websocket": false
3957
      }
3958
    },
3959
    "/meta": {
3960
      "get": {
3961
        "description": "Gives meta information about the server and can be used to provide information to another Weaviate instance that wants to interact with the current instance.",
3962
        "operationId": "meta.get",
3963
        "x-serviceIds": [
3964
          "weaviate.local.query.meta"
3965
        ],
3966
        "responses": {
3967
          "200": {
3968
            "description": "Successful response.",
3969
            "schema": {
3970
              "$ref": "#/definitions/Meta"
3971
            }
3972
          },
3973
          "401": {
3974
            "description": "Unauthorized or invalid credentials."
3975
          },
3976
          "403": {
3977
            "description": "Forbidden",
3978
            "schema": {
3979
              "$ref": "#/definitions/ErrorResponse"
3980
            }
3981
          },
3982
          "500": {
3983
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
3984
            "schema": {
3985
              "$ref": "#/definitions/ErrorResponse"
3986
            }
3987
          }
3988
        },
3989
        "summary": "Returns meta information of the current Weaviate instance.",
3990
        "tags": [
3991
          "meta"
3992
        ],
3993
        "x-available-in-mqtt": false,
3994
        "x-available-in-websocket": false
3995
      }
3996
    },
3997
    "/schema/cluster-status": {
3998
      "get": {
3999
        "operationId": "schema.cluster.status",
4000
        "tags": [
4001
          "schema"
4002
        ],
4003
        "responses": {
4004
          "200": {
4005
            "description": "The schema in the cluster is in sync.",
4006
            "schema": {
4007
              "$ref": "#/definitions/SchemaClusterStatus"
4008
            }
4009
          },
4010
          "500": {
4011
            "description": "The schema is either out of sync (see response body) or the sync check could not be completed.",
4012
            "schema": {
4013
              "$ref": "#/definitions/SchemaClusterStatus"
4014
            }
4015
          }
4016
        }
4017
      }
4018
    },
4019
    "/schema": {
4020
      "get": {
4021
        "summary": "Dump the current the database schema.",
4022
        "operationId": "schema.dump",
4023
        "x-serviceIds": [
4024
          "weaviate.local.query.meta"
4025
        ],
4026
        "tags": [
4027
          "schema"
4028
        ],
4029
        "parameters": [
4030
          {
4031
            "name": "consistency",
4032
            "in": "header",
4033
            "required": false,
4034
            "default": true,
4035
            "type": "boolean",
4036
            "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency"
4037
          }
4038
        ],
4039
        "responses": {
4040
          "200": {
4041
            "description": "Successfully dumped the database schema.",
4042
            "schema": {
4043
              "$ref": "#/definitions/Schema"
4044
            }
4045
          },
4046
          "401": {
4047
            "description": "Unauthorized or invalid credentials."
4048
          },
4049
          "403": {
4050
            "description": "Forbidden",
4051
            "schema": {
4052
              "$ref": "#/definitions/ErrorResponse"
4053
            }
4054
          },
4055
          "500": {
4056
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4057
            "schema": {
4058
              "$ref": "#/definitions/ErrorResponse"
4059
            }
4060
          }
4061
        }
4062
      },
4063
      "post": {
4064
        "summary": "Create a new Object class in the schema.",
4065
        "operationId": "schema.objects.create",
4066
        "x-serviceIds": [
4067
          "weaviate.local.add.meta"
4068
        ],
4069
        "tags": [
4070
          "schema"
4071
        ],
4072
        "parameters": [
4073
          {
4074
            "name": "objectClass",
4075
            "in": "body",
4076
            "required": true,
4077
            "schema": {
4078
              "$ref": "#/definitions/Class"
4079
            }
4080
          }
4081
        ],
4082
        "responses": {
4083
          "200": {
4084
            "description": "Added the new Object class to the schema.",
4085
            "schema": {
4086
              "$ref": "#/definitions/Class"
4087
            }
4088
          },
4089
          "401": {
4090
            "description": "Unauthorized or invalid credentials."
4091
          },
4092
          "403": {
4093
            "description": "Forbidden",
4094
            "schema": {
4095
              "$ref": "#/definitions/ErrorResponse"
4096
            }
4097
          },
4098
          "422": {
4099
            "description": "Invalid Object class",
4100
            "schema": {
4101
              "$ref": "#/definitions/ErrorResponse"
4102
            }
4103
          },
4104
          "500": {
4105
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4106
            "schema": {
4107
              "$ref": "#/definitions/ErrorResponse"
4108
            }
4109
          }
4110
        }
4111
      }
4112
    },
4113
    "/schema/{className}": {
4114
      "get": {
4115
        "summary": "Get a single class from the schema",
4116
        "operationId": "schema.objects.get",
4117
        "x-serviceIds": [
4118
          "weaviate.local.get.meta"
4119
        ],
4120
        "tags": [
4121
          "schema"
4122
        ],
4123
        "parameters": [
4124
          {
4125
            "name": "className",
4126
            "in": "path",
4127
            "required": true,
4128
            "type": "string"
4129
          },
4130
          {
4131
            "name": "consistency",
4132
            "in": "header",
4133
            "required": false,
4134
            "default": true,
4135
            "type": "boolean",
4136
            "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency"
4137
           }
4138
        ],
4139
        "responses": {
4140
          "200": {
4141
            "description": "Found the Class, returned as body",
4142
            "schema": {
4143
              "$ref": "#/definitions/Class"
4144
            }
4145
          },
4146
          "401": {
4147
            "description": "Unauthorized or invalid credentials."
4148
          },
4149
          "403": {
4150
            "description": "Forbidden",
4151
            "schema": {
4152
              "$ref": "#/definitions/ErrorResponse"
4153
            }
4154
          },
4155
          "404": {
4156
            "description": "This class does not exist"
4157
          },
4158
          "500": {
4159
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4160
            "schema": {
4161
              "$ref": "#/definitions/ErrorResponse"
4162
            }
4163
          }
4164
        }
4165
      },
4166
      "delete": {
4167
        "summary": "Remove an Object class (and all data in the instances) from the schema.",
4168
        "operationId": "schema.objects.delete",
4169
        "x-serviceIds": [
4170
          "weaviate.local.manipulate.meta"
4171
        ],
4172
        "tags": [
4173
          "schema"
4174
        ],
4175
        "parameters": [
4176
          {
4177
            "name": "className",
4178
            "in": "path",
4179
            "required": true,
4180
            "type": "string"
4181
          }
4182
        ],
4183
        "responses": {
4184
          "200": {
4185
            "description": "Removed the Object class from the schema."
4186
          },
4187
          "400": {
4188
            "description": "Could not delete the Object class.",
4189
            "schema": {
4190
              "$ref": "#/definitions/ErrorResponse"
4191
            }
4192
          },
4193
          "401": {
4194
            "description": "Unauthorized or invalid credentials."
4195
          },
4196
          "403": {
4197
            "description": "Forbidden",
4198
            "schema": {
4199
              "$ref": "#/definitions/ErrorResponse"
4200
            }
4201
          },
4202
          "500": {
4203
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4204
            "schema": {
4205
              "$ref": "#/definitions/ErrorResponse"
4206
            }
4207
          }
4208
        }
4209
      },
4210
      "put": {
4211
        "summary": "Update settings of an existing schema class",
4212
        "description": "Use this endpoint to alter an existing class in the schema. Note that not all settings are mutable. If an error about immutable fields is returned and you still need to update this particular setting, you will have to delete the class (and the underlying data) and recreate. This endpoint cannot be used to modify properties. Instead use POST /v1/schema/{className}/properties. A typical use case for this endpoint is to update configuration, such as the vectorIndexConfig. Note that even in mutable sections, such as vectorIndexConfig, some fields may be immutable.",
4213
        "operationId": "schema.objects.update",
4214
        "x-serviceIds": [
4215
          "weaviate.local.manipulate.meta"
4216
        ],
4217
        "tags": [
4218
          "schema"
4219
        ],
4220
        "parameters": [
4221
          {
4222
            "name": "className",
4223
            "in": "path",
4224
            "required": true,
4225
            "type": "string"
4226
          },
4227
          {
4228
            "name": "objectClass",
4229
            "in": "body",
4230
            "required": true,
4231
            "schema": {
4232
              "$ref": "#/definitions/Class"
4233
            }
4234
          }
4235
        ],
4236
        "responses": {
4237
          "200": {
4238
            "description": "Class was updated successfully",
4239
            "schema": {
4240
              "$ref": "#/definitions/Class"
4241
            }
4242
          },
4243
          "422": {
4244
            "description": "Invalid update attempt",
4245
            "schema": {
4246
              "$ref": "#/definitions/ErrorResponse"
4247
            }
4248
          },
4249
          "401": {
4250
            "description": "Unauthorized or invalid credentials."
4251
          },
4252
          "403": {
4253
            "description": "Forbidden",
4254
            "schema": {
4255
              "$ref": "#/definitions/ErrorResponse"
4256
            }
4257
          },
4258
          "404": {
4259
            "description": "Class to be updated does not exist",
4260
            "schema": {
4261
              "$ref": "#/definitions/ErrorResponse"
4262
            }
4263
          },
4264
          "500": {
4265
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4266
            "schema": {
4267
              "$ref": "#/definitions/ErrorResponse"
4268
            }
4269
          }
4270
        }
4271
      }
4272
    },
4273
    "/schema/{className}/properties": {
4274
      "post": {
4275
        "summary": "Add a property to an Object class.",
4276
        "operationId": "schema.objects.properties.add",
4277
        "x-serviceIds": [
4278
          "weaviate.local.manipulate.meta"
4279
        ],
4280
        "tags": [
4281
          "schema"
4282
        ],
4283
        "parameters": [
4284
          {
4285
            "name": "className",
4286
            "in": "path",
4287
            "required": true,
4288
            "type": "string"
4289
          },
4290
          {
4291
            "name": "body",
4292
            "in": "body",
4293
            "required": true,
4294
            "schema": {
4295
              "$ref": "#/definitions/Property"
4296
            }
4297
          }
4298
        ],
4299
        "responses": {
4300
          "200": {
4301
            "description": "Added the property.",
4302
            "schema": {
4303
              "$ref": "#/definitions/Property"
4304
            }
4305
          },
4306
          "401": {
4307
            "description": "Unauthorized or invalid credentials."
4308
          },
4309
          "403": {
4310
            "description": "Forbidden",
4311
            "schema": {
4312
              "$ref": "#/definitions/ErrorResponse"
4313
            }
4314
          },
4315
          "422": {
4316
            "description": "Invalid property.",
4317
            "schema": {
4318
              "$ref": "#/definitions/ErrorResponse"
4319
            }
4320
          },
4321
          "500": {
4322
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4323
            "schema": {
4324
              "$ref": "#/definitions/ErrorResponse"
4325
            }
4326
          }
4327
        }
4328
      }
4329
    },
4330
    "/schema/{className}/shards": {
4331
      "get": {
4332
        "summary": "Get the shards status of an Object class",
4333
        "operationId": "schema.objects.shards.get",
4334
        "x-serviceIds": [
4335
          "weaviate.local.get.meta"
4336
        ],
4337
        "tags": [
4338
          "schema"
4339
        ],
4340
        "parameters": [
4341
          {
4342
            "name": "className",
4343
            "in": "path",
4344
            "required": true,
4345
            "type": "string"
4346
          },
4347
          {
4348
            "name": "tenant",
4349
            "in": "query",
4350
            "type": "string"
4351
          }
4352
        ],
4353
        "responses": {
4354
          "200": {
4355
            "description": "Found the status of the shards, returned as body",
4356
            "schema": {
4357
              "$ref": "#/definitions/ShardStatusList"
4358
            }
4359
          },
4360
          "401": {
4361
            "description": "Unauthorized or invalid credentials."
4362
          },
4363
          "403": {
4364
            "description": "Forbidden",
4365
            "schema": {
4366
              "$ref": "#/definitions/ErrorResponse"
4367
            }
4368
          },
4369
          "404": {
4370
            "description": "This class does not exist",
4371
            "schema": {
4372
              "$ref": "#/definitions/ErrorResponse"
4373
            }
4374
          },
4375
          "500": {
4376
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4377
            "schema": {
4378
              "$ref": "#/definitions/ErrorResponse"
4379
            }
4380
          }
4381
        }
4382
      }
4383
    },
4384
    "/schema/{className}/shards/{shardName}": {
4385
      "put": {
4386
        "description": "Update shard status of an Object Class",
4387
        "operationId": "schema.objects.shards.update",
4388
        "x-serviceIds": [
4389
          "weaviate.local.manipulate.meta"
4390
        ],
4391
        "tags": [
4392
          "schema"
4393
        ],
4394
        "parameters": [
4395
          {
4396
            "name": "className",
4397
            "in": "path",
4398
            "required": true,
4399
            "type": "string"
4400
          },
4401
          {
4402
            "name": "shardName",
4403
            "in": "path",
4404
            "required": true,
4405
            "type": "string"
4406
          },
4407
          {
4408
            "in": "body",
4409
            "name": "body",
4410
            "required": true,
4411
            "schema": {
4412
              "$ref": "#/definitions/ShardStatus"
4413
            }
4414
          }
4415
        ],
4416
        "responses": {
4417
          "200": {
4418
            "description": "Shard status was updated successfully",
4419
            "schema": {
4420
              "$ref": "#/definitions/ShardStatus"
4421
            }
4422
          },
4423
          "422": {
4424
            "description": "Invalid update attempt",
4425
            "schema": {
4426
              "$ref": "#/definitions/ErrorResponse"
4427
            }
4428
          },
4429
          "401": {
4430
            "description": "Unauthorized or invalid credentials."
4431
          },
4432
          "403": {
4433
            "description": "Forbidden",
4434
            "schema": {
4435
              "$ref": "#/definitions/ErrorResponse"
4436
            }
4437
          },
4438
          "404": {
4439
            "description": "Shard to be updated does not exist",
4440
            "schema": {
4441
              "$ref": "#/definitions/ErrorResponse"
4442
            }
4443
          },
4444
          "500": {
4445
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4446
            "schema": {
4447
              "$ref": "#/definitions/ErrorResponse"
4448
            }
4449
          }
4450
        }
4451
      }
4452
    },
4453
    "/schema/{className}/tenants": {
4454
      "post": {
4455
        "description": "Create a new tenant for a specific class",
4456
        "operationId": "tenants.create",
4457
        "tags": [
4458
          "schema"
4459
        ],
4460
        "parameters": [
4461
          {
4462
            "name": "className",
4463
            "in": "path",
4464
            "required": true,
4465
            "type": "string"
4466
          },
4467
          {
4468
            "in": "body",
4469
            "name": "body",
4470
            "required": true,
4471
            "schema": {
4472
              "type": "array",
4473
              "items": {
4474
                "$ref": "#/definitions/Tenant"
4475
              }
4476
            }
4477
          }
4478
        ],
4479
        "responses": {
4480
          "200": {
4481
            "description": "Added new tenants to the specified class",
4482
            "schema": {
4483
              "type": "array",
4484
              "items": {
4485
                "$ref": "#/definitions/Tenant"
4486
              }
4487
            }
4488
          },
4489
          "401": {
4490
            "description": "Unauthorized or invalid credentials."
4491
          },
4492
          "403": {
4493
            "description": "Forbidden",
4494
            "schema": {
4495
              "$ref": "#/definitions/ErrorResponse"
4496
            }
4497
          },
4498
          "422": {
4499
            "description": "Invalid Tenant class",
4500
            "schema": {
4501
              "$ref": "#/definitions/ErrorResponse"
4502
            }
4503
          },
4504
          "500": {
4505
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4506
            "schema": {
4507
              "$ref": "#/definitions/ErrorResponse"
4508
            }
4509
          }
4510
        }
4511
      },
4512
      "put": {
4513
        "description": "Update tenant of a specific class",
4514
        "operationId": "tenants.update",
4515
        "tags": [
4516
          "schema"
4517
        ],
4518
        "parameters": [
4519
          {
4520
            "name": "className",
4521
            "in": "path",
4522
            "required": true,
4523
            "type": "string"
4524
          },
4525
          {
4526
            "in": "body",
4527
            "name": "body",
4528
            "required": true,
4529
            "schema": {
4530
              "type": "array",
4531
              "items": {
4532
                "$ref": "#/definitions/Tenant"
4533
              }
4534
            }
4535
          }
4536
        ],
4537
        "responses": {
4538
          "200": {
4539
            "description": "Updated tenants of the specified class",
4540
            "schema": {
4541
              "type": "array",
4542
              "items": {
4543
                "$ref": "#/definitions/Tenant"
4544
              }
4545
            }
4546
          },
4547
          "401": {
4548
            "description": "Unauthorized or invalid credentials."
4549
          },
4550
          "403": {
4551
            "description": "Forbidden",
4552
            "schema": {
4553
              "$ref": "#/definitions/ErrorResponse"
4554
            }
4555
          },
4556
          "422": {
4557
            "description": "Invalid Tenant class",
4558
            "schema": {
4559
              "$ref": "#/definitions/ErrorResponse"
4560
            }
4561
          },
4562
          "500": {
4563
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4564
            "schema": {
4565
              "$ref": "#/definitions/ErrorResponse"
4566
            }
4567
          }
4568
        }
4569
      },
4570
      "delete": {
4571
        "description": "delete tenants from a specific class",
4572
        "operationId": "tenants.delete",
4573
        "tags": [
4574
          "schema"
4575
        ],
4576
        "parameters": [
4577
          {
4578
            "name": "className",
4579
            "in": "path",
4580
            "required": true,
4581
            "type": "string"
4582
          },
4583
          {
4584
            "in": "body",
4585
            "name": "tenants",
4586
            "required": true,
4587
            "schema": {
4588
              "type": "array",
4589
              "items": {
4590
                "type": "string"
4591
              }
4592
            }
4593
          }
4594
        ],
4595
        "responses": {
4596
          "200": {
4597
            "description": "Deleted tenants from specified class."
4598
          },
4599
          "401": {
4600
            "description": "Unauthorized or invalid credentials."
4601
          },
4602
          "403": {
4603
            "description": "Forbidden",
4604
            "schema": {
4605
              "$ref": "#/definitions/ErrorResponse"
4606
            }
4607
          },
4608
          "422": {
4609
            "description": "Invalid Tenant class",
4610
            "schema": {
4611
              "$ref": "#/definitions/ErrorResponse"
4612
            }
4613
          },
4614
          "500": {
4615
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4616
            "schema": {
4617
              "$ref": "#/definitions/ErrorResponse"
4618
            }
4619
          }
4620
        }
4621
      },
4622
      "get": {
4623
        "description": "get all tenants from a specific class",
4624
        "operationId": "tenants.get",
4625
        "tags": [
4626
          "schema"
4627
        ],
4628
        "parameters": [
4629
          {
4630
            "name": "className",
4631
            "in": "path",
4632
            "required": true,
4633
            "type": "string"
4634
          },
4635
          {
4636
            "name": "consistency",
4637
            "in": "header",
4638
            "required": false,
4639
            "default": true,
4640
            "type": "boolean",
4641
            "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency"
4642
          }
4643
        ],
4644
        "responses": {
4645
          "200": {
4646
            "description": "tenants from specified class.",
4647
            "schema": {
4648
              "type": "array",
4649
              "items": {
4650
                "$ref": "#/definitions/Tenant"
4651
              }
4652
            }
4653
          },
4654
          "401": {
4655
            "description": "Unauthorized or invalid credentials."
4656
          },
4657
          "403": {
4658
            "description": "Forbidden",
4659
            "schema": {
4660
              "$ref": "#/definitions/ErrorResponse"
4661
            }
4662
          },
4663
          "422": {
4664
            "description": "Invalid Tenant class",
4665
            "schema": {
4666
              "$ref": "#/definitions/ErrorResponse"
4667
            }
4668
          },
4669
          "500": {
4670
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4671
            "schema": {
4672
              "$ref": "#/definitions/ErrorResponse"
4673
            }
4674
          }
4675
        }
4676
      }
4677
    },
4678
    "/schema/{className}/tenants/{tenantName}": {
4679
      "head": {
4680
        "description": "Check if a tenant exists for a specific class",
4681
        "operationId": "tenant.exists",
4682
        "tags": [
4683
          "schema"
4684
        ],
4685
        "parameters": [
4686
          {
4687
            "name": "className",
4688
            "in": "path",
4689
            "required": true,
4690
            "type": "string"
4691
          },
4692
          {
4693
            "name": "tenantName",
4694
            "in": "path",
4695
            "required": true,
4696
            "type": "string"
4697
          },
4698
          {
4699
            "name": "consistency",
4700
            "in": "header",
4701
            "required": false,
4702
            "default": true,
4703
            "type": "boolean",
4704
            "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency"
4705
          }
4706
        ],
4707
        "responses": {
4708
          "200": {
4709
            "description": "The tenant exists in the specified class"
4710
          },
4711
          "401": {
4712
            "description": "Unauthorized or invalid credentials."
4713
          },
4714
          "403": {
4715
            "description": "Forbidden",
4716
            "schema": {
4717
              "$ref": "#/definitions/ErrorResponse"
4718
            }
4719
          },
4720
          "404": {
4721
            "description": "The tenant not found"
4722
          },
4723
          "422": {
4724
            "description": "Invalid Tenant class",
4725
            "schema": {
4726
              "$ref": "#/definitions/ErrorResponse"
4727
            }
4728
          },
4729
          "500": {
4730
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4731
            "schema": {
4732
              "$ref": "#/definitions/ErrorResponse"
4733
            }
4734
          }
4735
        }
4736
      }
4737
    },    
4738
    "/backups/{backend}": {
4739
      "post": {
4740
        "description": "Starts a process of creating a backup for a set of classes",
4741
        "operationId": "backups.create",
4742
        "x-serviceIds": [
4743
          "weaviate.local.backup"
4744
        ],
4745
        "tags": [
4746
          "backups"
4747
        ],
4748
        "parameters": [
4749
          {
4750
            "name": "backend",
4751
            "in": "path",
4752
            "required": true,
4753
            "type": "string",
4754
            "description": "Backup backend name e.g. filesystem, gcs, s3."
4755
          },
4756
          {
4757
            "in": "body",
4758
            "name": "body",
4759
            "required": true,
4760
            "schema": {
4761
              "$ref": "#/definitions/BackupCreateRequest"
4762
            }
4763
          }
4764
        ],
4765
        "responses": {
4766
          "200": {
4767
            "description": "Backup create process successfully started.",
4768
            "schema": {
4769
              "$ref": "#/definitions/BackupCreateResponse"
4770
            }
4771
          },
4772
          "401": {
4773
            "description": "Unauthorized or invalid credentials."
4774
          },
4775
          "403": {
4776
            "description": "Forbidden",
4777
            "schema": {
4778
              "$ref": "#/definitions/ErrorResponse"
4779
            }
4780
          },
4781
          "422": {
4782
            "description": "Invalid backup creation attempt.",
4783
            "schema": {
4784
              "$ref": "#/definitions/ErrorResponse"
4785
            }
4786
          },
4787
          "500": {
4788
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4789
            "schema": {
4790
              "$ref": "#/definitions/ErrorResponse"
4791
            }
4792
          }
4793
        }
4794
      }
4795
    },
4796
    "/backups/{backend}/{id}": {
4797
      "get": {
4798
        "description": "Returns status of backup creation attempt for a set of classes",
4799
        "operationId": "backups.create.status",
4800
        "x-serviceIds": [
4801
          "weaviate.local.backup"
4802
        ],
4803
        "tags": [
4804
          "backups"
4805
        ],
4806
        "parameters": [
4807
          {
4808
            "name": "backend",
4809
            "in": "path",
4810
            "required": true,
4811
            "type": "string",
4812
            "description": "Backup backend name e.g. filesystem, gcs, s3."
4813
          },
4814
          {
4815
            "name": "id",
4816
            "in": "path",
4817
            "required": true,
4818
            "type": "string",
4819
            "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed."
4820
          }
4821
        ],
4822
        "responses": {
4823
          "200": {
4824
            "description": "Backup creation status successfully returned",
4825
            "schema": {
4826
              "$ref": "#/definitions/BackupCreateStatusResponse"
4827
            }
4828
          },
4829
          "401": {
4830
            "description": "Unauthorized or invalid credentials."
4831
          },
4832
          "403": {
4833
            "description": "Forbidden",
4834
            "schema": {
4835
              "$ref": "#/definitions/ErrorResponse"
4836
            }
4837
          },
4838
          "404": {
4839
            "description": "Not Found - Backup does not exist",
4840
            "schema": {
4841
              "$ref": "#/definitions/ErrorResponse"
4842
            }
4843
          },
4844
          "422": {
4845
            "description": "Invalid backup restoration status attempt.",
4846
            "schema": {
4847
              "$ref": "#/definitions/ErrorResponse"
4848
            }
4849
          },
4850
          "500": {
4851
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4852
            "schema": {
4853
              "$ref": "#/definitions/ErrorResponse"
4854
            }
4855
          }
4856
        }
4857
      }
4858
    },
4859
    "/backups/{backend}/{id}/restore": {
4860
      "post": {
4861
        "description": "Starts a process of restoring a backup for a set of classes",
4862
        "operationId": "backups.restore",
4863
        "x-serviceIds": [
4864
          "weaviate.local.backup"
4865
        ],
4866
        "tags": [
4867
          "backups"
4868
        ],
4869
        "parameters": [
4870
          {
4871
            "name": "backend",
4872
            "in": "path",
4873
            "required": true,
4874
            "type": "string",
4875
            "description": "Backup backend name e.g. filesystem, gcs, s3."
4876
          },
4877
          {
4878
            "name": "id",
4879
            "in": "path",
4880
            "required": true,
4881
            "type": "string",
4882
            "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed."
4883
          },
4884
          {
4885
            "in": "body",
4886
            "name": "body",
4887
            "required": true,
4888
            "schema": {
4889
              "$ref": "#/definitions/BackupRestoreRequest"
4890
            }
4891
          }
4892
        ],
4893
        "responses": {
4894
          "200": {
4895
            "description": "Backup restoration process successfully started.",
4896
            "schema": {
4897
              "$ref": "#/definitions/BackupRestoreResponse"
4898
            }
4899
          },
4900
          "401": {
4901
            "description": "Unauthorized or invalid credentials."
4902
          },
4903
          "403": {
4904
            "description": "Forbidden",
4905
            "schema": {
4906
              "$ref": "#/definitions/ErrorResponse"
4907
            }
4908
          },
4909
          "404": {
4910
            "description": "Not Found - Backup does not exist",
4911
            "schema": {
4912
              "$ref": "#/definitions/ErrorResponse"
4913
            }
4914
          },
4915
          "422": {
4916
            "description": "Invalid backup restoration attempt.",
4917
            "schema": {
4918
              "$ref": "#/definitions/ErrorResponse"
4919
            }
4920
          },
4921
          "500": {
4922
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4923
            "schema": {
4924
              "$ref": "#/definitions/ErrorResponse"
4925
            }
4926
          }
4927
        }
4928
      },
4929
      "get": {
4930
        "description": "Returns status of a backup restoration attempt for a set of classes",
4931
        "operationId": "backups.restore.status",
4932
        "x-serviceIds": [
4933
          "weaviate.local.backup"
4934
        ],
4935
        "tags": [
4936
          "backups"
4937
        ],
4938
        "parameters": [
4939
          {
4940
            "name": "backend",
4941
            "in": "path",
4942
            "required": true,
4943
            "type": "string",
4944
            "description": "Backup backend name e.g. filesystem, gcs, s3."
4945
          },
4946
          {
4947
            "name": "id",
4948
            "in": "path",
4949
            "required": true,
4950
            "type": "string",
4951
            "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed."
4952
          }
4953
        ],
4954
        "responses": {
4955
          "200": {
4956
            "description": "Backup restoration status successfully returned",
4957
            "schema": {
4958
              "$ref": "#/definitions/BackupRestoreStatusResponse"
4959
            }
4960
          },
4961
          "401": {
4962
            "description": "Unauthorized or invalid credentials."
4963
          },
4964
          "403": {
4965
            "description": "Forbidden",
4966
            "schema": {
4967
              "$ref": "#/definitions/ErrorResponse"
4968
            }
4969
          },
4970
          "404": {
4971
            "description": "Not Found - Backup does not exist",
4972
            "schema": {
4973
              "$ref": "#/definitions/ErrorResponse"
4974
            }
4975
          },
4976
          "500": {
4977
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
4978
            "schema": {
4979
              "$ref": "#/definitions/ErrorResponse"
4980
            }
4981
          }
4982
        }
4983
      }
4984
    },
4985
    "/cluster/statistics": {
4986
      "get": {
4987
        "description": "Returns Raft cluster statistics of Weaviate DB.",
4988
        "operationId": "cluster.get.statistics",
4989
        "x-serviceIds": [
4990
          "weaviate.cluster.statistics.get"
4991
        ],
4992
        "tags": [
4993
          "cluster"
4994
        ],
4995
        "responses": {
4996
          "200": {
4997
            "description": "Cluster statistics successfully returned",
4998
            "schema": {
4999
              "$ref": "#/definitions/ClusterStatisticsResponse"
5000
            }
5001
          },
5002
          "401": {
5003
            "description": "Unauthorized or invalid credentials."
5004
          },
5005
          "403": {
5006
            "description": "Forbidden",
5007
            "schema": {
5008
              "$ref": "#/definitions/ErrorResponse"
5009
            }
5010
          },
5011
          "422": {
5012
            "description": "Invalid backup restoration status attempt.",
5013
            "schema": {
5014
              "$ref": "#/definitions/ErrorResponse"
5015
            }
5016
          },
5017
          "500": {
5018
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
5019
            "schema": {
5020
              "$ref": "#/definitions/ErrorResponse"
5021
            }
5022
          }
5023
        }
5024
      }
5025
    },
5026
    "/nodes": {
5027
      "get": {
5028
        "description": "Returns status of Weaviate DB.",
5029
        "operationId": "nodes.get",
5030
        "x-serviceIds": [
5031
          "weaviate.nodes.status.get"
5032
        ],
5033
        "tags": [
5034
          "nodes"
5035
        ],
5036
        "parameters": [
5037
          {
5038
            "$ref": "#/parameters/CommonOutputVerbosityParameterQuery"
5039
          }
5040
        ],
5041
        "responses": {
5042
          "200": {
5043
            "description": "Nodes status successfully returned",
5044
            "schema": {
5045
              "$ref": "#/definitions/NodesStatusResponse"
5046
            }
5047
          },
5048
          "401": {
5049
            "description": "Unauthorized or invalid credentials."
5050
          },
5051
          "403": {
5052
            "description": "Forbidden",
5053
            "schema": {
5054
              "$ref": "#/definitions/ErrorResponse"
5055
            }
5056
          },
5057
          "404": {
5058
            "description": "Not Found - Backup does not exist",
5059
            "schema": {
5060
              "$ref": "#/definitions/ErrorResponse"
5061
            }
5062
          },
5063
          "422": {
5064
            "description": "Invalid backup restoration status attempt.",
5065
            "schema": {
5066
              "$ref": "#/definitions/ErrorResponse"
5067
            }
5068
          },
5069
          "500": {
5070
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
5071
            "schema": {
5072
              "$ref": "#/definitions/ErrorResponse"
5073
            }
5074
          }
5075
        }
5076
      }
5077
    },
5078
    "/nodes/{className}": {
5079
      "get": {
5080
        "description": "Returns status of Weaviate DB.",
5081
        "operationId": "nodes.get.class",
5082
        "x-serviceIds": [
5083
          "weaviate.nodes.status.get.class"
5084
        ],
5085
        "tags": [
5086
          "nodes"
5087
        ],
5088
        "parameters": [
5089
          {
5090
            "name": "className",
5091
            "in": "path",
5092
            "required": true,
5093
            "type": "string"
5094
          },
5095
          {
5096
            "$ref": "#/parameters/CommonOutputVerbosityParameterQuery"
5097
          }
5098
        ],
5099
        "responses": {
5100
          "200": {
5101
            "description": "Nodes status successfully returned",
5102
            "schema": {
5103
              "$ref": "#/definitions/NodesStatusResponse"
5104
            }
5105
          },
5106
          "401": {
5107
            "description": "Unauthorized or invalid credentials."
5108
          },
5109
          "403": {
5110
            "description": "Forbidden",
5111
            "schema": {
5112
              "$ref": "#/definitions/ErrorResponse"
5113
            }
5114
          },
5115
          "404": {
5116
            "description": "Not Found - Backup does not exist",
5117
            "schema": {
5118
              "$ref": "#/definitions/ErrorResponse"
5119
            }
5120
          },
5121
          "422": {
5122
            "description": "Invalid backup restoration status attempt.",
5123
            "schema": {
5124
              "$ref": "#/definitions/ErrorResponse"
5125
            }
5126
          },
5127
          "500": {
5128
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
5129
            "schema": {
5130
              "$ref": "#/definitions/ErrorResponse"
5131
            }
5132
          }
5133
        }
5134
      }
5135
    },
5136
    "/classifications/": {
5137
      "post": {
5138
        "description": "Trigger a classification based on the specified params. Classifications will run in the background, use GET /classifications/<id> to retrieve the status of your classification.",
5139
        "operationId": "classifications.post",
5140
        "x-serviceIds": [
5141
          "weaviate.classifications.post"
5142
        ],
5143
        "parameters": [
5144
          {
5145
            "description": "parameters to start a classification",
5146
            "in": "body",
5147
            "schema": {
5148
              "$ref": "#/definitions/Classification"
5149
            },
5150
            "name": "params",
5151
            "required": true
5152
          }
5153
        ],
5154
        "responses": {
5155
          "201": {
5156
            "description": "Successfully started classification.",
5157
            "schema": {
5158
              "$ref": "#/definitions/Classification"
5159
            }
5160
          },
5161
          "400": {
5162
            "description": "Incorrect request",
5163
            "schema": {
5164
              "$ref": "#/definitions/ErrorResponse"
5165
            }
5166
          },
5167
          "401": {
5168
            "description": "Unauthorized or invalid credentials."
5169
          },
5170
          "403": {
5171
            "description": "Forbidden",
5172
            "schema": {
5173
              "$ref": "#/definitions/ErrorResponse"
5174
            }
5175
          },
5176
          "500": {
5177
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
5178
            "schema": {
5179
              "$ref": "#/definitions/ErrorResponse"
5180
            }
5181
          }
5182
        },
5183
        "summary": "Starts a classification.",
5184
        "tags": [
5185
          "classifications"
5186
        ]
5187
      }
5188
    },
5189
    "/classifications/{id}": {
5190
      "get": {
5191
        "description": "Get status, results and metadata of a previously created classification",
5192
        "operationId": "classifications.get",
5193
        "x-serviceIds": [
5194
          "weaviate.classifications.get"
5195
        ],
5196
        "parameters": [
5197
          {
5198
            "description": "classification id",
5199
            "in": "path",
5200
            "type": "string",
5201
            "name": "id",
5202
            "required": true
5203
          }
5204
        ],
5205
        "responses": {
5206
          "200": {
5207
            "description": "Found the classification, returned as body",
5208
            "schema": {
5209
              "$ref": "#/definitions/Classification"
5210
            }
5211
          },
5212
          "404": {
5213
            "description": "Not Found - Classification does not exist"
5214
          },
5215
          "401": {
5216
            "description": "Unauthorized or invalid credentials."
5217
          },
5218
          "403": {
5219
            "description": "Forbidden",
5220
            "schema": {
5221
              "$ref": "#/definitions/ErrorResponse"
5222
            }
5223
          },
5224
          "500": {
5225
            "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.",
5226
            "schema": {
5227
              "$ref": "#/definitions/ErrorResponse"
5228
            }
5229
          }
5230
        },
5231
        "summary": "View previously created classification",
5232
        "tags": [
5233
          "classifications"
5234
        ]
5235
      }
5236
    }
5237
  },
5238
  "produces": [
5239
    "application/json"
5240
  ],
5241
  "schemes": [
5242
    "https"
5243
  ],
5244
  "security": [
5245
    {},
5246
    {
5247
      "oidc": []
5248
    }
5249
  ],
5250
  "securityDefinitions": {
5251
    "oidc": {
5252
      "type": "oauth2",
5253
      "description": "OIDC (OpenConnect ID - based on OAuth2)",
5254
      "flow": "implicit",
5255
      "authorizationUrl": "http://to-be-configured-in-the-application-config"
5256
    }
5257
  },
5258
  "swagger": "2.0",
5259
  "tags": [
5260
    {
5261
      "name": "objects"
5262
    },
5263
    {
5264
      "name": "batch",
5265
      "description": "These operations allow to execute batch requests for Objects and Objects. Mostly used for importing large datasets."
5266
    },
5267
    {
5268
      "name": "graphql"
5269
    },
5270
    {
5271
      "name": "meta"
5272
    },
5273
    {
5274
      "name": "P2P"
5275
    },
5276
    {
5277
      "name": "contextionary-API",
5278
      "description": "All functions related to the Contextionary."
5279
    },
5280
    {
5281
      "name": "schema",
5282
      "description": "These operations enable manipulation of the schema in Weaviate schema."
5283
    }
5284
  ]
5285
}
5286