Tenant

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.github.io/hatchet/json-schema/hatchet-tenant-schema.json",
  "title": "Tenant",
  "description": "Hatchet Tenant entity, derived from the Hatchet OpenAPI spec.",
  "properties": {
    "metadata": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "the id of this resource, in UUID format",
          "example": "bb214807-246e-43a5-a25d-41761d1cff9e",
          "minLength": 0,
          "maxLength": 36
        },
        "createdAt": {
          "type": "string",
          "description": "the time that this resource was created",
          "format": "date-time",
          "example": "2022-12-13T15:06:48.888358-05:00"
        },
        "updatedAt": {
          "type": "string",
          "description": "the time that this resource was last updated",
          "format": "date-time",
          "example": "2022-12-13T15:06:48.888358-05:00"
        }
      },
      "required": [
        "id",
        "createdAt",
        "updatedAt"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the tenant."
    },
    "slug": {
      "type": "string",
      "description": "The slug of the tenant."
    },
    "analyticsOptOut": {
      "type": "boolean",
      "description": "Whether the tenant has opted out of analytics."
    },
    "alertMemberEmails": {
      "type": "boolean",
      "description": "Whether to alert tenant members."
    },
    "version": {
      "$ref": "#/components/schemas/TenantVersion",
      "description": "The version of the tenant."
    },
    "environment": {
      "$ref": "#/components/schemas/TenantEnvironment",
      "description": "The environment type of the tenant."
    },
    "serverUrl": {
      "type": "string",
      "description": "The server URL for the tenant (includes scheme)"
    },
    "region": {
      "type": "string",
      "description": "Control-plane shard region for the tenant (e.g. aws:us-west-2)."
    }
  },
  "required": [
    "metadata",
    "name",
    "slug",
    "version"
  ],
  "type": "object"
}