# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forge Backups API
  version: 1.0.0
extends: openapi/laravel-backups-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: List database backup configurations on a server
      effect: read
      questions:
      - Which backup schedules are set up for my server's databases?
      - Can I filter a server's backup configurations by name or status?
      instructions:
      - text: List the backup configurations on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Find backup configurations named {name} on server {server}, {organization}.
        slots:
          name: query.filter[name]
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule database backups on a server
      effect: write
      questions:
      - How do I schedule nightly database backups to my storage provider?
      - Can a backup schedule use a custom cron expression and keep only a set number of backups?
      - Will newly created databases be included in an existing backup automatically?
      instructions:
      - text: Back up databases {database_ids} on server {server} ({organization}) to storage {storage_provider_id} {frequency}, keeping {retention}.
        slots:
          database_ids: requestBody.database_ids
          server: path.server
          organization: path.organization
          storage_provider_id: requestBody.storage_provider_id
          frequency: requestBody.frequency
          retention: requestBody.retention
      - text: Set up backups on server {server} ({organization}) of {dbs} via cron {cron}, keep {retention}, to {storage}, frequency {frequency}.
        slots:
          server: path.server
          organization: path.organization
          dbs: requestBody.database_ids
          cron: requestBody.cron
          retention: requestBody.retention
          storage: requestBody.storage_provider_id
          frequency: requestBody.frequency
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database backup configuration
      effect: read
      questions:
      - What schedule and retention does a particular backup configuration use?
      - Can I see which databases one backup configuration covers?
      instructions:
      - text: Show backup configuration {backupConfiguration} on server {server} in {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Get the settings of backup config {backupConfiguration} for server {server}, org {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a database backup schedule
      effect: write
      questions:
      - Can I change how often an existing backup configuration runs?
      - How do I add a notification email to a backup schedule I already set up?
      instructions:
      - text: Change backup config {config} on server {server} ({organization}) to run {frequency}, keep {retention}, store on {storage}, cover {dbs}.
        slots:
          config: path.backupConfiguration
          server: path.server
          organization: path.organization
          frequency: requestBody.frequency
          retention: requestBody.retention
          storage: requestBody.storage_provider_id
          dbs: requestBody.database_ids
      - text: Update existing backup config {backupConfiguration} on server {server} in {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database backup configuration
      effect: destructive
      questions:
      - How do I stop a scheduled database backup permanently?
      - Can I remove a backup configuration I no longer need?
      instructions:
      - text: Delete backup configuration {backupConfiguration} from server {server} in {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Remove the backup schedule {backupConfiguration} on server {server}, org {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List backups taken by a backup configuration
      effect: read
      questions:
      - Which database backups have actually been taken under a schedule?
      - Can I filter backup runs by status to find failed ones?
      instructions:
      - text: List the backups taken by configuration {backupConfiguration} on server {server} in {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Show backups with status {status} for config {backupConfiguration}, server {server}, {organization}.
        slots:
          status: query.filter[status]
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a database backup now
      effect: write
      questions:
      - Can I take a database backup right now instead of waiting for the schedule?
      - How do I trigger a manual backup before a risky migration?
      instructions:
      - text: Run backup configuration {backupConfiguration} now on server {server} in {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Take a manual backup using config {backupConfiguration} for server {server}, org {organization}.
        slots:
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one database backup
      effect: read
      questions:
      - Did a specific backup run succeed?
      - Can I look up one backup taken under a configuration?
      instructions:
      - text: Check whether backup run {backup} succeeded under schedule {config} on server {server}, {organization}.
        slots:
          backup: path.backup
          config: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Get the details of backup {backup} (config {backupConfiguration}, server {server}, {organization}).
        slots:
          backup: path.backup
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one database backup
      effect: destructive
      questions:
      - Can I delete a single old backup without touching the schedule?
      - What removes one backup file taken by a configuration?
      instructions:
      - text: Delete the single backup file {backup} produced by schedule {config} on server {server}, {organization}.
        slots:
          backup: path.backup
          config: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Remove the backup {backup} taken by config {backupConfiguration}, server {server}, org {organization}.
        slots:
          backup: path.backup
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/backups/{backupConfiguration}/instances/{backup}/restores'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a database from a backup
      effect: destructive
      questions:
      - How do I restore a database from last night's backup?
      - Can I choose which database a backup gets restored into?
      instructions:
      - text: Restore database {database_id} from backup {backup} (config {backupConfiguration}) on server {server} in {organization}.
        slots:
          database_id: requestBody.database_id
          backup: path.backup
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      - text: Roll database {database_id} back to backup {backup} of config {backupConfiguration}, server {server}, org {organization}.
        slots:
          database_id: requestBody.database_id
          backup: path.backup
          backupConfiguration: path.backupConfiguration
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'