API Evangelist conversational phrasing for Netlify's API documentation 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 Netlify's API documentation Database API
  version: 1.0.0
extends: openapi/netlify-database-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 19
- target: $.paths['/sites/{site_id}/database'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's database connection string
      effect: read
      questions:
      - Where do I find the connection string for my site's database?
      - Can I get the database connection string for a specific role?
      instructions:
      - text: Get the database connection string for site {site}.
        slots:
          site: path.site_id
      - text: Fetch the connection string for site {site} using the {role} role.
        slots:
          site: path.site_id
          role: query.role
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database for a site
      effect: write
      questions:
      - How do I add a database to my Netlify site?
      - Which region does a new site database use if I don't pick one?
      - What happens if I create a database for a site that already has one?
      instructions:
      - text: Create a database for site {site}.
        slots:
          site: path.site_id
      - text: Provision a new database for site {site} in region {region}.
        slots:
          site: path.site_id
          region: requestBody.region
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site's database
      effect: destructive
      questions:
      - Can I delete my site's database along with all its branches and snapshots?
      - What gets removed when I tear down a site's whole database?
      instructions:
      - text: Delete the entire database for site {site}, including branches and snapshots.
        slots:
          site: path.site_id
      - text: Tear down the database attached to site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branch'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database branch
      effect: write
      questions:
      - Can I fork a new database branch off an existing parent branch?
      - How do I create a separate database branch for a feature?
      instructions:
      - text: Create database branch {branch} for site {site}.
        slots:
          branch: requestBody.branch_id
          site: path.site_id
      - text: Create database branch {branch} on site {site} forked from parent branch {parent}.
        slots:
          branch: requestBody.branch_id
          site: path.site_id
          parent: requestBody.parent_branch_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branches'].get
  update:
    x-apievangelist-phrasing:
      intent: List a site's database branches
      effect: read
      questions:
      - Which database branches exist for my site and are they running?
      - Can I see the compute status of every database branch?
      instructions:
      - text: List all database branches for site {site}.
        slots:
          site: path.site_id
      - text: Show every database branch on site {site} with its compute status.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branch/{branch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database branch connection string
      effect: read
      questions:
      - Where do I get the connection string for one particular database branch?
      - Can I fetch a branch's connection string for a specific role?
      instructions:
      - text: Get the connection string for database branch {branch} on site {site}.
        slots:
          branch: path.branch_id
          site: path.site_id
      - text: Fetch the {role} connection string for database branch {branch} of site {site}.
        slots:
          role: query.role
          branch: path.branch_id
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branch/{branch_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database branch
      effect: destructive
      questions:
      - How do I remove a database branch I no longer need?
      - Can I delete a single branch without deleting the whole database?
      instructions:
      - text: Delete database branch {branch} from site {site}.
        slots:
          branch: path.branch_id
          site: path.site_id
      - text: Remove the {branch} database branch on site {site}.
        slots:
          branch: path.branch_id
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branch/{branch_id}/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset a database branch from its source
      effect: destructive
      questions:
      - Can I re-fork a preview database branch from production to start fresh?
      - Why didn't my branch reset happen when it was already in sync?
      - Is it possible to reset the production database branch?
      instructions:
      - text: Reset database branch {branch} on site {site} from production.
        slots:
          branch: path.branch_id
          site: path.site_id
      - text: Reset database branch {branch} on site {site} from source branch {source}, forcing it even if in sync.
        slots:
          branch: path.branch_id
          site: path.site_id
          source: requestBody.source_branch_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/branch/{branch_id}/compute/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set compute settings for one database branch
      effect: write
      questions:
      - Can I give one database branch different compute limits than the rest?
      - How do I change the sleep timeout for a single database branch?
      instructions:
      - text: Set database branch {branch} on site {site} to scale between {min_cu} and {max_cu} compute units.
        slots:
          branch: path.branch_id
          site: path.site_id
          min_cu: requestBody.min_cu
          max_cu: requestBody.max_cu
      - text: Override the sleep timeout for database branch {branch} on site {site} to {seconds} seconds.
        slots:
          branch: path.branch_id
          site: path.site_id
          seconds: requestBody.sleep_timeout_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/compute/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get project-level database compute settings
      effect: read
      questions:
      - What compute settings does my site's database use by default?
      - Are my database compute settings custom or the plan tier defaults?
      instructions:
      - text: Show the project-level database compute settings for site {site}.
        slots:
          site: path.site_id
      - text: Check the effective default compute limits for site {site}'s database.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/compute/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set project-level database compute settings
      effect: write
      questions:
      - Can I set default compute limits that apply to all new database branches?
      - Which plan do I need to customize database compute settings?
      instructions:
      - text: Set the default database compute range for site {site} to {min_cu}–{max_cu} compute units.
        slots:
          site: path.site_id
          min_cu: requestBody.min_cu
          max_cu: requestBody.max_cu
      - text: Make new database branches on site {site} sleep after {seconds} seconds idle.
        slots:
          site: path.site_id
          seconds: requestBody.sleep_timeout_seconds
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/compute/settings'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset database compute settings to defaults
      effect: destructive
      questions:
      - How do I go back to the tier default compute settings for my database?
      - Can I clear my custom project-level database compute limits?
      instructions:
      - text: Clear the custom database compute settings on site {site}.
        slots:
          site: path.site_id
      - text: Revert site {site}'s database compute settings to plan defaults.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/migrations'].get
  update:
    x-apievangelist-phrasing:
      intent: List database migrations and their status
      effect: read
      questions:
      - Which database migrations have been applied to my branch?
      - Can I see pending migrations for a specific database branch?
      instructions:
      - text: List database migrations for site {site}.
        slots:
          site: path.site_id
      - text: Show which migrations are applied on branch {branch} of site {site}.
        slots:
          branch: query.branch
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/migrations/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the contents of a database migration
      effect: read
      questions:
      - Can I read the SQL of a named database migration?
      - What does a specific migration contain on a given branch?
      instructions:
      - text: Show the contents of migration {name} for site {site}.
        slots:
          name: path.name
          site: path.site_id
      - text: Get migration {name} on branch {branch} of site {site}.
        slots:
          name: path.name
          branch: query.branch
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/migrations/{deploy_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Run database migrations for a deploy
      effect: write
      questions:
      - How do I apply database migrations as part of a deploy?
      - Can I do a dry run of migrations before applying them?
      instructions:
      - text: Run database migrations for deploy {deploy} on site {site}.
        slots:
          deploy: path.deploy_id
          site: path.site_id
      - text: Dry-run the migrations for deploy {deploy} of site {site} without applying them.
        slots:
          deploy: path.deploy_id
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/snapshot'].post
  update:
    x-apievangelist-phrasing:
      intent: Take a database snapshot
      effect: write
      questions:
      - Can I take a point-in-time backup of my database before a risky change?
      - Which branch gets snapshotted if I don't name one?
      instructions:
      - text: Take a snapshot of the production database for site {site}.
        slots:
          site: path.site_id
      - text: Snapshot database branch {branch} on site {site} and name it {name}.
        slots:
          branch: requestBody.branch_id
          site: path.site_id
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/snapshots'].get
  update:
    x-apievangelist-phrasing:
      intent: List database snapshots
      effect: read
      questions:
      - What database snapshots do I have for my site?
      - Can I see all point-in-time backups of my site's database?
      instructions:
      - text: List all database snapshots for site {site}.
        slots:
          site: path.site_id
      - text: Show the saved database snapshots on site {site}.
        slots:
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/snapshot/{snapshot_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database snapshot
      effect: destructive
      questions:
      - How do I delete an old database snapshot?
      - Can I remove one snapshot without touching the database?
      instructions:
      - text: Delete database snapshot {snapshot} from site {site}.
        slots:
          snapshot: path.snapshot_id
          site: path.site_id
      - text: Remove snapshot {snapshot} on site {site}.
        slots:
          snapshot: path.snapshot_id
          site: path.site_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/sites/{site_id}/database/snapshot/{snapshot_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a database snapshot to a branch
      effect: destructive
      questions:
      - Can I roll my database back to an earlier snapshot?
      - Is it possible to restore a snapshot into a non-production branch?
      instructions:
      - text: Restore snapshot {snapshot} to the production database of site {site}.
        slots:
          snapshot: path.snapshot_id
          site: path.site_id
      - text: Restore snapshot {snapshot} on site {site} into branch {branch}.
        slots:
          snapshot: path.snapshot_id
          site: path.site_id
          branch: requestBody.branch_id
      method: generated
      generated: '2026-09-26'