tenant.yaml

Tenant:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    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: "#/TenantVersion"
      description: The version of the tenant.
    environment:
      $ref: "#/TenantEnvironment"
      description: The environment type of the tenant.
    dataRetentionPeriod:
      type: string
      description: The data retention period for the tenant, e.g. 720h.
  required:
    - metadata
    - name
    - slug
    - version
  type: object

TenantVersion:
  enum:
    - "V0"
    - "V1"
  type: string

TenantUIVersion:
  enum:
    - "V0"
    - "V1"
  type: string

TenantAlertingSettings:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    alertMemberEmails:
      type: boolean
      description: Whether to alert tenant members.
    enableWorkflowRunFailureAlerts:
      type: boolean
      description: Whether to send alerts when workflow runs fail.
    enableExpiringTokenAlerts:
      type: boolean
      description: Whether to enable alerts when tokens are approaching expiration.
    enableTenantResourceLimitAlerts:
      type: boolean
      description: Whether to enable alerts when tenant resources are approaching limits.
    maxAlertingFrequency:
      type: string
      description: The max frequency at which to alert.
    lastAlertedAt:
      type: string
      description: The last time an alert was sent.
      format: date-time
  required:
    - metadata
    - maxAlertingFrequency
  type: object

# IMPORTANT: keep values in sync with sql/schema/v0.sql#TenantEnvironment
TenantEnvironment:
  enum:
    - "local"
    - "development"
    - "production"
  type: string

CreateTenantRequest:
  properties:
    name:
      type: string
      description: The name of the tenant.
      x-oapi-codegen-extra-tags:
        validate: "required"
    slug:
      type: string
      description: The slug of the tenant.
      x-oapi-codegen-extra-tags:
        validate: "required,hatchetName"
    engineVersion:
      $ref: "#/TenantVersion"
      description: The engine version of the tenant. Defaults to V0.
    environment:
      $ref: "#/TenantEnvironment"
      description: The environment type of the tenant.
    onboardingData:
      type: object
      description: Additional onboarding data to store with the tenant.
      additionalProperties: true
  required:
    - name
    - slug
  type: object

UpdateTenantRequest:
  properties:
    name:
      type: string
      description: The name of the tenant.
    analyticsOptOut:
      type: boolean
      description: Whether the tenant has opted out of analytics.
    alertMemberEmails:
      type: boolean
      description: Whether to alert tenant members.
    enableWorkflowRunFailureAlerts:
      type: boolean
      description: Whether to send alerts when workflow runs fail.
    enableExpiringTokenAlerts:
      type: boolean
      description: Whether to enable alerts when tokens are approaching expiration.
    enableTenantResourceLimitAlerts:
      type: boolean
      description: Whether to enable alerts when tenant resources are approaching limits.
    maxAlertingFrequency:
      type: string
      description: The max frequency at which to alert.
      x-oapi-codegen-extra-tags:
        validate: "omitnil,duration"
    version:
      $ref: "#/TenantVersion"
      description: The version of the tenant.
  type: object

TenantResource:
  enum:
    - "WORKER"
    - "WORKER_SLOT"
    - "EVENT"
    - "TASK_RUN"
    - "CRON"
    - "SCHEDULE"
    - "INCOMING_WEBHOOK"
  type: string

TenantResourceLimit:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    resource:
      $ref: "#/TenantResource"
      description: The resource associated with this limit.
    limitValue:
      type: integer
      description: The limit associated with this limit.
    alarmValue:
      type: integer
      description: The alarm value associated with this limit to warn of approaching limit value.
    value:
      type: integer
      description: The current value associated with this limit.
    window:
      type: string
      description: The meter window for the limit. (i.e. 1 day, 1 week, 1 month)
    lastRefill:
      type: string
      description: The last time the limit was refilled.
      format: date-time
  required:
    - metadata
    - tenantId
    - resource
    - limitValue
    - value
  type: object

TenantResourcePolicy:
  properties:
    limits:
      type: array
      items:
        $ref: "#/TenantResourceLimit"
      description: A list of resource limits for the tenant.
  required:
    - limits
  type: object

TenantMember:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    user:
      $ref: "./_index.yaml#/UserTenantPublic"
      description: The user associated with this tenant member.
    role:
      $ref: "#/TenantMemberRole"
      description: The role of the user in the tenant.
    tenant:
      $ref: "#/Tenant"
      description: The tenant associated with this tenant member.
  required:
    - metadata
    - user
    - role
  type: object

TenantMemberList:
  properties:
    pagination:
      $ref: "./metadata.yaml#/PaginationResponse"
    rows:
      items:
        $ref: "#/TenantMember"
      type: array
      x-go-name: Rows

TenantMemberRole:
  enum:
    - "OWNER"
    - "ADMIN"
    - "MEMBER"
  type: string

TenantList:
  properties:
    pagination:
      $ref: "./metadata.yaml#/PaginationResponse"
    rows:
      items:
        $ref: "#/Tenant"
      type: array
      x-go-name: Rows

CreateTenantInviteRequest:
  properties:
    email:
      type: string
      description: The email of the user to invite.
      x-oapi-codegen-extra-tags:
        validate: "required,email"
    role:
      $ref: "#/TenantMemberRole"
      description: The role of the user in the tenant.
      x-oapi-codegen-extra-tags:
        validate: "required"
  required:
    - email
    - role
  type: object

TenantAlertEmailGroup:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    emails:
      type: array
      items:
        type: string
      description: A list of emails for users
  required:
    - metadata
    - emails
  type: object

TenantAlertEmailGroupList:
  properties:
    pagination:
      $ref: "./metadata.yaml#/PaginationResponse"
    rows:
      items:
        $ref: "#/TenantAlertEmailGroup"
      type: array
      x-go-name: Rows

CreateTenantAlertEmailGroupRequest:
  properties:
    emails:
      type: array
      items:
        type: string
      description: A list of emails for users
      x-oapi-codegen-extra-tags:
        validate: "required,dive,email"
  required:
    - emails
  type: object

UpdateTenantAlertEmailGroupRequest:
  properties:
    emails:
      type: array
      items:
        type: string
      description: A list of emails for users
      x-oapi-codegen-extra-tags:
        validate: "required,dive,email"
  required:
    - emails
  type: object

UpdateTenantInviteRequest:
  properties:
    role:
      $ref: "#/TenantMemberRole"
      description: The role of the user in the tenant.
      x-oapi-codegen-extra-tags:
        validate: "required"
  required:
    - role
  type: object

UpdateTenantMemberRequest:
  properties:
    role:
      $ref: "#/TenantMemberRole"
      description: The role of the user in the tenant.
      x-oapi-codegen-extra-tags:
        validate: "required"
  required:
    - role
  type: object

TenantInvite:
  properties:
    metadata:
      $ref: "./metadata.yaml#/APIResourceMeta"
    email:
      type: string
      description: The email of the user to invite.
    role:
      $ref: "#/TenantMemberRole"
      description: The role of the user in the tenant.
    tenantId:
      type: string
      description: The tenant id associated with this tenant invite.
    tenantName:
      type: string
      description: The tenant name for the tenant.
    expires:
      type: string
      description: The time that this invite expires.
      format: date-time
  required:
    - metadata
    - email
    - role
    - expires
    - tenantId
  type: object

TenantInviteList:
  properties:
    pagination:
      $ref: "./metadata.yaml#/PaginationResponse"
    rows:
      items:
        $ref: "#/TenantInvite"
      type: array
      x-go-name: Rows

QueueMetrics:
  type: object
  properties:
    numQueued:
      type: integer
      description: The number of items in the queue.
    numRunning:
      type: integer
      description: The number of items running.
    numPending:
      type: integer
      description: The number of items pending.
  required:
    - numQueued
    - numRunning
    - numPending

TenantQueueMetrics:
  properties:
    total:
      $ref: "#/QueueMetrics"
      description: The total queue metrics.
    workflow:
      type: object
      additionalProperties:
        $ref: "#/QueueMetrics"
    queues:
      type: object
      additionalProperties:
        type: integer

TenantStepRunQueueMetrics:
  properties:
    queues:
      type: object

TaskStats:
  type: object
  additionalProperties:
    $ref: "#/TaskStat"

TaskStat:
  properties:
    queued:
      $ref: "#/TaskStatusStat"
    running:
      $ref: "#/TaskStatusStat"
  type: object

TaskStatusStat:
  properties:
    total:
      type: integer
      format: int64
    queues:
      type: object
      additionalProperties:
        type: integer
        format: int64
    concurrency:
      type: array
      items:
        $ref: "#/ConcurrencyStat"
    oldest:
      type: string
      format: date-time
  type: object

ConcurrencyStat:
  properties:
    expression:
      type: string
    type:
      type: string
    keys:
      type: object
      additionalProperties:
        type: integer
        format: int64
  type: object