{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://api-evangelist.github.io/weaviate/json-schema/weaviate-tenant-schema.json", "title": "Tenant", "description": "Attributes representing a single tenant within Weaviate.", "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tenant (required)." }, "activityStatus": { "type": "string", "description": "The activity status of the tenant, which determines if it is queryable and where its data is stored.

Available Statuses:
- `ACTIVE`: The tenant is fully operational and ready for queries. Data is stored on local, hot storage.
- `INACTIVE`: The tenant is not queryable. Data is stored locally.
- `OFFLOADED`: The tenant is inactive and its data is stored in a remote cloud backend.

Usage Rules:
- On Create: This field is optional and defaults to `ACTIVE`. Allowed values are `ACTIVE` and `INACTIVE`.
- On Update: This field is required. Allowed values are `ACTIVE`, `INACTIVE`, and `OFFLOADED`.

Read-Only Statuses:
The following statuses are set by the server and indicate a tenant is transitioning between states:
- `OFFLOADING`
- `ONLOADING`

Note on Deprecated Names:
For backward compatibility, deprecated names are still accepted and are mapped to their modern equivalents: `HOT` (now `ACTIVE`), `COLD` (now `INACTIVE`), `FROZEN` (now `OFFLOADED`), `FREEZING` (now `OFFLOADING`), `UNFREEZING` (now `ONLOADING`).", "enum": [ "ACTIVE", "INACTIVE", "OFFLOADED", "OFFLOADING", "ONLOADING", "HOT", "COLD", "FROZEN", "FREEZING", "UNFREEZING" ] } } }