Typesense · Schema

ConfigurationChangeCreateSchema

Full-Text SearchOpen SourceSearch EngineTypo ToleranceVector Search

Properties

Name	Type	Description
new_memory	string	New memory allocation, such as 1_gb, 2_gb, etc.
new_vcpu	string	New vCPU configuration.
new_gpu	boolean	Whether to enable or disable GPU.
new_high_performance_disk	string	New high-performance disk configuration.
new_typesense_server_version	string	Typesense Server version to upgrade to.
new_high_availability	string	Enable or disable high availability.
perform_change_at	integer	Unix timestamp for when the change should be applied.
notification_email_addresses	array	Email addresses to notify about the configuration change.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ConfigurationChangeCreateSchema",
  "title": "ConfigurationChangeCreateSchema",
  "type": "object",
  "properties": {
    "new_memory": {
      "type": "string",
      "description": "New memory allocation, such as 1_gb, 2_gb, etc."
    },
    "new_vcpu": {
      "type": "string",
      "description": "New vCPU configuration."
    },
    "new_gpu": {
      "type": "boolean",
      "description": "Whether to enable or disable GPU."
    },
    "new_high_performance_disk": {
      "type": "string",
      "description": "New high-performance disk configuration."
    },
    "new_typesense_server_version": {
      "type": "string",
      "description": "Typesense Server version to upgrade to."
    },
    "new_high_availability": {
      "type": "string",
      "description": "Enable or disable high availability.",
      "enum": [
        "yes",
        "no"
      ]
    },
    "perform_change_at": {
      "type": "integer",
      "format": "int64",
      "description": "Unix timestamp for when the change should be applied."
    },
    "notification_email_addresses": {
      "type": "array",
      "description": "Email addresses to notify about the configuration change.",
      "items": {
        "type": "string"
      }
    }
  }
}