API Evangelist conversational phrasing for act.web.api Database API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for act.web.api Database API
  version: 1.0.0
extends: openapi/act-database-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: 13
- target: $.paths['/api/database/backups/{filename}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a database backup file
      effect: read
      questions:
      - How do I download one of my database backup files?
      - Can I retrieve a specific backup by its filename?
      instructions:
      - text: Download the database backup {filename}.
        slots:
          filename: path.filename
      - text: Get backup file {filename}.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/backups/{filename}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database backup file
      effect: destructive
      questions:
      - How do I delete an old database backup to free space?
      - Can I remove one backup file by name?
      instructions:
      - text: Delete the database backup {filename}.
        slots:
          filename: path.filename
      - text: Remove backup file {filename} from the server.
        slots:
          filename: path.filename
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/demo-data'].post
  update:
    x-apievangelist-phrasing:
      intent: Load demo data
      effect: write
      questions:
      - How do I fill my database with sample demo records?
      - Can I add demo data to try out the CRM?
      instructions:
      - text: Load the demo data into my database.
      - text: Populate the database with sample records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/demo-data'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove demo data
      effect: destructive
      questions:
      - How do I clear out the sample demo records?
      - Can I wipe the demo data before going live?
      instructions:
      - text: Delete the demo data from my database.
      - text: Clear out all the sample records.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/demo-data-status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check demo data status
      effect: read
      questions:
      - Is demo data currently loaded in my database?
      - What is the status of the demo data load?
      instructions:
      - text: Check whether demo data is loaded.
      - text: Report the demo data status.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: List database backup files
      effect: read
      questions:
      - What database backups do I have available?
      - Which backup files exist on the server right now?
      instructions:
      - text: List all database backup files.
      - text: Show me every backup I can restore from.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/backups'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a database backup file
      effect: write
      questions:
      - How do I upload a backup file I made elsewhere?
      - Can I push an existing backup file up to the server?
      instructions:
      - text: Upload my database backup file to the server.
      - text: Send this backup file up so it is stored with the others.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/backups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database backup
      effect: write
      questions:
      - How do I take a fresh backup of my database?
      - Can I password-protect a new database backup?
      instructions:
      - text: Back up the database as admin {username} and protect it with password {password}.
        slots:
          username: requestBody.username
          password: requestBody.password
      - text: Create a new backup now using administrator {username}.
        slots:
          username: requestBody.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/maintenance/lock'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the database lock state
      effect: read
      questions:
      - Is my database locked for maintenance right now?
      - Is there a pending lock scheduled on the database?
      instructions:
      - text: Check the database lock state.
      - text: Tell me if the database is locked or has a pending lock.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/maintenance/lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock the database for maintenance
      effect: write
      questions:
      - How do I lock the database before doing maintenance?
      - Can I schedule a lock to take effect after a delay in minutes?
      instructions:
      - text: Lock the database in {delayUntilLock} minutes for reason {reason}.
        slots:
          delayUntilLock: requestBody.delayUntilLock
          reason: requestBody.reason
      - text: Lock the database now with the comment {comments}.
        slots:
          comments: requestBody.comments
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new database
      effect: write
      questions:
      - How do I create a brand-new CRM database?
      - What naming rules apply to a new database name?
      - Can I choose the currency and make the database shared?
      instructions:
      - text: Create a database named {databaseName} with admin {username} and password {password}.
        slots:
          databaseName: requestBody.databaseName
          username: requestBody.username
          password: requestBody.password
      - text: Create shared database {databaseName} using currency {currency}, admin {username}, password {password}.
        slots:
          databaseName: requestBody.databaseName
          currency: requestBody.currency
          username: requestBody.username
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/database/maintenance/unlock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock the database
      effect: write
      questions:
      - How do I unlock the database after maintenance?
      - Can I release a maintenance lock so users can log back in?
      instructions:
      - text: Unlock the database.
      - text: Release the maintenance lock so users can work again.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/opened/sessions'].get
  update:
    x-apievangelist-phrasing:
      intent: List open database sessions
      effect: read
      questions:
      - Who is currently connected to the database?
      - How many open connections are there right now?
      instructions:
      - text: List all open connections to the database.
      - text: Show who is logged into the database right now.
      method: generated
      generated: '2026-10-01'