| { |
| "basePath": "/v1", |
| "consumes": [ |
| "application/yaml", |
| "application/json" |
| ], |
| "definitions": { |
| "UserTypeInput": { |
| "type": "string", |
| "enum": [ |
| "db", |
| "oidc" |
| ], |
| "description": "the type of user" |
| }, |
| "GroupType": { |
| "type": "string", |
| "enum": [ |
| "db", |
| "oidc" |
| ], |
| "description": "If the group contains OIDC or database users." |
| }, |
| "UserTypeOutput": { |
| "type": "string", |
| "enum": [ |
| "db_user", |
| "db_env_user", |
| "oidc" |
| ], |
| "description": "the type of user" |
| }, |
| "UserOwnInfo": { |
| "type": "object", |
| "properties": { |
| "groups": { |
| "type": "array", |
| "description": "The groups associated to the user", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "roles": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "description": "The roles assigned to own user", |
| "$ref": "#/definitions/Role" |
| } |
| }, |
| "username": { |
| "type": "string", |
| "description": "The username associated with the provided key" |
| } |
| }, |
| "required": [ |
| "username" |
| ] |
| }, |
| "DBUserInfo": { |
| "type": "object", |
| "properties": { |
| "roles": { |
| "type": "array", |
| "description": "The role names associated to the user", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "userId": { |
| "type": "string", |
| "description": "The user id of the given user" |
| }, |
| "dbUserType": { |
| "type": "string", |
| "enum": [ |
| "db_user", |
| "db_env_user" |
| ], |
| "description": "type of the returned user" |
| }, |
| "active": { |
| "type": "boolean", |
| "description": "activity status of the returned user" |
| }, |
| "createdAt": { |
| "type": [ |
| "string", |
| "null" |
| ], |
| "format": "date-time", |
| "description": "Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)" |
| }, |
| "apiKeyFirstLetters": { |
| "type": [ |
| "string", |
| "null" |
| ], |
| "maxLength": 3, |
| "description": "First 3 letters of the associated API-key" |
| }, |
| "lastUsedAt": { |
| "type": [ |
| "string", |
| "null" |
| ], |
| "format": "date-time", |
| "description": "Date and time in ISO 8601 format (YYYY-MM-DDTHH:MM:SSZ)" |
| } |
| }, |
| "required": [ |
| "userId", |
| "dbUserType", |
| "roles", |
| "active" |
| ] |
| }, |
| "UserApiKey": { |
| "type": "object", |
| "properties": { |
| "apikey": { |
| "type": "string", |
| "description": "The apikey" |
| } |
| }, |
| "required": [ |
| "apikey" |
| ] |
| }, |
| "Role": { |
| "type": "object", |
| "properties": { |
| "name": { |
| "type": "string", |
| "description": "role name" |
| }, |
| "permissions": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "description": "list of permissions (level, action, resource)", |
| "$ref": "#/definitions/Permission" |
| } |
| } |
| }, |
| "required": [ |
| "name", |
| "permissions" |
| ] |
| }, |
| "Permission": { |
| "type": "object", |
| "description": "permissions attached to a role.", |
| "properties": { |
| "backups": { |
| "type": "object", |
| "description": "resources applicable for backup actions", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "data": { |
| "type": "object", |
| "description": "resources applicable for data actions", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| }, |
| "tenant": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific tenant name, if left empty it will be ALL or *" |
| }, |
| "object": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific object ID, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "nodes": { |
| "type": "object", |
| "description": "resources applicable for cluster actions", |
| "properties": { |
| "verbosity": { |
| "type": "string", |
| "default": "minimal", |
| "enum": [ |
| "verbose", |
| "minimal" |
| ], |
| "description": "whether to allow (verbose) returning shards and stats data in the response" |
| }, |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "users": { |
| "type": "object", |
| "description": "resources applicable for user actions", |
| "properties": { |
| "users": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "groups": { |
| "type": "object", |
| "description": "Resources applicable for group actions.", |
| "properties": { |
| "group": { |
| "type": "string", |
| "default": "*", |
| "description": "A string that specifies which groups this permission applies to. Can be an exact group name or a regex pattern. The default value `*` applies the permission to all groups." |
| }, |
| "groupType": { |
| "$ref": "#/definitions/GroupType" |
| } |
| } |
| }, |
| "tenants": { |
| "type": "object", |
| "description": "resources applicable for tenant actions", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| }, |
| "tenant": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific tenant name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "roles": { |
| "type": "object", |
| "description": "resources applicable for role actions", |
| "properties": { |
| "role": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific role name, if left empty it will be ALL or *" |
| }, |
| "scope": { |
| "enum": [ |
| "all", |
| "match" |
| ], |
| "type": "string", |
| "default": "match", |
| "description": "set the scope for the manage role permission" |
| } |
| } |
| }, |
| "collections": { |
| "type": "object", |
| "description": "resources applicable for collection and/or tenant actions", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "replicate": { |
| "type": "object", |
| "description": "resources applicable for replicate actions", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific collection name, if left empty it will be ALL or *" |
| }, |
| "shard": { |
| "type": "string", |
| "default": "*", |
| "description": "string or regex. if a specific shard name, if left empty it will be ALL or *" |
| } |
| } |
| }, |
| "aliases": { |
| "type": "object", |
| "description": "Resource definition for alias-related actions and permissions. Used to specify which aliases and collections can be accessed or modified.", |
| "properties": { |
| "collection": { |
| "type": "string", |
| "default": "*", |
| "description": "A string that specifies which collections this permission applies to. Can be an exact collection name or a regex pattern. The default value `*` applies the permission to all collections." |
| }, |
| "alias": { |
| "type": "string", |
| "default": "*", |
| "description": "A string that specifies which aliases this permission applies to. Can be an exact alias name or a regex pattern. The default value `*` applies the permission to all aliases." |
| } |
| } |
| }, |
| "action": { |
| "type": "string", |
| "description": "allowed actions in weaviate.", |
| "enum": [ |
| "manage_backups", |
| "read_cluster", |
| "create_data", |
| "read_data", |
| "update_data", |
| "delete_data", |
| "read_nodes", |
| "create_roles", |
| "read_roles", |
| "update_roles", |
| "delete_roles", |
| "create_collections", |
| "read_collections", |
| "update_collections", |
| "delete_collections", |
| "assign_and_revoke_users", |
| "create_users", |
| "read_users", |
| "update_users", |
| "delete_users", |
| "create_tenants", |
| "read_tenants", |
| "update_tenants", |
| "delete_tenants", |
| "create_replicate", |
| "read_replicate", |
| "update_replicate", |
| "delete_replicate", |
| "create_aliases", |
| "read_aliases", |
| "update_aliases", |
| "delete_aliases", |
| "assign_and_revoke_groups", |
| "read_groups" |
| ] |
| } |
| }, |
| "required": [ |
| "action" |
| ] |
| }, |
| "RolesListResponse": { |
| "type": "array", |
| "description": "list of roles", |
| "items": { |
| "$ref": "#/definitions/Role" |
| } |
| }, |
| "Link": { |
| "type": "object", |
| "properties": { |
| "href": { |
| "type": "string", |
| "description": "target of the link" |
| }, |
| "rel": { |
| "type": "string", |
| "description": "relationship if both resources are related, e.g. 'next', 'previous', 'parent', etc." |
| }, |
| "name": { |
| "type": "string", |
| "description": "human readable name of the resource group" |
| }, |
| "documentationHref": { |
| "type": "string", |
| "description": "weaviate documentation about this resource group" |
| } |
| } |
| }, |
| "Principal": { |
| "type": "object", |
| "properties": { |
| "username": { |
| "type": "string", |
| "description": "The username that was extracted either from the authentication information" |
| }, |
| "groups": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "userType": { |
| "$ref": "#/definitions/UserTypeInput" |
| } |
| } |
| }, |
| "C11yWordsResponse": { |
| "description": "An array of available words and contexts.", |
| "properties": { |
| "concatenatedWord": { |
| "description": "Weighted results for all words", |
| "type": "object", |
| "properties": { |
| "concatenatedWord": { |
| "type": "string" |
| }, |
| "singleWords": { |
| "type": "array", |
| "items": { |
| "format": "string" |
| } |
| }, |
| "concatenatedVector": { |
| "$ref": "#/definitions/C11yVector" |
| }, |
| "concatenatedNearestNeighbors": { |
| "$ref": "#/definitions/C11yNearestNeighbors" |
| } |
| } |
| }, |
| "individualWords": { |
| "description": "Weighted results for per individual word", |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "word": { |
| "type": "string" |
| }, |
| "present": { |
| "type": "boolean" |
| }, |
| "info": { |
| "type": "object", |
| "properties": { |
| "vector": { |
| "$ref": "#/definitions/C11yVector" |
| }, |
| "nearestNeighbors": { |
| "$ref": "#/definitions/C11yNearestNeighbors" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "C11yExtension": { |
| "description": "A resource describing an extension to the contextinoary, containing both the identifier and the definition of the extension", |
| "properties": { |
| "concept": { |
| "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'", |
| "type": "string", |
| "example": "foobarium" |
| }, |
| "definition": { |
| "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'", |
| "type": "string" |
| }, |
| "weight": { |
| "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.", |
| "type": "number", |
| "format": "float" |
| } |
| } |
| }, |
| "C11yNearestNeighbors": { |
| "description": "C11y function to show the nearest neighbors to a word.", |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "word": { |
| "type": "string" |
| }, |
| "distance": { |
| "type": "number", |
| "format": "float" |
| } |
| } |
| } |
| }, |
| "C11yVector": { |
| "description": "A vector representation of the object in the Contextionary. If provided at object creation, this wil take precedence over any vectorizer setting.", |
| "type": "array", |
| "items": { |
| "type": "number", |
| "format": "float" |
| } |
| }, |
| "Vector": { |
| "description": "A vector representation of the object. If provided at object creation, this wil take precedence over any vectorizer setting.", |
| "type": "object" |
| }, |
| "Vectors": { |
| "description": "A map of named vectors for multi-vector representations.", |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/definitions/Vector" |
| } |
| }, |
| "C11yVectorBasedQuestion": { |
| "description": "Receive question based on array of classes, properties and values.", |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "classVectors": { |
| "description": "Vectorized classname.", |
| "type": "array", |
| "items": { |
| "type": "number", |
| "format": "float" |
| }, |
| "minItems": 300, |
| "maxItems": 300 |
| }, |
| "classProps": { |
| "description": "Vectorized properties.", |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "propsVectors": { |
| "type": "array", |
| "items": { |
| "type": "number", |
| "format": "float" |
| } |
| }, |
| "value": { |
| "description": "String with valuename.", |
| "type": "string" |
| } |
| } |
| }, |
| "minItems": 300, |
| "maxItems": 300 |
| } |
| } |
| } |
| }, |
| "Deprecation": { |
| "type": "object", |
| "properties": { |
| "id": { |
| "type": "string", |
| "description": "The id that uniquely identifies this particular deprecations (mostly used internally)" |
| }, |
| "status": { |
| "type": "string", |
| "description": "Whether the problematic API functionality is deprecated (planned to be removed) or already removed" |
| }, |
| "apiType": { |
| "type": "string", |
| "description": "Describes which API is effected, usually one of: REST, GraphQL" |
| }, |
| "msg": { |
| "type": "string", |
| "description": "What this deprecation is about" |
| }, |
| "mitigation": { |
| "type": "string", |
| "description": "User-required object to not be affected by the (planned) removal" |
| }, |
| "sinceVersion": { |
| "type": "string", |
| "description": "The deprecation was introduced in this version" |
| }, |
| "plannedRemovalVersion": { |
| "type": "string", |
| "description": "A best-effort guess of which upcoming version will remove the feature entirely" |
| }, |
| "removedIn": { |
| "type": "string", |
| "description": "If the feature has already been removed, it was removed in this version", |
| "x-nullable": true |
| }, |
| "removedTime": { |
| "type": "string", |
| "format": "date-time", |
| "description": "If the feature has already been removed, it was removed at this timestamp", |
| "x-nullable": true |
| }, |
| "sinceTime": { |
| "type": "string", |
| "format": "date-time", |
| "description": "The deprecation was introduced in this version" |
| }, |
| "locations": { |
| "type": "array", |
| "description": "The locations within the specified API affected by this deprecation", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "ErrorResponse": { |
| "description": "An error response given by Weaviate end-points.", |
| "properties": { |
| "error": { |
| "items": { |
| "properties": { |
| "message": { |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "GraphQLError": { |
| "description": "An error response caused by a GraphQL query.", |
| "properties": { |
| "locations": { |
| "items": { |
| "properties": { |
| "column": { |
| "format": "int64", |
| "type": "integer" |
| }, |
| "line": { |
| "format": "int64", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "type": "array" |
| }, |
| "message": { |
| "type": "string" |
| }, |
| "path": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| } |
| } |
| }, |
| "GraphQLQuery": { |
| "description": "GraphQL query based on: http://facebook.github.io/graphql/.", |
| "properties": { |
| "operationName": { |
| "description": "The name of the operation if multiple exist in the query.", |
| "type": "string" |
| }, |
| "query": { |
| "description": "Query based on GraphQL syntax.", |
| "type": "string" |
| }, |
| "variables": { |
| "description": "Additional variables for the query.", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "GraphQLQueries": { |
| "description": "A list of GraphQL queries.", |
| "items": { |
| "$ref": "#/definitions/GraphQLQuery" |
| }, |
| "type": "array" |
| }, |
| "GraphQLResponse": { |
| "description": "GraphQL based response: http://facebook.github.io/graphql/.", |
| "properties": { |
| "data": { |
| "additionalProperties": { |
| "$ref": "#/definitions/JsonObject" |
| }, |
| "description": "GraphQL data object.", |
| "type": "object" |
| }, |
| "errors": { |
| "description": "Array with errors.", |
| "items": { |
| "$ref": "#/definitions/GraphQLError" |
| }, |
| "x-omitempty": true, |
| "type": "array" |
| } |
| } |
| }, |
| "GraphQLResponses": { |
| "description": "A list of GraphQL responses.", |
| "items": { |
| "$ref": "#/definitions/GraphQLResponse" |
| }, |
| "type": "array" |
| }, |
| "InvertedIndexConfig": { |
| "description": "Configure the inverted index built into Weaviate (default: 60).", |
| "properties": { |
| "cleanupIntervalSeconds": { |
| "description": "Asynchronous index clean up happens every n seconds", |
| "format": "int", |
| "type": "number" |
| }, |
| "bm25": { |
| "$ref": "#/definitions/BM25Config" |
| }, |
| "stopwords": { |
| "$ref": "#/definitions/StopwordConfig" |
| }, |
| "indexTimestamps": { |
| "description": "Index each object by its internal timestamps (default: 'false').", |
| "type": "boolean" |
| }, |
| "indexNullState": { |
| "description": "Index each object with the null state (default: 'false').", |
| "type": "boolean" |
| }, |
| "indexPropertyLength": { |
| "description": "Index length of properties (default: 'false').", |
| "type": "boolean" |
| }, |
| "usingBlockMaxWAND": { |
| "description": "Using BlockMax WAND for query execution (default: 'false', will be 'true' for new collections created after 1.30).", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "ReplicationConfig": { |
| "description": "Configure how replication is executed in a cluster", |
| "properties": { |
| "factor": { |
| "description": "Number of times a class is replicated (default: 1).", |
| "type": "integer" |
| }, |
| "asyncEnabled": { |
| "description": "Enable asynchronous replication (default: false).", |
| "type": "boolean", |
| "x-omitempty": false |
| }, |
| "deletionStrategy": { |
| "description": "Conflict resolution strategy for deleted objects.", |
| "type": "string", |
| "enum": [ |
| "NoAutomatedResolution", |
| "DeleteOnConflict", |
| "TimeBasedResolution" |
| ], |
| "x-omitempty": true |
| } |
| }, |
| "type": "object" |
| }, |
| "BM25Config": { |
| "description": "tuning parameters for the BM25 algorithm", |
| "properties": { |
| "k1": { |
| "description": "Calibrates term-weight scaling based on the term frequency within a document (default: 1.2).", |
| "format": "float", |
| "type": "number" |
| }, |
| "b": { |
| "description": "Calibrates term-weight scaling based on the document length (default: 0.75).", |
| "format": "float", |
| "type": "number" |
| } |
| }, |
| "type": "object" |
| }, |
| "StopwordConfig": { |
| "description": "fine-grained control over stopword list usage", |
| "properties": { |
| "preset": { |
| "description": "Pre-existing list of common words by language (default: 'en'). Options: ['en', 'none'].", |
| "type": "string" |
| }, |
| "additions": { |
| "description": "Stopwords to be considered additionally (default: []). Can be any array of custom strings.", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "removals": { |
| "description": "Stopwords to be removed from consideration (default: []). Can be any array of custom strings.", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| }, |
| "type": "object" |
| }, |
| "MultiTenancyConfig": { |
| "description": "Configuration related to multi-tenancy within a class", |
| "properties": { |
| "enabled": { |
| "description": "Whether or not multi-tenancy is enabled for this class (default: false).", |
| "type": "boolean", |
| "x-omitempty": false |
| }, |
| "autoTenantCreation": { |
| "description": "Nonexistent tenants should (not) be created implicitly (default: false).", |
| "type": "boolean", |
| "x-omitempty": false |
| }, |
| "autoTenantActivation": { |
| "description": "Existing tenants should (not) be turned HOT implicitly when they are accessed and in another activity status (default: false).", |
| "type": "boolean", |
| "x-omitempty": false |
| } |
| } |
| }, |
| "JsonObject": { |
| "description": "JSON object value.", |
| "type": "object" |
| }, |
| "Meta": { |
| "description": "Contains meta information of the current Weaviate instance.", |
| "properties": { |
| "hostname": { |
| "description": "The url of the host.", |
| "format": "url", |
| "type": "string" |
| }, |
| "version": { |
| "description": "The Weaviate server version.", |
| "type": "string" |
| }, |
| "modules": { |
| "description": "Module-specific meta information.", |
| "type": "object" |
| }, |
| "grpcMaxMessageSize": { |
| "description": "Max message size for GRPC connection in bytes.", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "MultipleRef": { |
| "description": "Multiple instances of references to other objects.", |
| "items": { |
| "$ref": "#/definitions/SingleRef" |
| }, |
| "type": "array" |
| }, |
| "PatchDocumentObject": { |
| "description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).", |
| "properties": { |
| "from": { |
| "description": "A string containing a JSON Pointer value.", |
| "type": "string" |
| }, |
| "op": { |
| "description": "The operation to be performed.", |
| "enum": [ |
| "add", |
| "remove", |
| "replace", |
| "move", |
| "copy", |
| "test" |
| ], |
| "type": "string" |
| }, |
| "path": { |
| "description": "A JSON-Pointer.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "The value to be used within the operations.", |
| "type": "object" |
| }, |
| "merge": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "required": [ |
| "op", |
| "path" |
| ] |
| }, |
| "PatchDocumentAction": { |
| "description": "Either a JSONPatch document as defined by RFC 6902 (from, op, path, value), or a merge document (RFC 7396).", |
| "properties": { |
| "from": { |
| "description": "A string containing a JSON Pointer value.", |
| "type": "string" |
| }, |
| "op": { |
| "description": "The operation to be performed.", |
| "enum": [ |
| "add", |
| "remove", |
| "replace", |
| "move", |
| "copy", |
| "test" |
| ], |
| "type": "string" |
| }, |
| "path": { |
| "description": "A JSON-Pointer.", |
| "type": "string" |
| }, |
| "value": { |
| "description": "The value to be used within the operations.", |
| "type": "object" |
| }, |
| "merge": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "required": [ |
| "op", |
| "path" |
| ] |
| }, |
| "ReplicationReplicateReplicaRequest": { |
| "description": "Specifies the parameters required to initiate a shard replica movement operation between two nodes for a given collection and shard. This request defines the source and target node, the collection and type of transfer.", |
| "properties": { |
| "sourceNode": { |
| "description": "The name of the Weaviate node currently hosting the shard replica that needs to be moved or copied.", |
| "type": "string" |
| }, |
| "targetNode": { |
| "description": "The name of the Weaviate node where the new shard replica will be created as part of the movement or copy operation.", |
| "type": "string" |
| }, |
| "collection": { |
| "description": "The name of the collection to which the target shard belongs.", |
| "type": "string" |
| }, |
| "shard": { |
| "description": "The name of the shard whose replica is to be moved or copied.", |
| "type": "string" |
| }, |
| "type": { |
| "description": "Specifies the type of replication operation to perform. 'COPY' creates a new replica on the target node while keeping the source replica. 'MOVE' creates a new replica on the target node and then removes the source replica upon successful completion. Defaults to 'COPY' if omitted.", |
| "type": "string", |
| "enum": ["COPY", "MOVE"], |
| "default": "COPY" |
| } |
| }, |
| "type": "object", |
| "required": [ |
| "sourceNode", |
| "targetNode", |
| "collection", |
| "shard" |
| ] |
| }, |
| "ReplicationReplicateReplicaResponse": { |
| "description": "Contains the unique identifier for a successfully initiated asynchronous replica movement operation. This ID can be used to track the progress of the operation.", |
| "properties": { |
| "id": { |
| "description": "The unique identifier (ID) assigned to the registered replication operation.", |
| "format": "uuid", |
| "type": "string" |
| } |
| }, |
| "type": "object", |
| "required": [ |
| "id" |
| ] |
| }, |
| "ReplicationShardingStateResponse": { |
| "description": "Provides the detailed sharding state for one or more collections, including the distribution of shards and their replicas across the cluster nodes.", |
| "properties": { |
| "shardingState": { |
| "$ref": "#/definitions/ReplicationShardingState" |
| } |
| }, |
| "type": "object" |
| }, |
| "ReplicationDisableReplicaRequest": { |
| "description": "Specifies the parameters required to mark a specific shard replica as inactive (soft-delete) on a particular node. This action typically prevents the replica from serving requests but does not immediately remove its data.", |
| "properties": { |
| "node": { |
| "description": "The name of the Weaviate node hosting the shard replica that is to be disabled.", |
| "type": "string" |
| }, |
| "collection": { |
| "description": "The name of the collection to which the shard replica belongs.", |
| "type": "string" |
| }, |
| "shard": { |
| "description": "The ID of the shard whose replica is to be disabled.", |
| "type": "string" |
| } |
| }, |
| "type": "object", |
| "required": [ |
| "node", |
| "collection", |
| "shard" |
| ] |
| }, |
| "ReplicationDeleteReplicaRequest": { |
| "description": "Specifies the parameters required to permanently delete a specific shard replica from a particular node. This action will remove the replica's data from the node.", |
| "properties": { |
| "node": { |
| "description": "The name of the Weaviate node from which the shard replica will be deleted.", |
| "type": "string" |
| }, |
| "collection": { |
| "description": "The name of the collection to which the shard replica belongs.", |
| "type": "string" |
| }, |
| "shard": { |
| "description": "The ID of the shard whose replica is to be deleted.", |
| "type": "string" |
| } |
| }, |
| "type": "object", |
| "required": [ |
| "node", |
| "collection", |
| "shard" |
| ] |
| }, |
| "ReplicationShardReplicas": { |
| "description": "Represents a shard and lists the nodes that currently host its replicas.", |
| "type": "object", |
| "properties": { |
| "shard": { |
| "type": "string" |
| }, |
| "replicas": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "ReplicationShardingState": { |
| "description": "Details the sharding layout for a specific collection, mapping each shard to its set of replicas across the cluster.", |
| "type": "object", |
| "properties": { |
| "collection": { |
| "description": "The name of the collection.", |
| "type": "string" |
| }, |
| "shards": { |
| "description": "An array detailing each shard within the collection and the nodes hosting its replicas.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/ReplicationShardReplicas" |
| } |
| } |
| } |
| }, |
| "ReplicationReplicateDetailsReplicaStatusError": { |
| "description": "Represents an error encountered during a replication operation, including its timestamp and a human-readable message.", |
| "type": "object", |
| "properties": { |
| "whenErroredUnixMs": { |
| "description": "The unix timestamp in ms when the error occurred. This is an approximate time and so should not be used for precise timing.", |
| "format": "int64", |
| "type": "integer" |
| }, |
| "message": { |
| "description": "A human-readable message describing the error.", |
| "type": "string" |
| } |
| } |
| }, |
| "ReplicationReplicateDetailsReplicaStatus": { |
| "description": "Represents the current or historical status of a shard replica involved in a replication operation, including its operational state and any associated errors.", |
| "type": "object", |
| "properties": { |
| "state": { |
| "description": "The current operational state of the replica during the replication process.", |
| "type": "string", |
| "enum": [ |
| "REGISTERED", |
| "HYDRATING", |
| "FINALIZING", |
| "DEHYDRATING", |
| "READY", |
| "CANCELLED" |
| ] |
| }, |
| "whenStartedUnixMs": { |
| "description": "The UNIX timestamp in ms when this state was first entered. This is an approximate time and so should not be used for precise timing.", |
| "format": "int64", |
| "type": "integer" |
| }, |
| "errors": { |
| "description": "A list of error messages encountered by this replica during the replication operation, if any.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/ReplicationReplicateDetailsReplicaStatusError" |
| } |
| } |
| } |
| }, |
| "ReplicationReplicateDetailsReplicaResponse": { |
| "description": "Provides a comprehensive overview of a specific replication operation, detailing its unique ID, the involved collection, shard, source and target nodes, transfer type, current status, and optionally, its status history.", |
| "properties": { |
| "id": { |
| "description": "The unique identifier (ID) of this specific replication operation.", |
| "format": "uuid", |
| "type": "string" |
| }, |
| "shard": { |
| "description": "The name of the shard involved in this replication operation.", |
| "type": "string" |
| }, |
| "collection": { |
| "description": "The name of the collection to which the shard being replicated belongs.", |
| "type": "string" |
| }, |
| "sourceNode": { |
| "description": "The identifier of the node from which the replica is being moved or copied (the source node).", |
| "type": "string" |
| }, |
| "targetNode": { |
| "description": "The identifier of the node to which the replica is being moved or copied (the target node).", |
| "type": "string" |
| }, |
| "type": { |
| "description": "Indicates whether the operation is a 'COPY' (source replica remains) or a 'MOVE' (source replica is removed after successful transfer).", |
| "type": "string", |
| "enum": [ |
| "COPY", |
| "MOVE" |
| ] |
| }, |
| "uncancelable": { |
| "description": "Whether the replica operation is uncancelable.", |
| "type": "boolean" |
| }, |
| "scheduledForCancel": { |
| "description": "Whether the replica operation is scheduled for cancellation.", |
| "type": "boolean" |
| }, |
| "scheduledForDelete": { |
| "description": "Whether the replica operation is scheduled for deletion.", |
| "type": "boolean" |
| }, |
| "status": { |
| "description": "An object detailing the current operational state of the replica movement and any errors encountered.", |
| "type": "object", |
| "$ref": "#/definitions/ReplicationReplicateDetailsReplicaStatus" |
| }, |
| "statusHistory": { |
| "description": "An array detailing the historical sequence of statuses the replication operation has transitioned through, if requested and available.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/ReplicationReplicateDetailsReplicaStatus" |
| } |
| }, |
| "whenStartedUnixMs": { |
| "description": "The UNIX timestamp in ms when the replication operation was initiated. This is an approximate time and so should not be used for precise timing.", |
| "format": "int64", |
| "type": "integer" |
| } |
| }, |
| "required": ["id", "shard", "sourceNode", "targetNode", "collection", "status", "type"] |
| }, |
| "ReplicationReplicateForceDeleteRequest": { |
| "description": "Specifies the parameters available when force deleting replication operations.", |
| "properties": { |
| "id": { |
| "description": "The unique identifier (ID) of the replication operation to be forcefully deleted.", |
| "format": "uuid", |
| "type": "string" |
| }, |
| "collection": { |
| "description": "The name of the collection to which the shard being replicated belongs.", |
| "type": "string" |
| }, |
| "shard": { |
| "description": "The identifier of the shard involved in the replication operations.", |
| "type": "string" |
| }, |
| "node": { |
| "description": "The name of the target node where the replication operations are registered.", |
| "type": "string" |
| }, |
| "dryRun": { |
| "description": "If true, the operation will not actually delete anything but will return the expected outcome of the deletion.", |
| "type": "boolean", |
| "default": false |
| } |
| }, |
| "type": "object" |
| }, |
| "ReplicationReplicateForceDeleteResponse": { |
| "description": "Provides the UUIDs that were successfully force deleted as part of the replication operation. If dryRun is true, this will return the expected outcome without actually deleting anything.", |
| "properties": { |
| "deleted": { |
| "description": "The unique identifiers (IDs) of the replication operations that were forcefully deleted.", |
| "type": "array", |
| "items": { |
| "format": "uuid", |
| "type": "string" |
| } |
| }, |
| "dryRun": { |
| "description": "Indicates whether the operation was a dry run (true) or an actual deletion (false).", |
| "type": "boolean" |
| } |
| }, |
| "type": "object" |
| }, |
| "PeerUpdate": { |
| "description": "A single peer in the network.", |
| "properties": { |
| "id": { |
| "description": "The session ID of the peer.", |
| "type": "string", |
| "format": "uuid" |
| }, |
| "name": { |
| "description": "Human readable name.", |
| "type": "string" |
| }, |
| "uri": { |
| "description": "The location where the peer is exposed to the internet.", |
| "type": "string", |
| "format": "uri" |
| }, |
| "schemaHash": { |
| "description": "The latest known hash of the peer's schema.", |
| "type": "string" |
| } |
| } |
| }, |
| "PeerUpdateList": { |
| "description": "List of known peers.", |
| "items": { |
| "$ref": "#/definitions/PeerUpdate" |
| }, |
| "type": "array" |
| }, |
| "VectorWeights": { |
| "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.", |
| "type": "object" |
| }, |
| "PropertySchema": { |
| "description": "Names and values of an individual property. A returned response may also contain additional metadata, such as from classification or feature projection.", |
| "type": "object" |
| }, |
| "SchemaHistory": { |
| "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.", |
| "type": "object" |
| }, |
| "Schema": { |
| "description": "Definitions of semantic schemas (also see: https://github.com/weaviate/weaviate-semantic-schemas).", |
| "properties": { |
| "classes": { |
| "description": "Semantic classes that are available.", |
| "items": { |
| "$ref": "#/definitions/Class" |
| }, |
| "type": "array" |
| }, |
| "maintainer": { |
| "description": "Email of the maintainer.", |
| "format": "email", |
| "type": "string" |
| }, |
| "name": { |
| "description": "Name of the schema.", |
| "type": "string" |
| } |
| }, |
| "type": "object" |
| }, |
| "SchemaClusterStatus": { |
| "description": "Indicates the health of the schema in a cluster.", |
| "properties": { |
| "healthy": { |
| "description": "True if the cluster is in sync, false if there is an issue (see error).", |
| "type": "boolean", |
| "x-omitempty": false |
| }, |
| "error": { |
| "description": "Contains the sync check error if one occurred", |
| "type": "string", |
| "x-omitempty": true |
| }, |
| "hostname": { |
| "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.", |
| "type": "string" |
| }, |
| "nodeCount": { |
| "description": "Number of nodes that participated in the sync check", |
| "type": "number", |
| "format": "int" |
| }, |
| "ignoreSchemaSync": { |
| "description": "The cluster check at startup can be ignored (to recover from an out-of-sync situation).", |
| "type": "boolean", |
| "x-omitempty": false |
| } |
| }, |
| "type": "object" |
| }, |
| "Class": { |
| "properties": { |
| "class": { |
| "description": "Name of the class (a.k.a. 'collection') (required). Multiple words should be concatenated in CamelCase, e.g. `ArticleAuthor`.", |
| "type": "string" |
| }, |
| "vectorConfig": { |
| "description": "Configure named vectors. Either use this field or `vectorizer`, `vectorIndexType`, and `vectorIndexConfig` fields. Available from `v1.24.0`.", |
| "type": "object", |
| "additionalProperties": { |
| "$ref": "#/definitions/VectorConfig" |
| } |
| }, |
| "vectorIndexType": { |
| "description": "Name of the vector index to use, eg. (HNSW)", |
| "type": "string" |
| }, |
| "vectorIndexConfig": { |
| "description": "Vector-index config, that is specific to the type of index selected in vectorIndexType", |
| "type": "object" |
| }, |
| "shardingConfig": { |
| "description": "Manage how the index should be sharded and distributed in the cluster", |
| "type": "object" |
| }, |
| "replicationConfig": { |
| "$ref": "#/definitions/ReplicationConfig" |
| }, |
| "invertedIndexConfig": { |
| "$ref": "#/definitions/InvertedIndexConfig" |
| }, |
| "multiTenancyConfig": { |
| "$ref": "#/definitions/MultiTenancyConfig" |
| }, |
| "vectorizer": { |
| "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.", |
| "type": "string" |
| }, |
| "moduleConfig": { |
| "description": "Configuration specific to modules in a collection context.", |
| "type": "object" |
| }, |
| "description": { |
| "description": "Description of the collection for metadata purposes.", |
| "type": "string" |
| }, |
| "properties": { |
| "description": "Define properties of the collection.", |
| "items": { |
| "$ref": "#/definitions/Property" |
| }, |
| "type": "array" |
| } |
| }, |
| "type": "object" |
| }, |
| "Property": { |
| "properties": { |
| "dataType": { |
| "description": "Data type of the property (required). If it starts with a capital (for example Person), may be a reference to another type.", |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "description": { |
| "description": "Description of the property.", |
| "type": "string" |
| }, |
| "moduleConfig": { |
| "description": "Configuration specific to modules this Weaviate instance has installed", |
| "type": "object" |
| }, |
| "name": { |
| "description": "The name of the property (required). Multiple words should be concatenated in camelCase, e.g. `nameOfAuthor`.", |
| "type": "string" |
| }, |
| "indexInverted": { |
| "description": "(Deprecated). Whether to include this property in the inverted index. If `false`, this property cannot be used in `where` filters, `bm25` or `hybrid` search. <br/><br/>Unrelated to vectorization behavior (deprecated as of v1.19; use indexFilterable or/and indexSearchable instead)", |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "indexFilterable": { |
| "description": "Whether to include this property in the filterable, Roaring Bitmap index. If `false`, this property cannot be used in `where` filters. <br/><br/>Note: Unrelated to vectorization behavior.", |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "indexSearchable": { |
| "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", |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "indexRangeFilters": { |
| "description": "Whether to include this property in the filterable, range-based Roaring Bitmap index. Provides better performance for range queries compared to filterable index in large datasets. Applicable only to properties of data type int, number, date.", |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "tokenization": { |
| "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", |
| "type": "string", |
| "enum": [ |
| "word", |
| "lowercase", |
| "whitespace", |
| "field", |
| "trigram", |
| "gse", |
| "kagome_kr", |
| "kagome_ja", |
| "gse_ch" |
| ] |
| }, |
| "nestedProperties": { |
| "description": "The properties of the nested object(s). Applies to object and object[] data types.", |
| "items": { |
| "$ref": "#/definitions/NestedProperty" |
| }, |
| "type": "array", |
| "x-omitempty": true |
| } |
| }, |
| "type": "object" |
| }, |
| "VectorConfig": { |
| "properties": { |
| "vectorizer": { |
| "description": "Configuration of a specific vectorizer used by this vector", |
| "type": "object" |
| }, |
| "vectorIndexType": { |
| "description": "Name of the vector index to use, eg. (HNSW)", |
| "type": "string" |
| }, |
| "vectorIndexConfig": { |
| "description": "Vector-index config, that is specific to the type of index selected in vectorIndexType", |
| "type": "object" |
| } |
| }, |
| "type": "object" |
| }, |
| "NestedProperty": { |
| "properties": { |
| "dataType": { |
| "items": { |
| "type": "string" |
| }, |
| "type": "array" |
| }, |
| "description": { |
| "type": "string" |
| }, |
| "name": { |
| "type": "string" |
| }, |
| "indexFilterable": { |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "indexSearchable": { |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "indexRangeFilters": { |
| "type": "boolean", |
| "x-nullable": true |
| }, |
| "tokenization": { |
| "type": "string", |
| "enum": [ |
| "word", |
| "lowercase", |
| "whitespace", |
| "field", |
| "trigram", |
| "gse", |
| "kagome_kr", |
| "kagome_ja", |
| "gse_ch" |
| ] |
| }, |
| "nestedProperties": { |
| "description": "The properties of the nested object(s). Applies to object and object[] data types.", |
| "items": { |
| "$ref": "#/definitions/NestedProperty" |
| }, |
| "type": "array", |
| "x-omitempty": true |
| } |
| }, |
| "type": "object" |
| }, |
| "ShardStatusList": { |
| "description": "The status of all the shards of a Class", |
| "items": { |
| "$ref": "#/definitions/ShardStatusGetResponse" |
| }, |
| "type": "array" |
| }, |
| "ShardStatusGetResponse": { |
| "description": "Response body of shard status get request", |
| "properties": { |
| "name": { |
| "description": "Name of the shard", |
| "type": "string" |
| }, |
| "status": { |
| "description": "Status of the shard", |
| "type": "string" |
| }, |
| "vectorQueueSize": { |
| "description": "Size of the vector queue of the shard", |
| "type": "integer", |
| "x-omitempty": false |
| } |
| } |
| }, |
| "ShardStatus": { |
| "description": "The status of a single shard", |
| "properties": { |
| "status": { |
| "description": "Status of the shard", |
| "type": "string" |
| } |
| } |
| }, |
| "BackupCreateStatusResponse": { |
| "description": "The definition of a backup create metadata", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "backend": { |
| "description": "Backup backend name e.g. filesystem, gcs, s3.", |
| "type": "string" |
| }, |
| "path": { |
| "description": "destination path of backup files proper to selected backend", |
| "type": "string" |
| }, |
| "error": { |
| "description": "error message if creation failed", |
| "type": "string" |
| }, |
| "status": { |
| "description": "phase of backup creation process", |
| "type": "string", |
| "default": "STARTED", |
| "enum": [ |
| "STARTED", |
| "TRANSFERRING", |
| "TRANSFERRED", |
| "SUCCESS", |
| "FAILED", |
| "CANCELED" |
| ] |
| } |
| } |
| }, |
| "BackupRestoreStatusResponse": { |
| "description": "The definition of a backup restore metadata", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "backend": { |
| "description": "Backup backend name e.g. filesystem, gcs, s3.", |
| "type": "string" |
| }, |
| "path": { |
| "description": "destination path of backup files proper to selected backup backend, contains bucket and path", |
| "type": "string" |
| }, |
| "error": { |
| "description": "error message if restoration failed", |
| "type": "string" |
| }, |
| "status": { |
| "description": "phase of backup restoration process", |
| "type": "string", |
| "default": "STARTED", |
| "enum": [ |
| "STARTED", |
| "TRANSFERRING", |
| "TRANSFERRED", |
| "SUCCESS", |
| "FAILED", |
| "CANCELED" |
| ] |
| } |
| } |
| }, |
| "BackupConfig": { |
| "description": "Backup custom configuration", |
| "type": "object", |
| "properties": { |
| "Endpoint": { |
| "type": "string", |
| "description": "name of the endpoint, e.g. s3.amazonaws.com" |
| }, |
| "Bucket": { |
| "type": "string", |
| "description": "Name of the bucket, container, volume, etc" |
| }, |
| "Path": { |
| "type": "string", |
| "description": "Path or key within the bucket" |
| }, |
| "CPUPercentage": { |
| "description": "Desired CPU core utilization ranging from 1%-80%", |
| "type": "integer", |
| "default": 50, |
| "minimum": 1, |
| "maximum": 80, |
| "x-nullable": false |
| }, |
| "ChunkSize": { |
| "description": "Aimed chunk size, with a minimum of 2MB, default of 128MB, and a maximum of 512MB. The actual chunk size may vary.", |
| "type": "integer", |
| "default": 128, |
| "minimum": 2, |
| "maximum": 512, |
| "x-nullable": false |
| }, |
| "CompressionLevel": { |
| "description": "compression level used by compression algorithm", |
| "type": "string", |
| "default": "DefaultCompression", |
| "x-nullable": false, |
| "enum": [ |
| "DefaultCompression", |
| "BestSpeed", |
| "BestCompression" |
| ] |
| } |
| } |
| }, |
| "RestoreConfig": { |
| "description": "Backup custom configuration", |
| "type": "object", |
| "properties": { |
| "Endpoint": { |
| "type": "string", |
| "description": "name of the endpoint, e.g. s3.amazonaws.com" |
| }, |
| "Bucket": { |
| "type": "string", |
| "description": "Name of the bucket, container, volume, etc" |
| }, |
| "Path": { |
| "type": "string", |
| "description": "Path within the bucket" |
| }, |
| "CPUPercentage": { |
| "description": "Desired CPU core utilization ranging from 1%-80%", |
| "type": "integer", |
| "default": 50, |
| "minimum": 1, |
| "maximum": 80, |
| "x-nullable": false |
| }, |
| "rolesOptions" : { |
| "description": "How roles should be restored", |
| "type": "string", |
| "enum": [ |
| "noRestore", |
| "all" |
| ], |
| "default": "noRestore" |
| }, |
| "usersOptions" : { |
| "description": "How users should be restored", |
| "type": "string", |
| "enum": [ |
| "noRestore", |
| "all" |
| ], |
| "default": "noRestore" |
| } |
| } |
| }, |
| "BackupCreateRequest": { |
| "description": "Request body for creating a backup of a set of classes", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup (required). Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "config": { |
| "description": "Custom configuration for the backup creation process", |
| "type": "object", |
| "$ref": "#/definitions/BackupConfig" |
| }, |
| "include": { |
| "description": "List of collections to include in the backup creation process. If not set, all collections are included. Cannot be used together with `exclude`.", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "exclude": { |
| "description": "List of collections to exclude from the backup creation process. If not set, all collections are included. Cannot be used together with `include`.", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| }, |
| "BackupCreateResponse": { |
| "description": "The definition of a backup create response body", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "classes": { |
| "description": "The list of classes for which the backup creation process was started", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "backend": { |
| "description": "Backup backend name e.g. filesystem, gcs, s3.", |
| "type": "string" |
| }, |
| "bucket": { |
| "description": "Name of the bucket, container, volume, etc", |
| "type": "string" |
| }, |
| "path": { |
| "description": "Path within bucket of backup", |
| "type": "string" |
| }, |
| "error": { |
| "description": "error message if creation failed", |
| "type": "string" |
| }, |
| "status": { |
| "description": "phase of backup creation process", |
| "type": "string", |
| "default": "STARTED", |
| "enum": [ |
| "STARTED", |
| "TRANSFERRING", |
| "TRANSFERRED", |
| "SUCCESS", |
| "FAILED", |
| "CANCELED" |
| ] |
| } |
| } |
| }, |
| "BackupListResponse": { |
| "description": "The definition of a backup create response body", |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "classes": { |
| "description": "The list of classes for which the existed backup process", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "status": { |
| "description": "status of backup process", |
| "type": "string", |
| "enum": [ |
| "STARTED", |
| "TRANSFERRING", |
| "TRANSFERRED", |
| "SUCCESS", |
| "FAILED", |
| "CANCELED" |
| ] |
| } |
| } |
| } |
| }, |
| "BackupRestoreRequest": { |
| "description": "Request body for restoring a backup for a set of classes", |
| "properties": { |
| "config": { |
| "description": "Custom configuration for the backup restoration process", |
| "type": "object", |
| "$ref": "#/definitions/RestoreConfig" |
| }, |
| "include": { |
| "description": "List of classes to include in the backup restoration process", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "exclude": { |
| "description": "List of classes to exclude from the backup restoration process", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "node_mapping": { |
| "description": "Allows overriding the node names stored in the backup with different ones. Useful when restoring backups to a different environment.", |
| "type": "object", |
| "additionalProperties": { |
| "type": "string" |
| } |
| }, |
| "overwriteAlias": { |
| "description": "Allows ovewriting the collection alias if there is a conflict", |
| "type": "boolean" |
| } |
| } |
| }, |
| "BackupRestoreResponse": { |
| "description": "The definition of a backup restore response body", |
| "properties": { |
| "id": { |
| "description": "The ID of the backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed.", |
| "type": "string" |
| }, |
| "classes": { |
| "description": "The list of classes for which the backup restoration process was started", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "backend": { |
| "description": "Backup backend name e.g. filesystem, gcs, s3.", |
| "type": "string" |
| }, |
| "path": { |
| "description": "destination path of backup files proper to selected backend", |
| "type": "string" |
| }, |
| "error": { |
| "description": "error message if restoration failed", |
| "type": "string" |
| }, |
| "status": { |
| "description": "phase of backup restoration process", |
| "type": "string", |
| "default": "STARTED", |
| "enum": [ |
| "STARTED", |
| "TRANSFERRING", |
| "TRANSFERRED", |
| "SUCCESS", |
| "FAILED", |
| "CANCELED" |
| ] |
| } |
| } |
| }, |
| "NodeStats": { |
| "description": "The summary of Weaviate's statistics.", |
| "properties": { |
| "shardCount": { |
| "description": "The count of Weaviate's shards. To see this value, set `output` to `verbose`.", |
| "format": "int", |
| "type": "number", |
| "x-omitempty": false |
| }, |
| "objectCount": { |
| "description": "The total number of objects in DB.", |
| "format": "int64", |
| "type": "number", |
| "x-omitempty": false |
| } |
| } |
| }, |
| "BatchStats": { |
| "description": "The summary of a nodes batch queue congestion status.", |
| "properties": { |
| "queueLength": { |
| "description": "How many objects are currently in the batch queue.", |
| "format": "int", |
| "type": "number", |
| "x-omitempty": true, |
| "x-nullable": true |
| }, |
| "ratePerSecond": { |
| "description": "How many objects are approximately processed from the batch queue per second.", |
| "format": "int", |
| "type": "number", |
| "x-omitempty": false |
| } |
| } |
| }, |
| "NodeShardStatus": { |
| "description": "The definition of a node shard status response body", |
| "properties": { |
| "name": { |
| "description": "The name of the shard.", |
| "type": "string", |
| "x-omitempty": false |
| }, |
| "class": { |
| "description": "The name of shard's class.", |
| "type": "string", |
| "x-omitempty": false |
| }, |
| "objectCount": { |
| "description": "The number of objects in shard.", |
| "format": "int64", |
| "type": "number", |
| "x-omitempty": false |
| }, |
| "vectorIndexingStatus": { |
| "description": "The status of the vector indexing process.", |
| "format": "string", |
| "x-omitempty": false |
| }, |
| "compressed": { |
| "description": "The status of vector compression/quantization.", |
| "format": "boolean", |
| "x-omitempty": false |
| }, |
| "vectorQueueLength": { |
| "description": "The length of the vector indexing queue.", |
| "format": "int64", |
| "type": "number", |
| "x-omitempty": false |
| }, |
| "loaded": { |
| "description": "The load status of the shard.", |
| "type": "boolean", |
| "x-omitempty": false |
| }, |
| "asyncReplicationStatus": { |
| "description": "The status of the async replication.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/AsyncReplicationStatus" |
| } |
| }, |
| "numberOfReplicas": { |
| "description": "Number of replicas for the shard.", |
| "type": ["integer", "null"], |
| "format": "int64", |
| "x-omitempty": true |
| }, |
| "replicationFactor": { |
| "description": "Minimum number of replicas for the shard.", |
| "type": ["integer", "null"], |
| "format": "int64", |
| "x-omitempty": true |
| } |
| } |
| }, |
| "AsyncReplicationStatus": { |
| "description": "The status of the async replication.", |
| "properties": { |
| "objectsPropagated": { |
| "description": "The number of objects propagated in the most recent iteration.", |
| "type": "number", |
| "format": "uint64" |
| }, |
| "startDiffTimeUnixMillis": { |
| "description": "The start time of the most recent iteration.", |
| "type": "number", |
| "format": "int64" |
| }, |
| "targetNode": { |
| "description": "The target node of the replication, if set, otherwise empty.", |
| "type": "string" |
| } |
| } |
| }, |
| "NodeStatus": { |
| "description": "The definition of a backup node status response body", |
| "properties": { |
| "name": { |
| "description": "The name of the node.", |
| "type": "string" |
| }, |
| "status": { |
| "description": "Node's status.", |
| "type": "string", |
| "default": "HEALTHY", |
| "enum": [ |
| "HEALTHY", |
| "UNHEALTHY", |
| "UNAVAILABLE", |
| "TIMEOUT" |
| ] |
| }, |
| "version": { |
| "description": "The version of Weaviate.", |
| "type": "string" |
| }, |
| "gitHash": { |
| "description": "The gitHash of Weaviate.", |
| "type": "string" |
| }, |
| "stats": { |
| "description": "Weaviate overall statistics.", |
| "type": "object", |
| "$ref": "#/definitions/NodeStats" |
| }, |
| "batchStats": { |
| "description": "Weaviate batch statistics.", |
| "type": "object", |
| "$ref": "#/definitions/BatchStats" |
| }, |
| "shards": { |
| "description": "The list of the shards with it's statistics.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/NodeShardStatus" |
| } |
| } |
| } |
| }, |
| "NodesStatusResponse": { |
| "description": "The status of all of the Weaviate nodes", |
| "type": "object", |
| "properties": { |
| "nodes": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/NodeStatus" |
| } |
| } |
| } |
| }, |
| "DistributedTask": { |
| "description": "Distributed task metadata.", |
| "type": "object", |
| "properties": { |
| "id": { |
| "description": "The ID of the task.", |
| "type": "string" |
| }, |
| "version": { |
| "description": "The version of the task.", |
| "type": "integer" |
| }, |
| "status": { |
| "description": "The status of the task.", |
| "type": "string" |
| }, |
| "startedAt": { |
| "description": "The time when the task was created.", |
| "type": "string", |
| "format": "date-time" |
| }, |
| "finishedAt": { |
| "description": "The time when the task was finished.", |
| "type": "string", |
| "format": "date-time" |
| }, |
| "finishedNodes": { |
| "description": "The nodes that finished the task.", |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "error": { |
| "description": "The high level reason why the task failed.", |
| "type": "string", |
| "x-omitempty": true |
| }, |
| "payload": { |
| "description": "The payload of the task.", |
| "type": "object" |
| } |
| } |
| }, |
| "DistributedTasks": { |
| "description": "Active distributed tasks by namespace.", |
| "type": "object", |
| "additionalProperties": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/DistributedTask" |
| } |
| } |
| }, |
| "RaftStatistics": { |
| "description": "The definition of Raft statistics.", |
| "properties": { |
| "appliedIndex": { |
| "type": "string" |
| }, |
| "commitIndex": { |
| "type": "string" |
| }, |
| "fsmPending": { |
| "type": "string" |
| }, |
| "lastContact": { |
| "type": "string" |
| }, |
| "lastLogIndex": { |
| "type": "string" |
| }, |
| "lastLogTerm": { |
| "type": "string" |
| }, |
| "lastSnapshotIndex": { |
| "type": "string" |
| }, |
| "lastSnapshotTerm": { |
| "type": "string" |
| }, |
| "latestConfiguration": { |
| "description": "Weaviate Raft nodes.", |
| "type": "object" |
| }, |
| "latestConfigurationIndex": { |
| "type": "string" |
| }, |
| "numPeers": { |
| "type": "string" |
| }, |
| "protocolVersion": { |
| "type": "string" |
| }, |
| "protocolVersionMax": { |
| "type": "string" |
| }, |
| "protocolVersionMin": { |
| "type": "string" |
| }, |
| "snapshotVersionMax": { |
| "type": "string" |
| }, |
| "snapshotVersionMin": { |
| "type": "string" |
| }, |
| "state": { |
| "type": "string" |
| }, |
| "term": { |
| "type": "string" |
| } |
| } |
| }, |
| "Statistics": { |
| "description": "The definition of node statistics.", |
| "properties": { |
| "name": { |
| "description": "The name of the node.", |
| "type": "string" |
| }, |
| "status": { |
| "description": "Node's status.", |
| "type": "string", |
| "default": "HEALTHY", |
| "enum": [ |
| "HEALTHY", |
| "UNHEALTHY", |
| "UNAVAILABLE", |
| "TIMEOUT" |
| ] |
| }, |
| "bootstrapped": { |
| "type": "boolean" |
| }, |
| "dbLoaded": { |
| "type": "boolean" |
| }, |
| "initialLastAppliedIndex": { |
| "type": "number", |
| "format": "uint64" |
| }, |
| "lastAppliedIndex": { |
| "type": "number" |
| }, |
| "isVoter": { |
| "type": "boolean" |
| }, |
| "leaderId": { |
| "type": "object" |
| }, |
| "leaderAddress": { |
| "type": "object" |
| }, |
| "open": { |
| "type": "boolean" |
| }, |
| "ready": { |
| "type": "boolean" |
| }, |
| "candidates": { |
| "type": "object" |
| }, |
| "raft": { |
| "description": "Weaviate Raft statistics.", |
| "type": "object", |
| "$ref": "#/definitions/RaftStatistics" |
| } |
| } |
| }, |
| "ClusterStatisticsResponse": { |
| "description": "The cluster statistics of all of the Weaviate nodes", |
| "type": "object", |
| "properties": { |
| "statistics": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Statistics" |
| } |
| }, |
| "synchronized": { |
| "type": "boolean", |
| "x-omitempty": false |
| } |
| } |
| }, |
| "SingleRef": { |
| "description": "Either set beacon (direct reference) or set class and schema (concept reference)", |
| "properties": { |
| "class": { |
| "description": "If using a concept reference (rather than a direct reference), specify the desired class name here", |
| "format": "uri", |
| "type": "string" |
| }, |
| "schema": { |
| "description": "If using a concept reference (rather than a direct reference), specify the desired properties here", |
| "$ref": "#/definitions/PropertySchema" |
| }, |
| "beacon": { |
| "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", |
| "format": "uri", |
| "type": "string" |
| }, |
| "href": { |
| "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.", |
| "format": "uri", |
| "type": "string" |
| }, |
| "classification": { |
| "description": "Additional Meta information about classifications if the item was part of one", |
| "$ref": "#/definitions/ReferenceMetaClassification" |
| } |
| } |
| }, |
| "AdditionalProperties": { |
| "description": "(Response only) Additional meta information about a single object.", |
| "type": "object", |
| "additionalProperties": { |
| "type": "object" |
| } |
| }, |
| "ReferenceMetaClassification": { |
| "description": "This meta field contains additional info about the classified reference property", |
| "properties": { |
| "overallCount": { |
| "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", |
| "type": "number", |
| "format": "int64" |
| }, |
| "winningCount": { |
| "description": "size of the winning group, a number between 1..k", |
| "type": "number", |
| "format": "int64" |
| }, |
| "losingCount": { |
| "description": "size of the losing group, can be 0 if the winning group size equals k", |
| "type": "number", |
| "format": "int64" |
| }, |
| "closestOverallDistance": { |
| "description": "The lowest distance of any neighbor, regardless of whether they were in the winning or losing group", |
| "type": "number", |
| "format": "float32" |
| }, |
| "winningDistance": { |
| "description": "deprecated - do not use, to be removed in 0.23.0", |
| "type": "number", |
| "format": "float32" |
| }, |
| "meanWinningDistance": { |
| "description": "Mean distance of all neighbors from the winning group", |
| "type": "number", |
| "format": "float32" |
| }, |
| "closestWinningDistance": { |
| "description": "Closest distance of a neighbor from the winning group", |
| "type": "number", |
| "format": "float32" |
| }, |
| "closestLosingDistance": { |
| "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", |
| "type": "number", |
| "format": "float32", |
| "x-nullable": true |
| }, |
| "losingDistance": { |
| "description": "deprecated - do not use, to be removed in 0.23.0", |
| "type": "number", |
| "format": "float32", |
| "x-nullable": true |
| }, |
| "meanLosingDistance": { |
| "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.", |
| "type": "number", |
| "format": "float32", |
| "x-nullable": true |
| } |
| } |
| }, |
| "BatchReference": { |
| "properties": { |
| "from": { |
| "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.", |
| "format": "uri", |
| "type": "string", |
| "example": "weaviate://localhost/Zoo/a5d09582-4239-4702-81c9-92a6e0122bb4/hasAnimals" |
| }, |
| "to": { |
| "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", |
| "example": "weaviate://localhost/97525810-a9a5-4eb0-858a-71449aeb007f", |
| "format": "uri", |
| "type": "string" |
| }, |
| "tenant": { |
| "type": "string", |
| "description": "Name of the reference tenant." |
| } |
| } |
| }, |
| "BatchReferenceResponse": { |
| "allOf": [ |
| { |
| "$ref": "#/definitions/BatchReference" |
| }, |
| { |
| "properties": { |
| "result": { |
| "description": "Results for this specific reference.", |
| "format": "object", |
| "properties": { |
| "status": { |
| "type": "string", |
| "default": "SUCCESS", |
| "enum": [ |
| "SUCCESS", |
| "FAILED" |
| ] |
| }, |
| "errors": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| } |
| ], |
| "type": "object" |
| }, |
| "GeoCoordinates": { |
| "properties": { |
| "latitude": { |
| "description": "The latitude of the point on earth in decimal form", |
| "format": "float", |
| "type": "number", |
| "x-nullable": true |
| }, |
| "longitude": { |
| "description": "The longitude of the point on earth in decimal form", |
| "format": "float", |
| "type": "number", |
| "x-nullable": true |
| } |
| } |
| }, |
| "PhoneNumber": { |
| "properties": { |
| "input": { |
| "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.", |
| "type": "string" |
| }, |
| "internationalFormatted": { |
| "description": "Read-only. Parsed result in the international format (e.g. +49 123 ...)", |
| "type": "string" |
| }, |
| "defaultCountry": { |
| "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", |
| "type": "string" |
| }, |
| "countryCode": { |
| "description": "Read-only. The numerical country code (e.g. 49)", |
| "format": "uint64", |
| "type": "number" |
| }, |
| "national": { |
| "description": "Read-only. The numerical representation of the national part", |
| "format": "uint64", |
| "type": "number" |
| }, |
| "nationalFormatted": { |
| "description": "Read-only. Parsed result in the national format (e.g. 0123 456789)", |
| "type": "string" |
| }, |
| "valid": { |
| "description": "Read-only. Indicates whether the parsed number is a valid phone number", |
| "type": "boolean" |
| } |
| } |
| }, |
| "Object": { |
| "properties": { |
| "class": { |
| "description": "Class of the Object, defined in the schema.", |
| "type": "string" |
| }, |
| "vectorWeights": { |
| "$ref": "#/definitions/VectorWeights" |
| }, |
| "properties": { |
| "$ref": "#/definitions/PropertySchema" |
| }, |
| "id": { |
| "description": "ID of the Object.", |
| "format": "uuid", |
| "type": "string" |
| }, |
| "creationTimeUnix": { |
| "description": "(Response only) Timestamp of creation of this object in milliseconds since epoch UTC.", |
| "format": "int64", |
| "type": "integer" |
| }, |
| "lastUpdateTimeUnix": { |
| "description": "(Response only) Timestamp of the last object update in milliseconds since epoch UTC.", |
| "format": "int64", |
| "type": "integer" |
| }, |
| "vector": { |
| "description": "This field returns vectors associated with the Object. C11yVector, Vector or Vectors values are possible.", |
| "$ref": "#/definitions/C11yVector" |
| }, |
| "vectors": { |
| "description": "This field returns vectors associated with the Object.", |
| "$ref": "#/definitions/Vectors" |
| }, |
| "tenant": { |
| "description": "Name of the Objects tenant.", |
| "type": "string" |
| }, |
| "additional": { |
| "$ref": "#/definitions/AdditionalProperties" |
| } |
| }, |
| "type": "object" |
| }, |
| "ObjectsGetResponse": { |
| "allOf": [ |
| { |
| "$ref": "#/definitions/Object" |
| }, |
| { |
| "properties": { |
| "deprecations": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Deprecation" |
| } |
| } |
| } |
| }, |
| { |
| "properties": { |
| "result": { |
| "description": "Results for this specific Object.", |
| "format": "object", |
| "properties": { |
| "status": { |
| "type": "string", |
| "default": "SUCCESS", |
| "enum": [ |
| "SUCCESS", |
| "FAILED" |
| ] |
| }, |
| "errors": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| } |
| ], |
| "type": "object" |
| }, |
| "BatchDelete": { |
| "type": "object", |
| "properties": { |
| "match": { |
| "description": "Outlines how to find the objects to be deleted.", |
| "type": "object", |
| "properties": { |
| "class": { |
| "description": "Class (name) which objects will be deleted.", |
| "type": "string", |
| "example": "City" |
| }, |
| "where": { |
| "description": "Filter to limit the objects to be deleted.", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilter" |
| } |
| } |
| }, |
| "output": { |
| "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".", |
| "type": "string", |
| "default": "minimal" |
| }, |
| "deletionTimeUnixMilli": { |
| "description": "Timestamp of deletion in milliseconds since epoch UTC.", |
| "format": "int64", |
| "type": "integer", |
| "x-nullable": true |
| }, |
| "dryRun": { |
| "description": "If true, the call will show which objects would be matched using the specified filter without deleting any objects. <br/><br/>Depending on the configured verbosity, you will either receive a count of affected objects, or a list of IDs.", |
| "type": "boolean", |
| "default": false |
| } |
| } |
| }, |
| "BatchDeleteResponse": { |
| "description": "Delete Objects response.", |
| "type": "object", |
| "properties": { |
| "match": { |
| "description": "Outlines how to find the objects to be deleted.", |
| "type": "object", |
| "properties": { |
| "class": { |
| "description": "Class (name) which objects will be deleted.", |
| "type": "string", |
| "example": "City" |
| }, |
| "where": { |
| "description": "Filter to limit the objects to be deleted.", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilter" |
| } |
| } |
| }, |
| "output": { |
| "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".", |
| "type": "string", |
| "default": "minimal" |
| }, |
| "deletionTimeUnixMilli": { |
| "description": "Timestamp of deletion in milliseconds since epoch UTC.", |
| "format": "int64", |
| "type": "integer", |
| "x-nullable": true |
| }, |
| "dryRun": { |
| "description": "If true, objects will not be deleted yet, but merely listed. Defaults to false.", |
| "type": "boolean", |
| "default": false |
| }, |
| "results": { |
| "type": "object", |
| "properties": { |
| "matches": { |
| "description": "How many objects were matched by the filter.", |
| "type": "number", |
| "format": "int64", |
| "x-omitempty": false |
| }, |
| "limit": { |
| "description": "The most amount of objects that can be deleted in a single query, equals QUERY_MAXIMUM_RESULTS.", |
| "type": "number", |
| "format": "int64", |
| "x-omitempty": false |
| }, |
| "successful": { |
| "description": "How many objects were successfully deleted in this round.", |
| "type": "number", |
| "format": "int64", |
| "x-omitempty": false |
| }, |
| "failed": { |
| "description": "How many objects should have been deleted but could not be deleted.", |
| "type": "number", |
| "format": "int64", |
| "x-omitempty": false |
| }, |
| "objects": { |
| "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.", |
| "type": "array", |
| "items": { |
| "description": "Results for this specific Object.", |
| "format": "object", |
| "properties": { |
| "id": { |
| "description": "ID of the Object.", |
| "format": "uuid", |
| "type": "string" |
| }, |
| "status": { |
| "type": "string", |
| "default": "SUCCESS", |
| "enum": [ |
| "SUCCESS", |
| "DRYRUN", |
| "FAILED" |
| ] |
| }, |
| "errors": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "ObjectsListResponse": { |
| "description": "List of Objects.", |
| "properties": { |
| "objects": { |
| "description": "The actual list of Objects.", |
| "items": { |
| "$ref": "#/definitions/Object" |
| }, |
| "type": "array" |
| }, |
| "deprecations": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Deprecation" |
| } |
| }, |
| "totalResults": { |
| "description": "The total number of Objects for the query. The number of items in a response may be smaller due to paging.", |
| "format": "int64", |
| "type": "integer" |
| } |
| }, |
| "type": "object" |
| }, |
| "Classification": { |
| "description": "Manage classifications, trigger them and view status of past classifications.", |
| "properties": { |
| "id": { |
| "description": "ID to uniquely identify this classification run", |
| "format": "uuid", |
| "type": "string", |
| "example": "ee722219-b8ec-4db1-8f8d-5150bb1a9e0c" |
| }, |
| "class": { |
| "description": "class (name) which is used in this classification", |
| "type": "string", |
| "example": "City" |
| }, |
| "classifyProperties": { |
| "description": "which ref-property to set as part of the classification", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": [ |
| "inCountry" |
| ] |
| }, |
| "basedOnProperties": { |
| "description": "base the text-based classification on these fields (of type text)", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": [ |
| "description" |
| ] |
| }, |
| "status": { |
| "description": "status of this classification", |
| "type": "string", |
| "enum": [ |
| "running", |
| "completed", |
| "failed" |
| ], |
| "example": "running" |
| }, |
| "meta": { |
| "description": "additional meta information about the classification", |
| "type": "object", |
| "$ref": "#/definitions/ClassificationMeta" |
| }, |
| "type": { |
| "description": "which algorithm to use for classifications", |
| "type": "string" |
| }, |
| "settings": { |
| "description": "classification-type specific settings", |
| "type": "object" |
| }, |
| "error": { |
| "description": "error message if status == failed", |
| "type": "string", |
| "default": "", |
| "example": "classify xzy: something went wrong" |
| }, |
| "filters": { |
| "type": "object", |
| "properties": { |
| "sourceWhere": { |
| "description": "limit the objects to be classified", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilter" |
| }, |
| "trainingSetWhere": { |
| "description": "Limit the training objects to be considered during the classification. Can only be used on types with explicit training sets, such as 'knn'", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilter" |
| }, |
| "targetWhere": { |
| "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", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilter" |
| } |
| } |
| } |
| }, |
| "type": "object" |
| }, |
| "ClassificationMeta": { |
| "description": "Additional information to a specific classification", |
| "properties": { |
| "started": { |
| "description": "time when this classification was started", |
| "type": "string", |
| "format": "date-time", |
| "example": "2017-07-21T17:32:28Z" |
| }, |
| "completed": { |
| "description": "time when this classification finished", |
| "type": "string", |
| "format": "date-time", |
| "example": "2017-07-21T17:32:28Z" |
| }, |
| "count": { |
| "description": "number of objects which were taken into consideration for classification", |
| "type": "integer", |
| "example": 147 |
| }, |
| "countSucceeded": { |
| "description": "number of objects successfully classified", |
| "type": "integer", |
| "example": 140 |
| }, |
| "countFailed": { |
| "description": "number of objects which could not be classified - see error message for details", |
| "type": "integer", |
| "example": 7 |
| } |
| }, |
| "type": "object" |
| }, |
| "WhereFilter": { |
| "description": "Filter search results using a where filter", |
| "properties": { |
| "operands": { |
| "description": "combine multiple where filters, requires 'And' or 'Or' operator", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/WhereFilter" |
| } |
| }, |
| "operator": { |
| "description": "operator to use", |
| "type": "string", |
| "enum": [ |
| "And", |
| "Or", |
| "Equal", |
| "Like", |
| "NotEqual", |
| "GreaterThan", |
| "GreaterThanEqual", |
| "LessThan", |
| "LessThanEqual", |
| "WithinGeoRange", |
| "IsNull", |
| "ContainsAny", |
| "ContainsAll", |
| "ContainsNone", |
| "Not" |
| ], |
| "example": "GreaterThanEqual" |
| }, |
| "path": { |
| "description": "path to the property currently being filtered", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": [ |
| "inCity", |
| "City", |
| "name" |
| ] |
| }, |
| "valueInt": { |
| "description": "value as integer", |
| "type": "integer", |
| "format": "int64", |
| "example": 2000, |
| "x-nullable": true |
| }, |
| "valueNumber": { |
| "description": "value as number/float", |
| "type": "number", |
| "format": "float64", |
| "example": 3.14, |
| "x-nullable": true |
| }, |
| "valueBoolean": { |
| "description": "value as boolean", |
| "type": "boolean", |
| "example": false, |
| "x-nullable": true |
| }, |
| "valueString": { |
| "description": "value as text (deprecated as of v1.19; alias for valueText)", |
| "type": "string", |
| "example": "my search term", |
| "x-nullable": true |
| }, |
| "valueText": { |
| "description": "value as text", |
| "type": "string", |
| "example": "my search term", |
| "x-nullable": true |
| }, |
| "valueDate": { |
| "description": "value as date (as string)", |
| "type": "string", |
| "example": "TODO", |
| "x-nullable": true |
| }, |
| "valueIntArray": { |
| "description": "value as integer", |
| "type": "array", |
| "items": { |
| "type": "integer", |
| "format": "int64" |
| }, |
| "example": "[100, 200]", |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueNumberArray": { |
| "description": "value as number/float", |
| "type": "array", |
| "items": { |
| "type": "number", |
| "format": "float64" |
| }, |
| "example": [ |
| 3.14 |
| ], |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueBooleanArray": { |
| "description": "value as boolean", |
| "type": "array", |
| "items": { |
| "type": "boolean" |
| }, |
| "example": [ |
| true, |
| false |
| ], |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueStringArray": { |
| "description": "value as text (deprecated as of v1.19; alias for valueText)", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": [ |
| "my search term" |
| ], |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueTextArray": { |
| "description": "value as text", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": [ |
| "my search term" |
| ], |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueDateArray": { |
| "description": "value as date (as string)", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "example": "TODO", |
| "x-nullable": true, |
| "x-omitempty": true |
| }, |
| "valueGeoRange": { |
| "description": "value as geo coordinates and distance", |
| "type": "object", |
| "$ref": "#/definitions/WhereFilterGeoRange", |
| "x-nullable": true |
| } |
| }, |
| "type": "object" |
| }, |
| "WhereFilterGeoRange": { |
| "type": "object", |
| "description": "filter within a distance of a georange", |
| "properties": { |
| "geoCoordinates": { |
| "$ref": "#/definitions/GeoCoordinates", |
| "x-nullable": false |
| }, |
| "distance": { |
| "type": "object", |
| "properties": { |
| "max": { |
| "type": "number", |
| "format": "float64" |
| } |
| } |
| } |
| } |
| }, |
| "Tenant": { |
| "type": "object", |
| "description": "attributes representing a single tenant within weaviate", |
| "properties": { |
| "name": { |
| "description": "The name of the tenant (required).", |
| "type": "string" |
| }, |
| "activityStatus": { |
| "description": "activity status of the tenant's shard. Optional for creating tenant (implicit `ACTIVE`) and required for updating tenant. For creation, allowed values are `ACTIVE` - tenant is fully active and `INACTIVE` - tenant is inactive; no actions can be performed on tenant, tenant's files are stored locally. For updating, `ACTIVE`, `INACTIVE` and also `OFFLOADED` - as INACTIVE, but files are stored on cloud storage. The following values are read-only and are set by the server for internal use: `OFFLOADING` - tenant is transitioning from ACTIVE/INACTIVE to OFFLOADED, `ONLOADING` - tenant is transitioning from OFFLOADED to ACTIVE/INACTIVE. We still accept deprecated names `HOT` (now `ACTIVE`), `COLD` (now `INACTIVE`), `FROZEN` (now `OFFLOADED`), `FREEZING` (now `OFFLOADING`), `UNFREEZING` (now `ONLOADING`).", |
| "type": "string", |
| "enum": [ |
| "ACTIVE", |
| "INACTIVE", |
| "OFFLOADED", |
| "OFFLOADING", |
| "ONLOADING", |
| "HOT", |
| "COLD", |
| "FROZEN", |
| "FREEZING", |
| "UNFREEZING" |
| ] |
| } |
| } |
| }, |
| "Alias": { |
| "type": "object", |
| "description": "Represents the mapping between an alias name and a collection. An alias provides an alternative name for accessing a collection.", |
| "properties": { |
| "alias": { |
| "description": "The unique name of the alias that serves as an alternative identifier for the collection.", |
| "type": "string" |
| }, |
| "class": { |
| "description": "The name of the collection (class) to which this alias is mapped.", |
| "type": "string" |
| } |
| } |
| }, |
| "AliasResponse": { |
| "description": "Response object containing a list of alias mappings.", |
| "type": "object", |
| "properties": { |
| "aliases": { |
| "description": "Array of alias objects, each containing an alias-to-collection mapping.", |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Alias" |
| } |
| } |
| } |
| } |
| }, |
| "externalDocs": { |
| "url": "https://github.com/weaviate/weaviate" |
| }, |
| "info": { |
| "contact": { |
| "email": "hello@weaviate.io", |
| "name": "Weaviate", |
| "url": "https://github.com/weaviate" |
| }, |
| "description": "# Introduction\n Weaviate is an open source, AI-native vector database that helps developers create intuitive and reliable AI-powered applications. \n ### Base Path \nThe base path for the Weaviate server is structured as `[YOUR-WEAVIATE-HOST]:[PORT]/v1`. As an example, if you wish to access the `schema` endpoint on a local instance, you would navigate to `http://localhost:8080/v1/schema`. Ensure you replace `[YOUR-WEAVIATE-HOST]` and `[PORT]` with your actual server host and port number respectively. \n ### Questions? \nIf you have any comments or questions, please feel free to reach out to us at the community forum [https://forum.weaviate.io/](https://forum.weaviate.io/). \n### Issues? \nIf you find a bug or want to file a feature request, please open an issue on our GitHub repository for [Weaviate](https://github.com/weaviate/weaviate). \n### Want more documentation? \nFor a quickstart, code examples, concepts and more, please visit our [documentation page](https://weaviate.io/developers/weaviate).", |
| "title": "Weaviate", |
| "version": "1.33.0-rc.1" |
| }, |
| "parameters": { |
| "CommonAfterParameterQuery": { |
| "description": "A threshold UUID of the objects to retrieve after, using an UUID-based ordering. This object is not part of the set. <br/><br/>Must be used with `class`, typically in conjunction with `limit`. <br/><br/>Note `after` cannot be used with `offset` or `sort`. <br/><br/>For a null value similar to offset=0, set an empty string in the request, i.e. `after=` or `after`.", |
| "in": "query", |
| "name": "after", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonOffsetParameterQuery": { |
| "description": "The starting index of the result window. Note `offset` will retrieve `offset+limit` results and return `limit` results from the object with index `offset` onwards. Limited by the value of `QUERY_MAXIMUM_RESULTS`. <br/><br/>Should be used in conjunction with `limit`. <br/><br/>Cannot be used with `after`.", |
| "format": "int64", |
| "in": "query", |
| "name": "offset", |
| "required": false, |
| "type": "integer", |
| "default": 0 |
| }, |
| "CommonLimitParameterQuery": { |
| "description": "The maximum number of items to be returned per page. The default is 25 unless set otherwise as an environment variable.", |
| "format": "int64", |
| "in": "query", |
| "name": "limit", |
| "required": false, |
| "type": "integer" |
| }, |
| "CommonIncludeParameterQuery": { |
| "description": "Include additional information, such as classification infos. Allowed values include: classification, vector, interpretation", |
| "in": "query", |
| "name": "include", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonConsistencyLevelParameterQuery": { |
| "description": "Determines how many replicas must acknowledge a request before it is considered successful", |
| "in": "query", |
| "name": "consistency_level", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonTenantParameterQuery": { |
| "description": "Specifies the tenant in a request targeting a multi-tenant class", |
| "in": "query", |
| "name": "tenant", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonNodeNameParameterQuery": { |
| "description": "The target node which should fulfill the request", |
| "in": "query", |
| "name": "node_name", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonSortParameterQuery": { |
| "description": "Name(s) of the property to sort by - e.g. `city`, or `country,city`.", |
| "in": "query", |
| "name": "sort", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonOrderParameterQuery": { |
| "description": "Order parameter to tell how to order (asc or desc) data within given field. Should be used in conjunction with `sort` parameter. If providing multiple `sort` values, provide multiple `order` values in corresponding order, e.g.: `sort=author_name,title&order=desc,asc`.", |
| "in": "query", |
| "name": "order", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonClassParameterQuery": { |
| "description": "The collection from which to query objects. <br/><br/>Note that if `class` is not provided, the response will not include any objects.", |
| "in": "query", |
| "name": "class", |
| "required": false, |
| "type": "string" |
| }, |
| "CommonOutputVerbosityParameterQuery": { |
| "description": "Controls the verbosity of the output, possible values are: \"minimal\", \"verbose\". Defaults to \"minimal\".", |
| "in": "query", |
| "name": "output", |
| "required": false, |
| "type": "string", |
| "default": "minimal" |
| } |
| }, |
| "paths": { |
| "/": { |
| "get": { |
| "description": "Get links to other endpoints to help discover the REST API", |
| "summary": "List available endpoints", |
| "operationId": "weaviate.root", |
| "responses": { |
| "200": { |
| "description": "Weaviate is alive and ready to serve content", |
| "schema": { |
| "type": "object", |
| "properties": { |
| "links": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Link" |
| } |
| } |
| } |
| } |
| } |
| } |
| } |
| }, |
| "/.well-known/live": { |
| "get": { |
| "summary": "Get application liveness.", |
| "description": "Determines whether the application is alive. Can be used for kubernetes liveness probe", |
| "operationId": "weaviate.wellknown.liveness", |
| "responses": { |
| "200": { |
| "description": "The application is able to respond to HTTP requests" |
| } |
| } |
| } |
| }, |
| "/.well-known/ready": { |
| "get": { |
| "summary": "Get application readiness.", |
| "description": "Determines whether the application is ready to receive traffic. Can be used for kubernetes readiness probe.", |
| "operationId": "weaviate.wellknown.readiness", |
| "responses": { |
| "200": { |
| "description": "The application has completed its start-up routine and is ready to accept traffic." |
| }, |
| "503": { |
| "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." |
| } |
| } |
| } |
| }, |
| "/.well-known/openid-configuration": { |
| "get": { |
| "description": "OIDC Discovery page, redirects to the token issuer if one is configured", |
| "responses": { |
| "200": { |
| "description": "Successful response, inspect body", |
| "schema": { |
| "type": "object", |
| "properties": { |
| "href": { |
| "description": "The Location to redirect to", |
| "type": "string" |
| }, |
| "clientId": { |
| "description": "OAuth Client ID", |
| "type": "string" |
| }, |
| "scopes": { |
| "description": "OAuth Scopes", |
| "type": "array", |
| "items": { |
| "type": "string" |
| }, |
| "x-omitempty": true |
| } |
| } |
| } |
| }, |
| "404": { |
| "description": "Not found, no oidc provider present" |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "OIDC discovery information if OIDC auth is enabled", |
| "tags": [ |
| "well-known", |
| "oidc", |
| "discovery" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/replication/replicate": { |
| "post": { |
| "summary": "Initiate a replica movement", |
| "description": "Begins an asynchronous operation to move or copy a specific shard replica from its current node to a designated target node. The operation involves copying data, synchronizing, and potentially decommissioning the source replica.", |
| "operationId": "replicate", |
| "x-serviceIds": [ |
| "weaviate.replication.replicate" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/ReplicationReplicateReplicaRequest" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Replication operation registered successfully. ID of the operation is returned.", |
| "schema": { |
| "$ref": "#/definitions/ReplicationReplicateReplicaResponse" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Schedules all replication operations for deletion across all collections, shards, and nodes.", |
| "operationId": "deleteAllReplications", |
| "x-serviceIds": [ |
| "weaviate.replication.deleteAllReplications" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "responses": { |
| "204": { |
| "description": "Replication operation registered successfully" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/replication/replicate/force-delete": { |
| "post": { |
| "summary": "Force delete replication operations", |
| "description": "USE AT OWN RISK! Synchronously force delete operations from the FSM. This will not perform any checks on which state the operation is in so may lead to data corruption or loss. It is recommended to first scale the number of replication engine workers to 0 before calling this endpoint to ensure no operations are in-flight.", |
| "operationId": "forceDeleteReplications", |
| "x-serviceIds": [ |
| "weaviate.replication.forceDeleteReplications" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "body", |
| "in": "body", |
| "schema": { |
| "$ref": "#/definitions/ReplicationReplicateForceDeleteRequest" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Replication operations force deleted successfully.", |
| "schema": { |
| "$ref": "#/definitions/ReplicationReplicateForceDeleteResponse" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/replication/replicate/{id}": { |
| "get": { |
| "summary": "Retrieve a replication operation", |
| "description": "Fetches the current status and detailed information for a specific replication operation, identified by its unique ID. Optionally includes historical data of the operation's progress if requested.", |
| "operationId": "replicationDetails", |
| "x-serviceIds": [ |
| "weaviate.replication.replicate.details" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "id", |
| "in": "path", |
| "format": "uuid", |
| "description": "The ID of the replication operation to get details for.", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "includeHistory", |
| "in": "query", |
| "description": "Whether to include the history of the replication operation.", |
| "required": false, |
| "type": "boolean" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "The details of the replication operation.", |
| "schema": { |
| "$ref": "#/definitions/ReplicationReplicateDetailsReplicaResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Shard replica operation not found." |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Delete a replication operation", |
| "description": "Removes a specific replication operation. If the operation is currently active, it will be cancelled and its resources cleaned up before the operation is deleted.", |
| "operationId": "deleteReplication", |
| "x-serviceIds": [ |
| "weaviate.replication.replicate.delete" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "id", |
| "in": "path", |
| "format": "uuid", |
| "description": "The ID of the replication operation to delete.", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Shard replica operation not found." |
| }, |
| "409": { |
| "description": "The operation is not in a deletable state, e.g. it is a MOVE op in the DEHYDRATING state.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/replication/replicate/list": { |
| "get": { |
| "summary": "List replication operations", |
| "description": "Retrieves a list of currently registered replication operations, optionally filtered by collection, shard, or node ID.", |
| "operationId": "listReplication", |
| "x-serviceIds": [ |
| "weaviate.replication.replicate.details" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "targetNode", |
| "in": "query", |
| "description": "The name of the target node to get details for.", |
| "required": false, |
| "type": "string" |
| }, |
| { |
| "name": "collection", |
| "in": "query", |
| "description": "The name of the collection to get details for.", |
| "required": false, |
| "type": "string" |
| }, |
| { |
| "name": "shard", |
| "in": "query", |
| "description": "The shard to get details for.", |
| "required": false, |
| "type": "string" |
| }, |
| { |
| "name": "includeHistory", |
| "in": "query", |
| "description": "Whether to include the history of the replication operation.", |
| "required": false, |
| "type": "boolean" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "The details of the replication operations.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "$ref": "#/definitions/ReplicationReplicateDetailsReplicaResponse" |
| } |
| } |
| }, |
| "400": { |
| "description": "Bad request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/replication/replicate/{id}/cancel": { |
| "post": { |
| "summary": "Cancel a replication operation", |
| "description": "Requests the cancellation of an active replication operation identified by its ID. The operation will be stopped, but its record will remain in the 'CANCELLED' state (can't be resumed) and will not be automatically deleted.", |
| "operationId": "cancelReplication", |
| "x-serviceIds": [ |
| "weaviate.replication.replicate.cancel" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "id", |
| "in": "path", |
| "format": "uuid", |
| "description": "The ID of the replication operation to cancel.", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully cancelled." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Shard replica operation not found." |
| }, |
| "409": { |
| "description": "The operation is not in a cancellable state, e.g. it is READY or is a MOVE op in the DEHYDRATING state.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/replication/sharding-state": { |
| "get": { |
| "summary": "Get sharding state", |
| "description": "Fetches the current sharding state, including replica locations and statuses, for all collections or a specified collection. If a shard name is provided along with a collection, the state for that specific shard is returned.", |
| "operationId": "getCollectionShardingState", |
| "x-serviceIds": [ |
| "weaviate.replication.shardingstate.collection.get" |
| ], |
| "tags": [ |
| "replication" |
| ], |
| "parameters": [ |
| { |
| "name": "collection", |
| "in": "query", |
| "description": "The collection name to get the sharding state for.", |
| "required": false, |
| "type": "string" |
| }, |
| { |
| "name": "shard", |
| "in": "query", |
| "description": "The shard to get the sharding state for.", |
| "required": false, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully retrieved sharding state.", |
| "schema": { |
| "$ref": "#/definitions/ReplicationShardingStateResponse" |
| } |
| }, |
| "400": { |
| "description": "Bad request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Collection or shard not found.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/own-info": { |
| "get": { |
| "summary": "get info relevant to own user, e.g. username, roles", |
| "operationId": "getOwnInfo", |
| "x-serviceIds": [ |
| "weaviate.users.get.own-info" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "responses": { |
| "200": { |
| "description": "Info about the user", |
| "schema": { |
| "$ref": "#/definitions/UserOwnInfo" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "501": { |
| "description": "Replica movement operations are disabled.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/db": { |
| "get": { |
| "summary": "list all db users", |
| "operationId": "listAllUsers", |
| "x-serviceIds": [ |
| "weaviate.users.db.list_all" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "Whether to include the last used time of the users", |
| "in": "query", |
| "name": "includeLastUsedTime", |
| "required": false, |
| "type": "boolean", |
| "default": false |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Info about the users", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/DBUserInfo" |
| } |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/db/{user_id}": { |
| "get": { |
| "summary": "get info relevant to user, e.g. username, roles", |
| "operationId": "getUserInfo", |
| "x-serviceIds": [ |
| "weaviate.users.db.get" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user id", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Whether to include the last used time of the given user", |
| "in": "query", |
| "name": "includeLastUsedTime", |
| "required": false, |
| "type": "boolean", |
| "default": false |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Info about the user", |
| "schema": { |
| "$ref": "#/definitions/DBUserInfo" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "post": { |
| "summary": "create new user", |
| "operationId": "createUser", |
| "x-serviceIds": [ |
| "weaviate.users.db.create" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user id", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": false, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "import": { |
| "type":"boolean", |
| "description": "EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - import api key from static user", |
| "default": false |
| }, |
| "createTime": { |
| "type":"string", |
| "format": "date-time", |
| "description": "EXPERIMENTAL, DONT USE. THIS WILL BE REMOVED AGAIN. - set the given time as creation time" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "201": { |
| "description": "User created successfully", |
| "schema": { |
| "$ref": "#/definitions/UserApiKey" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "409": { |
| "description": "User already exists", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Delete User", |
| "operationId": "deleteUser", |
| "x-serviceIds": [ |
| "weaviate.users.db.delete" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user name", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/db/{user_id}/rotate-key": { |
| "post": { |
| "summary": "rotate user api key", |
| "operationId": "rotateUserApiKey", |
| "x-serviceIds": [ |
| "weaviate.users.db.rotateApiKey" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user id", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "ApiKey successfully changed", |
| "schema": { |
| "$ref": "#/definitions/UserApiKey" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/db/{user_id}/activate": { |
| "post": { |
| "summary": "activate a deactivated user", |
| "operationId": "activateUser", |
| "x-serviceIds": [ |
| "weaviate.users.db.activateUser" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user id", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "User successfully activated" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found" |
| }, |
| "409": { |
| "description": "user already activated" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/users/db/{user_id}/deactivate": { |
| "post": { |
| "summary": "deactivate a user", |
| "operationId": "deactivateUser", |
| "x-serviceIds": [ |
| "weaviate.users.db.deactivateUser" |
| ], |
| "tags": [ |
| "users" |
| ], |
| "parameters": [ |
| { |
| "description": "user id", |
| "in": "path", |
| "name": "user_id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": false, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "revoke_key": { |
| "type": "boolean", |
| "description": "if the key should be revoked when deactivating the user", |
| "default": false |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "users successfully deactivated" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "user not found" |
| }, |
| "409": { |
| "description": "user already deactivated" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles": { |
| "get": { |
| "summary": "Get all roles", |
| "operationId": "getRoles", |
| "x-serviceIds": [ |
| "weaviate.authz.get.roles" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response.", |
| "schema": { |
| "$ref": "#/definitions/RolesListResponse" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "post": { |
| "summary": "create new role", |
| "operationId": "createRole", |
| "x-serviceIds": [ |
| "weaviate.authz.create.role" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Role" |
| } |
| } |
| ], |
| "responses": { |
| "201": { |
| "description": "Role created successfully" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "409": { |
| "description": "Role already exists", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/add-permissions": { |
| "post": { |
| "summary": "Add permission to a given role.", |
| "operationId": "addPermissions", |
| "x-serviceIds": [ |
| "weaviate.authz.add.role.permissions" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "permissions": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Permission" |
| }, |
| "description": "permissions to be added to the role" |
| } |
| }, |
| "required": [ |
| "name", |
| "permissions" |
| ] |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Permissions added successfully" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/remove-permissions": { |
| "post": { |
| "summary": "Remove permissions from a role. If this results in an empty role, the role will be deleted.", |
| "operationId": "removePermissions", |
| "x-serviceIds": [ |
| "weaviate.authz.remove.role.permissions" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "permissions": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Permission" |
| }, |
| "description": "permissions to remove from the role" |
| } |
| }, |
| "required": [ |
| "permissions" |
| ] |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Permissions removed successfully" |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}": { |
| "get": { |
| "summary": "Get a role", |
| "operationId": "getRole", |
| "x-serviceIds": [ |
| "weaviate.authz.get.role" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response.", |
| "schema": { |
| "$ref": "#/definitions/Role" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found" |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Delete role", |
| "operationId": "deleteRole", |
| "x-serviceIds": [ |
| "weaviate.authz.delete.role" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/has-permission": { |
| "post": { |
| "summary": "Check whether role possesses this permission.", |
| "operationId": "hasPermission", |
| "x-serviceIds": [ |
| "weaviate.authz.has.role.permission" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Permission" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Permission check was successful", |
| "schema": { |
| "type": "boolean" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/users": { |
| "get": { |
| "deprecated": true, |
| "summary": "get users (db + OIDC) assigned to role. Deprecated, will be removed when 1.29 is not supported anymore", |
| "operationId": "getUsersForRoleDeprecated", |
| "x-serviceIds": [ |
| "weaviate.authz.get.roles.users" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Users assigned to this role", |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found" |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/user-assignments": { |
| "get": { |
| "summary": "get users assigned to role", |
| "operationId": "getUsersForRole", |
| "x-serviceIds": [ |
| "weaviate.authz.get.roles.users" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "role name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Users assigned to this role", |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "userId": { |
| "type": "string" |
| }, |
| "userType": { |
| "$ref": "#/definitions/UserTypeOutput" |
| } |
| }, |
| "required": [ |
| "name", |
| "userType" |
| ] |
| } |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found" |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/roles/{id}/group-assignments": { |
| "get": { |
| "summary": "Get groups that have a specific role assigned", |
| "description": "Retrieves a list of all groups that have been assigned a specific role, identified by its name.", |
| "operationId": "getGroupsForRole", |
| "x-serviceIds": [ |
| "weaviate.authz.get.roles.groups" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "The unique name of the role.", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully retrieved the list of groups that have the role assigned.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "object", |
| "properties": { |
| "groupId": { |
| "type": "string" |
| }, |
| "groupType": { |
| "$ref": "#/definitions/GroupType" |
| } |
| }, |
| "required": [ |
| "name", |
| "groupType" |
| ] |
| } |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "The specified role was not found." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/users/{id}/roles": { |
| "get": { |
| "deprecated": true, |
| "summary": "get roles assigned to user (DB + OIDC). Deprecated, will be removed when 1.29 is not supported anymore", |
| "operationId": "getRolesForUserDeprecated", |
| "x-serviceIds": [ |
| "weaviate.authz.get.users.roles" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "user name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role assigned users", |
| "schema": { |
| "$ref": "#/definitions/RolesListResponse" |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found for user" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/users/{id}/roles/{userType}": { |
| "get": { |
| "summary": "get roles assigned to user", |
| "operationId": "getRolesForUser", |
| "x-serviceIds": [ |
| "weaviate.authz.get.users.roles" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "user name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "path", |
| "name": "userType", |
| "required": true, |
| "type": "string", |
| "enum": [ |
| "oidc", |
| "db" |
| ], |
| "description": "The type of user" |
| }, |
| { |
| "in": "query", |
| "name": "includeFullRoles", |
| "required": false, |
| "type": "boolean", |
| "default": false, |
| "description": "Whether to include detailed role information needed the roles permission" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role assigned users", |
| "schema": { |
| "$ref": "#/definitions/RolesListResponse" |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "no role found for user" |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/users/{id}/assign": { |
| "post": { |
| "summary": "Assign a role to a user", |
| "operationId": "assignRoleToUser", |
| "x-serviceIds": [ |
| "weaviate.authz.assign.role.user" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "user name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "roles": { |
| "type": "array", |
| "description": "the roles that assigned to user", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "userType": { |
| "$ref": "#/definitions/UserTypeInput" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role assigned successfully" |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "role or user is not found.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/users/{id}/revoke": { |
| "post": { |
| "summary": "Revoke a role from a user", |
| "operationId": "revokeRoleFromUser", |
| "x-serviceIds": [ |
| "weaviate.authz.revoke.role.user" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "user name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "roles": { |
| "type": "array", |
| "description": "the roles that revoked from the key or user", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "userType": { |
| "$ref": "#/definitions/UserTypeInput" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role revoked successfully" |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "role or user is not found.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/groups/{id}/assign": { |
| "post": { |
| "summary": "Assign a role to a group", |
| "operationId": "assignRoleToGroup", |
| "x-serviceIds": [ |
| "weaviate.authz.assign.role" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "group name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "roles": { |
| "type": "array", |
| "description": "the roles that assigned to group", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "groupType": { |
| "$ref": "#/definitions/GroupType" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role assigned successfully" |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "role or group is not found." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/groups/{id}/revoke": { |
| "post": { |
| "summary": "Revoke a role from a group", |
| "operationId": "revokeRoleFromGroup", |
| "x-serviceIds": [ |
| "weaviate.authz.revoke.role.group" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "group name", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "roles": { |
| "type": "array", |
| "description": "the roles that revoked from group", |
| "items": { |
| "type": "string" |
| } |
| }, |
| "groupType": { |
| "$ref": "#/definitions/GroupType" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Role revoked successfully" |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "role or group is not found." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/groups/{id}/roles/{groupType}": { |
| "get": { |
| "summary": "Get roles assigned to a specific group", |
| "description": "Retrieves a list of all roles assigned to a specific group. The group must be identified by both its name (`id`) and its type (`db` or `oidc`).", |
| "operationId": "getRolesForGroup", |
| "x-serviceIds": [ |
| "weaviate.authz.get.groups.roles" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "description": "The unique name of the group.", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "path", |
| "name": "groupType", |
| "required": true, |
| "type": "string", |
| "enum": [ |
| "oidc" |
| ], |
| "description": "The type of the group." |
| }, |
| { |
| "in": "query", |
| "name": "includeFullRoles", |
| "required": false, |
| "type": "boolean", |
| "default": false, |
| "description": "If true, the response will include the full role definitions with all associated permissions. If false, only role names are returned." |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "A list of roles assigned to the specified group.", |
| "schema": { |
| "$ref": "#/definitions/RolesListResponse" |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "The specified group was not found." |
| }, |
| "422": { |
| "description": "The request syntax is correct, but the server couldn't process it due to semantic issues.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/authz/groups/{groupType}": { |
| "get": { |
| "summary": "List all groups of a specific type", |
| "description": "Retrieves a list of all available group names for a specified group type (`oidc` or `db`).", |
| "operationId": "getGroups", |
| "x-serviceIds": [ |
| "weaviate.authz.get.groups" |
| ], |
| "tags": [ |
| "authz" |
| ], |
| "parameters": [ |
| { |
| "in": "path", |
| "name": "groupType", |
| "required": true, |
| "type": "string", |
| "enum": [ |
| "oidc" |
| ], |
| "description": "The type of group to retrieve." |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "A list of group names for the specified type.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| }, |
| "400": { |
| "description": "Bad request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "The request syntax is correct, but the server couldn't process it due to semantic issues.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/objects": { |
| "get": { |
| "description": "Lists all Objects in reverse order of creation, owned by the user that belongs to the used token.", |
| "operationId": "objects.list", |
| "x-serviceIds": [ |
| "weaviate.local.query" |
| ], |
| "parameters": [ |
| { |
| "$ref": "#/parameters/CommonAfterParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonOffsetParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonLimitParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonIncludeParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonSortParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonOrderParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonClassParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response. <br/><br/>If `class` is not provided, the response will not include any objects.", |
| "schema": { |
| "$ref": "#/definitions/ObjectsListResponse" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Get a list of Objects.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "post": { |
| "description": "Create a new object. <br/><br/>Meta-data and schema values are validated. <br/><br/>**Note: Use `/batch` for importing many objects**: <br/>If you plan on importing a large number of objects, it's much more efficient to use the `/batch` endpoint. Otherwise, sending multiple single requests sequentially would incur a large performance penalty. <br/><br/>**Note: idempotence of `/objects`**: <br/>POST /objects will fail if an id is provided which already exists in the class. To update an existing object with the objects endpoint, use the PUT or PATCH method.", |
| "operationId": "objects.create", |
| "x-serviceIds": [ |
| "weaviate.local.add" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Object created.", |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Create a new object.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/objects/{id}": { |
| "delete": { |
| "description": "Deletes an object from the database based on its UUID. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead.", |
| "operationId": "objects.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Delete an Object based on its UUID.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": true, |
| "x-available-in-websocket": true, |
| "deprecated": true |
| }, |
| "get": { |
| "description": "Get a specific object based on its UUID. Also available as Websocket bus. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead.", |
| "operationId": "objects.get", |
| "x-serviceIds": [ |
| "weaviate.local.query" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonIncludeParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response.", |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Get a specific Object based on its UUID.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| }, |
| "patch": { |
| "description": "Update an object based on its UUID (using patch semantics). 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. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead.", |
| "operationId": "objects.patch", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "RFC 7396-style patch, the body contains the object to merge into the existing object.", |
| "in": "body", |
| "name": "body", |
| "required": false, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully applied. No content provided." |
| }, |
| "400": { |
| "description": "The patch-JSON is malformed." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "The patch-JSON is valid but unprocessable.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Update an Object based on its UUID (using patch semantics).", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| }, |
| "put": { |
| "description": "Updates an object based on its UUID. Given meta-data and schema values are validated. LastUpdateTime is set to the time this function is called. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead.", |
| "operationId": "objects.update", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully received.", |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Update an Object based on its UUID.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| }, |
| "head": { |
| "description": "Checks if an object exists in the system based on its UUID. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}` endpoint instead.", |
| "operationId": "objects.head", |
| "x-serviceIds": [ |
| "weaviate.objects.check" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Object exists." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Object doesn't exist." |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Checks Object's existence based on its UUID.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": true, |
| "x-available-in-websocket": true, |
| "deprecated": true |
| } |
| }, |
| "/objects/{className}/{id}": { |
| "get": { |
| "description": "Get a data object based on its collection and UUID.", |
| "operationId": "objects.class.get", |
| "x-serviceIds": [ |
| "weaviate.local.query" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonIncludeParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonNodeNameParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response.", |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "Request is well-formed (i.e., syntactically correct), but erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Get a specific Object based on its class and UUID. Also available as Websocket bus.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "delete": { |
| "description": "Delete an object based on its collection and UUID. <br/><br/>Note: For backward compatibility, beacons also support an older, deprecated format without the collection name. As a result, when deleting a reference, the beacon specified has to match the beacon to be deleted exactly. In other words, if a beacon is present using the old format (without collection name) you also need to specify it the same way. <br/><br/>In the beacon format, you need to always use `localhost` as the host, rather than the actual hostname. `localhost` here refers to the fact that the beacon's target is on the same Weaviate instance, as opposed to a foreign instance.", |
| "operationId": "objects.class.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "Request is well-formed (i.e., syntactically correct), but erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Delete object based on its class and UUID.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": true, |
| "x-available-in-websocket": true |
| }, |
| "put": { |
| "description": "Update an object based on its uuid and collection. This (`put`) method replaces the object with the provided object.", |
| "operationId": "objects.class.put", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "The uuid of the data object to update.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully received.", |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Update a class object based on its uuid", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "patch": { |
| "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.", |
| "operationId": "objects.class.patch", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "The class name as defined in the schema", |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "The uuid of the data object to update.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "RFC 7396-style patch, the body contains the object to merge into the existing object.", |
| "in": "body", |
| "name": "body", |
| "required": false, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully applied. No content provided." |
| }, |
| "400": { |
| "description": "The patch-JSON is malformed.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found." |
| }, |
| "422": { |
| "description": "The patch-JSON is valid but unprocessable.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Update an Object based on its UUID (using patch semantics).", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "head": { |
| "description": "Checks if a data object exists based on its collection and uuid without retrieving it. <br/><br/>Internally it skips reading the object from disk other than checking if it is present. Thus it does not use resources on marshalling, parsing, etc., and is faster. Note the resulting HTTP request has no body; the existence of an object is indicated solely by the status code.", |
| "operationId": "objects.class.head", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "The class name as defined in the schema", |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "The uuid of the data object", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Object exists." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Object doesn't exist." |
| }, |
| "422": { |
| "description": "Request is well-formed (i.e., syntactically correct), but erroneous.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Checks object's existence based on its class and uuid.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": true, |
| "x-available-in-websocket": true |
| } |
| }, |
| "/objects/{id}/references/{propertyName}": { |
| "post": { |
| "description": "Add a cross-reference. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead.", |
| "operationId": "objects.references.create", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/SingleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully added the reference." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "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?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Add a single reference to a class-property.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| }, |
| "put": { |
| "description": "Replace all references in cross-reference property of an object. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead.", |
| "operationId": "objects.references.update", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/MultipleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully replaced all the references." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "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?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Replace all references to a class-property.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| }, |
| "delete": { |
| "description": "Delete the single reference that is given in the body from the list of references that this property has. <br/><br/>**Note**: This endpoint is deprecated and will be removed in a future version. Use the `/objects/{className}/{id}/references/{propertyName}` endpoint instead.", |
| "operationId": "objects.references.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/SingleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Delete a single reference from the list of references.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false, |
| "deprecated": true |
| } |
| }, |
| "/objects/{className}/{id}/references/{propertyName}": { |
| "post": { |
| "description": "Add a single reference to an object. This adds a reference to the array of cross-references of the given property in the source object specified by its collection name and id", |
| "operationId": "objects.class.references.create", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "The class name as defined in the schema", |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/SingleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully added the reference." |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Source object doesn't exist." |
| }, |
| "422": { |
| "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?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Add a single reference to a class-property.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "put": { |
| "description": "Replace **all** references in cross-reference property of an object.", |
| "operationId": "objects.class.references.put", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "The class name as defined in the schema", |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/MultipleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully replaced all the references." |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Source object doesn't exist." |
| }, |
| "422": { |
| "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?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Replace all references to a class-property.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "delete": { |
| "description": "Delete the single reference that is given in the body from the list of references that this property has.", |
| "operationId": "objects.class.references.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "description": "The class name as defined in the schema", |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique ID of the Object.", |
| "format": "uuid", |
| "in": "path", |
| "name": "id", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "description": "Unique name of the property related to the Object.", |
| "in": "path", |
| "name": "propertyName", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/SingleRef" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Successful query result but no resource was found.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "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?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Delete a single reference from the list of references.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/objects/validate": { |
| "post": { |
| "description": "Validate an object's schema and meta-data without creating it. <br/><br/>If the schema of the object is valid, the request should return nothing with a plain RESTful request. Otherwise, an error object will be returned.", |
| "operationId": "objects.validate", |
| "x-serviceIds": [ |
| "weaviate.local.query.meta" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Object" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully validated." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Validate an Object based on a schema.", |
| "tags": [ |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/batch/objects": { |
| "post": { |
| "description": "Create new objects in bulk. <br/><br/>Meta-data and schema values are validated. <br/><br/>**Note: idempotence of `/batch/objects`**: <br/>`POST /batch/objects` is idempotent, and will overwrite any existing object given the same id.", |
| "operationId": "batch.objects.create", |
| "x-serviceIds": [ |
| "weaviate.local.add" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "fields": { |
| "description": "Define which fields need to be returned. Default value is ALL", |
| "type": "array", |
| "items": { |
| "type": "string", |
| "default": "ALL", |
| "enum": [ |
| "ALL", |
| "class", |
| "schema", |
| "id", |
| "creationTimeUnix" |
| ] |
| } |
| }, |
| "objects": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Object" |
| } |
| } |
| } |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Request succeeded, see response body to get detailed information about each batched item.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/ObjectsGetResponse" |
| } |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Creates new Objects based on a Object template as a batch.", |
| "tags": [ |
| "batch", |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| }, |
| "delete": { |
| "description": "Batch delete objects that match a particular filter. <br/><br/>The request body takes a single `where` filter and will delete all objects matched. <br/><br/>Note that there is a limit to the number of objects to be deleted at once using this filter, in order to protect against unexpected memory surges and very-long-running requests. The default limit is 10,000 and may be configured by setting the `QUERY_MAXIMUM_RESULTS` environment variable. <br/><br/>Objects are deleted in the same order that they would be returned in an equivalent Get query. To delete more objects than the limit, run the same query multiple times.", |
| "operationId": "batch.objects.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/BatchDelete" |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| }, |
| { |
| "$ref": "#/parameters/CommonTenantParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Request succeeded, see response body to get detailed information about each batched item.", |
| "schema": { |
| "$ref": "#/definitions/BatchDeleteResponse" |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Deletes Objects based on a match filter as a batch.", |
| "tags": [ |
| "batch", |
| "objects" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/batch/references": { |
| "post": { |
| "description": "Batch create cross-references between collections items (objects or objects) in bulk.", |
| "operationId": "batch.references.create", |
| "x-serviceIds": [ |
| "weaviate.local.add" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "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", |
| "required": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/BatchReference" |
| } |
| } |
| }, |
| { |
| "$ref": "#/parameters/CommonConsistencyLevelParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "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.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/BatchReferenceResponse" |
| } |
| } |
| }, |
| "400": { |
| "description": "Malformed request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Creates new Cross-References between arbitrary classes in bulk.", |
| "tags": [ |
| "batch", |
| "references" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/graphql": { |
| "post": { |
| "description": "Get a response based on a GraphQL query", |
| "operationId": "graphql.post", |
| "x-serviceIds": [ |
| "weaviate.local.query", |
| "weaviate.local.query.meta", |
| "weaviate.network.query", |
| "weaviate.network.query.meta" |
| ], |
| "parameters": [ |
| { |
| "description": "The GraphQL query request parameters.", |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/GraphQLQuery" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful query (with select).", |
| "schema": { |
| "$ref": "#/definitions/GraphQLResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Get a response based on GraphQL", |
| "tags": [ |
| "graphql" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/graphql/batch": { |
| "post": { |
| "description": "Perform a batched GraphQL query", |
| "operationId": "graphql.batch", |
| "x-serviceIds": [ |
| "weaviate.local.query", |
| "weaviate.local.query.meta", |
| "weaviate.network.query", |
| "weaviate.network.query.meta" |
| ], |
| "parameters": [ |
| { |
| "description": "The GraphQL queries.", |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/GraphQLQueries" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful query (with select).", |
| "schema": { |
| "$ref": "#/definitions/GraphQLResponses" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Request body is well-formed (i.e., syntactically correct), but semantically erroneous. Are you sure the class is defined in the configuration file?", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Get a response based on GraphQL.", |
| "tags": [ |
| "graphql" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/meta": { |
| "get": { |
| "description": "Returns meta information about the server. Can be used to provide information to another Weaviate instance that wants to interact with the current instance.", |
| "operationId": "meta.get", |
| "x-serviceIds": [ |
| "weaviate.local.query.meta" |
| ], |
| "responses": { |
| "200": { |
| "description": "Successful response.", |
| "schema": { |
| "$ref": "#/definitions/Meta" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Returns meta information of the current Weaviate instance.", |
| "tags": [ |
| "meta" |
| ], |
| "x-available-in-mqtt": false, |
| "x-available-in-websocket": false |
| } |
| }, |
| "/schema": { |
| "get": { |
| "summary": "Dump the current the database schema.", |
| "description": "Fetch an array of all collection definitions from the schema.", |
| "operationId": "schema.dump", |
| "x-serviceIds": [ |
| "weaviate.local.query.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "consistency", |
| "in": "header", |
| "required": false, |
| "default": true, |
| "type": "boolean", |
| "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully dumped the database schema.", |
| "schema": { |
| "$ref": "#/definitions/Schema" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "post": { |
| "summary": "Create a new Object class in the schema.", |
| "description": "Create a new data object collection. <br/><br/>If AutoSchema is enabled, Weaviate will attempt to infer the schema from the data at import time. However, manual schema definition is recommended for production environments.", |
| "operationId": "schema.objects.create", |
| "x-serviceIds": [ |
| "weaviate.local.add.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "objectClass", |
| "in": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Class" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Added the new Object class to the schema.", |
| "schema": { |
| "$ref": "#/definitions/Class" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid Object class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}": { |
| "get": { |
| "summary": "Get a single class from the schema", |
| "operationId": "schema.objects.get", |
| "x-serviceIds": [ |
| "weaviate.local.get.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "consistency", |
| "in": "header", |
| "required": false, |
| "default": true, |
| "type": "boolean", |
| "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Found the Class, returned as body", |
| "schema": { |
| "$ref": "#/definitions/Class" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "This class does not exist" |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Remove an Object class (and all data in the instances) from the schema.", |
| "description": "Remove a collection from the schema. This will also delete all the objects in the collection.", |
| "operationId": "schema.objects.delete", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Removed the Object class from the schema." |
| }, |
| "400": { |
| "description": "Could not delete the Object class.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "put": { |
| "summary": "Update settings of an existing schema class", |
| "description": "Add a property to an existing collection.", |
| "operationId": "schema.objects.update", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "objectClass", |
| "in": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Class" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Class was updated successfully", |
| "schema": { |
| "$ref": "#/definitions/Class" |
| } |
| }, |
| "422": { |
| "description": "Invalid update attempt", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Class to be updated does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}/properties": { |
| "post": { |
| "summary": "Add a property to an Object class.", |
| "operationId": "schema.objects.properties.add", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "body", |
| "in": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Property" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Added the property.", |
| "schema": { |
| "$ref": "#/definitions/Property" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid property.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}/shards": { |
| "get": { |
| "summary": "Get the shards status of an Object class", |
| "description": "Get the status of every shard in the cluster.", |
| "operationId": "schema.objects.shards.get", |
| "x-serviceIds": [ |
| "weaviate.local.get.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "tenant", |
| "in": "query", |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Found the status of the shards, returned as body", |
| "schema": { |
| "$ref": "#/definitions/ShardStatusList" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "This class does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}/shards/{shardName}": { |
| "put": { |
| "summary": "Update a shard status.", |
| "description": "Update a shard status for a collection. For example, a shard may have been marked as `READONLY` because its disk was full. After providing more disk space, use this endpoint to set the shard status to `READY` again. There is also a convenience function in each client to set the status of all shards of a collection.", |
| "operationId": "schema.objects.shards.update", |
| "x-serviceIds": [ |
| "weaviate.local.manipulate.meta" |
| ], |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "shardName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/ShardStatus" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Shard status was updated successfully", |
| "schema": { |
| "$ref": "#/definitions/ShardStatus" |
| } |
| }, |
| "422": { |
| "description": "Invalid update attempt", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Shard to be updated does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}/tenants": { |
| "post": { |
| "summary": "Create a new tenant", |
| "description": "Create a new tenant for a collection. Multi-tenancy must be enabled in the collection definition.", |
| "operationId": "tenants.create", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Tenant" |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Added new tenants to the specified class", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Tenant" |
| } |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid Tenant class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "put": { |
| "summary": "Update a tenant.", |
| "description": "Update tenant of a specific class", |
| "operationId": "tenants.update", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Tenant" |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Updated tenants of the specified class", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Tenant" |
| } |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid Tenant class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "description": "delete tenants from a specific class", |
| "operationId": "tenants.delete", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "tenants", |
| "required": true, |
| "schema": { |
| "type": "array", |
| "items": { |
| "type": "string" |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Deleted tenants from specified class." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid Tenant class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "get": { |
| "summary": "Get the list of tenants.", |
| "description": "get all tenants from a specific class", |
| "operationId": "tenants.get", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "consistency", |
| "in": "header", |
| "required": false, |
| "default": true, |
| "type": "boolean", |
| "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "tenants from specified class.", |
| "schema": { |
| "type": "array", |
| "items": { |
| "$ref": "#/definitions/Tenant" |
| } |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid Tenant class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/schema/{className}/tenants/{tenantName}": { |
| "head": { |
| "summary": "Check whether a tenant exists", |
| "description": "Check if a tenant exists for a specific class", |
| "operationId": "tenant.exists", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "tenantName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "consistency", |
| "in": "header", |
| "required": false, |
| "default": true, |
| "type": "boolean", |
| "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "The tenant exists in the specified class" |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "The tenant not found" |
| }, |
| "422": { |
| "description": "Invalid Tenant class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "get": { |
| "summary": "Get a specific tenant", |
| "description": "get a specific tenant for the given class", |
| "operationId": "tenants.get.one", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "tenantName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "consistency", |
| "in": "header", |
| "required": false, |
| "default": true, |
| "type": "boolean", |
| "description": "If consistency is true, the request will be proxied to the leader to ensure strong schema consistency" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "load the tenant given the specified class", |
| "schema": { |
| "$ref": "#/definitions/Tenant" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Tenant not found" |
| }, |
| "422": { |
| "description": "Invalid tenant or class", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/aliases": { |
| "get": { |
| "summary": "List aliases", |
| "description": "Retrieve a list of all aliases in the system. Results can be filtered by specifying a collection (class) name to get aliases for a specific collection only.", |
| "operationId": "aliases.get", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "class", |
| "description": "Optional filter to retrieve aliases for a specific collection (class) only. If not provided, returns all aliases.", |
| "in": "query", |
| "required": false, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully retrieved the list of aliases", |
| "schema": { |
| "$ref": "#/definitions/AliasResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid collection (class) parameter provided", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "post": { |
| "summary": "Create a new alias", |
| "description": "Create a new alias mapping between an alias name and a collection (class). The alias acts as an alternative name for accessing the collection.", |
| "operationId": "aliases.create", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/Alias" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully created a new alias for the specified collection (class)", |
| "schema": { |
| "$ref": "#/definitions/Alias" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid create alias request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/aliases/{aliasName}": { |
| "get": { |
| "summary": "Get an alias", |
| "description": "Retrieve details about a specific alias by its name, including which collection (class) it points to.", |
| "operationId": "aliases.get.alias", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "aliasName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully retrieved the alias details.", |
| "schema": { |
| "$ref": "#/definitions/Alias" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Alias does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid alias name provided.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "put": { |
| "summary": "Update an alias", |
| "description": "Update an existing alias to point to a different collection (class). This allows you to redirect an alias from one collection to another without changing the alias name.", |
| "operationId": "aliases.update", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "aliasName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "type": "object", |
| "properties": { |
| "class": { |
| "description": "The new collection (class) that the alias should point to.", |
| "type": "string" |
| } |
| } |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Successfully updated the alias to point to the new collection (class).", |
| "schema": { |
| "$ref": "#/definitions/Alias" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Alias does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid update alias request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Delete an alias", |
| "description": "Remove an existing alias from the system. This will delete the alias mapping but will not affect the underlying collection (class).", |
| "operationId": "aliases.delete", |
| "tags": [ |
| "schema" |
| ], |
| "parameters": [ |
| { |
| "name": "aliasName", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted the alias." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Alias does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid delete alias request.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/backups/{backend}": { |
| "post": { |
| "summary": "Start a backup process", |
| "description": "Start creating a backup for a set of collections. <br/><br/>Notes: <br/>- Weaviate uses gzip compression by default. <br/>- Weaviate stays usable while a backup process is ongoing.", |
| "operationId": "backups.create", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. `filesystem`, `gcs`, `s3`, `azure`." |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/BackupCreateRequest" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Backup create process successfully started.", |
| "schema": { |
| "$ref": "#/definitions/BackupCreateResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup creation attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "get": { |
| "summary": "List backups in progress", |
| "description": "[Coming soon] List all backups in progress not implemented yet.", |
| "operationId": "backups.list", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. filesystem, gcs, s3." |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Existed backups", |
| "schema": { |
| "$ref": "#/definitions/BackupListResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup list.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/backups/{backend}/{id}": { |
| "get": { |
| "summary": "Get backup process status", |
| "description": "Returns status of backup creation attempt for a set of collections. <br/><br/>All client implementations have a `wait for completion` option which will poll the backup status in the background and only return once the backup has completed (successfully or unsuccessfully). If you set the `wait for completion` option to false, you can also check the status yourself using this endpoint.", |
| "operationId": "backups.create.status", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. filesystem, gcs, s3." |
| }, |
| { |
| "name": "id", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed." |
| }, |
| { |
| "name": "bucket", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "Name of the bucket, container, volume, etc" |
| }, |
| { |
| "name": "path", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "The path within the bucket" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Backup creation status successfully returned", |
| "schema": { |
| "$ref": "#/definitions/BackupCreateStatusResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Backup does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup restoration status attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "delete": { |
| "summary": "Cancel backup", |
| "description": "Cancel created backup with specified ID", |
| "operationId": "backups.cancel", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. filesystem, gcs, s3." |
| }, |
| { |
| "name": "id", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed." |
| }, |
| { |
| "name": "bucket", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "Name of the bucket, container, volume, etc" |
| }, |
| { |
| "name": "path", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "The path within the bucket" |
| } |
| ], |
| "responses": { |
| "204": { |
| "description": "Successfully deleted." |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup cancellation attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/backups/{backend}/{id}/restore": { |
| "post": { |
| "summary": "Start a restoration process", |
| "description": "Starts a process of restoring a backup for a set of collections. <br/><br/>Any backup can be restored to any machine, as long as the number of nodes between source and target are identical.<br/><br/>Requrements:<br/><br/>- None of the collections to be restored already exist on the target restoration node(s).<br/>- The node names of the backed-up collections' must match those of the target restoration node(s).", |
| "operationId": "backups.restore", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. `filesystem`, `gcs`, `s3`, `azure`." |
| }, |
| { |
| "name": "id", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed." |
| }, |
| { |
| "in": "body", |
| "name": "body", |
| "required": true, |
| "schema": { |
| "$ref": "#/definitions/BackupRestoreRequest" |
| } |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Backup restoration process successfully started.", |
| "schema": { |
| "$ref": "#/definitions/BackupRestoreResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Backup does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup restoration attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| }, |
| "get": { |
| "summary": "Get restore process status", |
| "description": "Returns status of a backup restoration attempt for a set of classes. <br/><br/>All client implementations have a `wait for completion` option which will poll the backup status in the background and only return once the backup has completed (successfully or unsuccessfully). If you set the `wait for completion` option to false, you can also check the status yourself using the this endpoint.", |
| "operationId": "backups.restore.status", |
| "x-serviceIds": [ |
| "weaviate.local.backup" |
| ], |
| "tags": [ |
| "backups" |
| ], |
| "parameters": [ |
| { |
| "name": "backend", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "Backup backend name e.g. `filesystem`, `gcs`, `s3`, `azure`." |
| }, |
| { |
| "name": "id", |
| "in": "path", |
| "required": true, |
| "type": "string", |
| "description": "The ID of a backup. Must be URL-safe and work as a filesystem path, only lowercase, numbers, underscore, minus characters allowed." |
| }, |
| { |
| "name": "bucket", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "Name of the bucket, container, volume, etc" |
| }, |
| { |
| "name": "path", |
| "in": "query", |
| "required": false, |
| "type": "string", |
| "description": "The path within the bucket" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Backup restoration status successfully returned", |
| "schema": { |
| "$ref": "#/definitions/BackupRestoreStatusResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Backup does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/cluster/statistics": { |
| "get": { |
| "summary": "See Raft cluster statistics", |
| "description": "Returns Raft cluster statistics of Weaviate DB.", |
| "operationId": "cluster.get.statistics", |
| "x-serviceIds": [ |
| "weaviate.cluster.statistics.get" |
| ], |
| "tags": [ |
| "cluster" |
| ], |
| "responses": { |
| "200": { |
| "description": "Cluster statistics successfully returned", |
| "schema": { |
| "$ref": "#/definitions/ClusterStatisticsResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup restoration status attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/nodes": { |
| "get": { |
| "summary": "Node information for the database.", |
| "description": "Returns node information for the entire database.", |
| "operationId": "nodes.get", |
| "x-serviceIds": [ |
| "weaviate.nodes.status.get" |
| ], |
| "tags": [ |
| "nodes" |
| ], |
| "parameters": [ |
| { |
| "$ref": "#/parameters/CommonOutputVerbosityParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Nodes status successfully returned", |
| "schema": { |
| "$ref": "#/definitions/NodesStatusResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Backup does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup restoration status attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/nodes/{className}": { |
| "get": { |
| "summary": "Node information for a collection.", |
| "description": "Returns node information for the nodes relevant to the collection.", |
| "operationId": "nodes.get.class", |
| "x-serviceIds": [ |
| "weaviate.nodes.status.get.class" |
| ], |
| "tags": [ |
| "nodes" |
| ], |
| "parameters": [ |
| { |
| "name": "className", |
| "in": "path", |
| "required": true, |
| "type": "string" |
| }, |
| { |
| "name": "shardName", |
| "in": "query", |
| "required": false, |
| "type": "string" |
| }, |
| { |
| "$ref": "#/parameters/CommonOutputVerbosityParameterQuery" |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Nodes status successfully returned", |
| "schema": { |
| "$ref": "#/definitions/NodesStatusResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Backup does not exist", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "422": { |
| "description": "Invalid backup restoration status attempt.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/tasks": { |
| "get": { |
| "summary": "Lists all distributed tasks in the cluster.", |
| "operationId": "distributedTasks.get", |
| "x-serviceIds": [ |
| "weaviate.distributedTasks.get" |
| ], |
| "tags": [ |
| "distributedTasks" |
| ], |
| "responses": { |
| "200": { |
| "description": "Distributed tasks successfully returned", |
| "schema": { |
| "$ref": "#/definitions/DistributedTasks" |
| } |
| }, |
| "403": { |
| "description": "Unauthorized or invalid credentials.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| } |
| } |
| }, |
| "/classifications/": { |
| "post": { |
| "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.", |
| "operationId": "classifications.post", |
| "x-serviceIds": [ |
| "weaviate.classifications.post" |
| ], |
| "parameters": [ |
| { |
| "description": "parameters to start a classification", |
| "in": "body", |
| "schema": { |
| "$ref": "#/definitions/Classification" |
| }, |
| "name": "params", |
| "required": true |
| } |
| ], |
| "responses": { |
| "201": { |
| "description": "Successfully started classification.", |
| "schema": { |
| "$ref": "#/definitions/Classification" |
| } |
| }, |
| "400": { |
| "description": "Incorrect request", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "Starts a classification.", |
| "tags": [ |
| "classifications" |
| ] |
| } |
| }, |
| "/classifications/{id}": { |
| "get": { |
| "description": "Get status, results and metadata of a previously created classification", |
| "operationId": "classifications.get", |
| "x-serviceIds": [ |
| "weaviate.classifications.get" |
| ], |
| "parameters": [ |
| { |
| "description": "classification id", |
| "in": "path", |
| "type": "string", |
| "name": "id", |
| "required": true |
| } |
| ], |
| "responses": { |
| "200": { |
| "description": "Found the classification, returned as body", |
| "schema": { |
| "$ref": "#/definitions/Classification" |
| } |
| }, |
| "404": { |
| "description": "Not Found - Classification does not exist" |
| }, |
| "401": { |
| "description": "Unauthorized or invalid credentials." |
| }, |
| "403": { |
| "description": "Forbidden", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| }, |
| "500": { |
| "description": "An error has occurred while trying to fulfill the request. Most likely the ErrorResponse will contain more information about the error.", |
| "schema": { |
| "$ref": "#/definitions/ErrorResponse" |
| } |
| } |
| }, |
| "summary": "View previously created classification", |
| "tags": [ |
| "classifications" |
| ] |
| } |
| } |
| }, |
| "produces": [ |
| "application/json" |
| ], |
| "schemes": [ |
| "https" |
| ], |
| "security": [ |
| {}, |
| { |
| "oidc": [] |
| } |
| ], |
| "securityDefinitions": { |
| "oidc": { |
| "type": "oauth2", |
| "description": "OIDC (OpenConnect ID - based on OAuth2)", |
| "flow": "implicit", |
| "authorizationUrl": "http://to-be-configured-in-the-application-config" |
| } |
| }, |
| "swagger": "2.0", |
| "tags": [ |
| { |
| "name": "objects" |
| }, |
| { |
| "name": "batch", |
| "description": "These operations allow to execute batch requests for Objects and Objects. Mostly used for importing large datasets." |
| }, |
| { |
| "name": "graphql" |
| }, |
| { |
| "name": "meta" |
| }, |
| { |
| "name": "P2P" |
| }, |
| { |
| "name": "contextionary-API", |
| "description": "All functions related to the Contextionary." |
| }, |
| { |
| "name": "schema", |
| "description": "These operations enable manipulation of the schema in Weaviate schema." |
| }, |
| { |
| "name": "replication", |
| "description": "Operations related to managing data replication, including initiating and monitoring shard replica movements between nodes, querying current sharding states, and managing the lifecycle of replication tasks." |
| } |
| ] |
| } |
|
|
