profilarr/docs/api/v1/schemas/databases.yaml

DatabaseInstance:
  type: object
  required:
    - id
    - uuid
    - name
    - repository_url
    - sync_strategy
    - auto_pull
    - enabled
    - is_private
    - local_ops_enabled
    - conflict_strategy
    - hasPat
    - created_at
    - updated_at
  properties:
    id:
      type: integer
      description: Database instance ID
    uuid:
      type: string
      format: uuid
      description: Unique identifier
    name:
      type: string
      description: Display name
    repository_url:
      type: string
      description: GitHub repository URL
    sync_strategy:
      type: integer
      description: Auto-sync interval in minutes (0 = manual only)
    auto_pull:
      type: integer
      description: Whether to automatically pull updates (0 or 1)
    enabled:
      type: integer
      description: Whether the database is active (0 or 1)
    is_private:
      type: integer
      description: Whether the repository is private (0 or 1)
    local_ops_enabled:
      type: integer
      description: Whether local ops editing is enabled (0 or 1)
    git_user_name:
      type: string
      nullable: true
      description: Git user name for commits
    git_user_email:
      type: string
      nullable: true
      description: Git user email for commits
    conflict_strategy:
      type: string
      enum:
        - override
        - align
        - ask
      description: How to handle conflicts between local tweaks and upstream updates
    last_synced_at:
      type: string
      nullable: true
      description: Last successful sync timestamp
    created_at:
      type: string
      description: Creation timestamp
    updated_at:
      type: string
      description: Last update timestamp
    hasPat:
      type: boolean
      description: Whether a personal access token is configured

CreateDatabaseInput:
  type: object
  required:
    - name
    - repository_url
  properties:
    name:
      type: string
      description: Display name (must be unique)
    repository_url:
      type: string
      description: GitHub repository URL
    branch:
      type: string
      description: Git branch to clone (defaults to remote's default branch)
    personal_access_token:
      type: string
      description: GitHub PAT for private repos and push access
    git_user_name:
      type: string
      description: Required when personal_access_token is set
    git_user_email:
      type: string
      description: Required when personal_access_token is set
    sync_strategy:
      type: integer
      default: 0
      description: Auto-sync interval in minutes (0 = manual only)
    auto_pull:
      type: boolean
      default: false
      description: Whether to automatically pull updates
    local_ops_enabled:
      type: boolean
      default: false
      description: Force writes to local user ops even with a PAT (requires personal_access_token)
    conflict_strategy:
      type: string
      enum:
        - override
        - align
        - ask
      default: override
      description: How to handle conflicts (only valid without a PAT, or with PAT + local_ops_enabled)

UpdateDatabaseInput:
  type: object
  description: All fields are optional. Unknown fields are silently ignored.
  properties:
    name:
      type: string
      description: Display name (must be unique)
    personal_access_token:
      type: string
      description: GitHub PAT for private repos and push access
    git_user_name:
      type: string
      description: Required when personal_access_token is set
    git_user_email:
      type: string
      description: Required when personal_access_token is set
    sync_strategy:
      type: integer
      description: Auto-sync interval in minutes (0 = manual only)
    auto_pull:
      type: boolean
      description: Whether to automatically pull updates
    local_ops_enabled:
      type: boolean
      description: Force writes to local user ops even with a PAT (requires personal_access_token)
    conflict_strategy:
      type: string
      enum:
        - override
        - align
        - ask
      description: How to handle conflicts (only valid without a PAT, or with PAT + local_ops_enabled)

SyncTriggerResponse:
  type: object
  required:
    - jobId
  properties:
    jobId:
      type: integer
      description: Job queue ID to poll via GET /api/v1/jobs/{jobId}