API Evangelist conversational phrasing for Laravel Databases API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Databases API
  version: 1.0.0
extends: openapi/laravel-databases-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: 15
- target: $.paths['/databases/clusters/{database}/databases'].get
  update:
    x-apievangelist-phrasing:
      intent: List databases in a Cloud database cluster
      effect: read
      questions:
      - Which databases live inside my Laravel Cloud database cluster?
      - Can I see every database on one managed cluster?
      instructions:
      - text: List the databases in cluster {database}.
        slots:
          database: path.database
      - text: Show all databases hosted on database cluster {database}.
        slots:
          database: path.database
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}/databases'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database in a Cloud cluster
      effect: write
      questions:
      - How do I add a new database to an existing managed database cluster?
      - Can one cloud cluster hold several separately named databases?
      instructions:
      - text: Create a database named {name} in cluster {database}.
        slots:
          name: requestBody.name
          database: path.database
      - text: Add database {name} to the managed cluster {database}.
        slots:
          name: requestBody.name
          database: path.database
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}/databases/{schema}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database in a Cloud cluster
      effect: read
      questions:
      - What are the details of one database inside my cloud cluster?
      - Can I look up a single cluster database by its ID?
      instructions:
      - text: Show database {schema} in cluster {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Get the details of cluster {database}'s database {schema}.
        slots:
          database: path.database
          schema: path.schema
      method: generated
      generated: '2026-10-01'
- target: $.paths['/databases/clusters/{database}/databases/{schema}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database from a Cloud cluster
      effect: destructive
      questions:
      - Can I drop one database from a cloud cluster without deleting the whole cluster?
      - How do I remove an unused database from my managed cluster?
      instructions:
      - text: Delete database {schema} from cluster {database}.
        slots:
          schema: path.schema
          database: path.database
      - text: Drop the database {schema} on managed cluster {database}.
        slots:
          schema: path.schema
          database: path.database
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/schemas'].get
  update:
    x-apievangelist-phrasing:
      intent: List database schemas on a Forge server
      effect: read
      questions:
      - Which databases exist on my Forge server?
      - Can I filter a server's database schemas by name or status?
      instructions:
      - text: List the database schemas on server {server} in organization {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Find server {server} schemas in {organization} named {name}.
        slots:
          server: path.server
          organization: path.organization
          name: query.filter[name]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/schemas'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database schema on a server
      effect: write
      questions:
      - How do I create a new MySQL or Postgres database on my server?
      - Can I create a database user at the same time as the schema?
      - Is it possible to attach backup configurations when adding a server database?
      instructions:
      - text: Create database schema {name} on server {server} in {organization}.
        slots:
          name: requestBody.name
          server: path.server
          organization: path.organization
      - text: Add schema {name} to server {server} ({organization}) with user {user} and password {password}.
        slots:
          name: requestBody.name
          server: path.server
          organization: path.organization
          user: requestBody.user
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/schemas/{database}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database schema on a server
      effect: read
      questions:
      - What is the status of a specific database on my server?
      - Can I fetch one server database schema by ID?
      instructions:
      - text: Show database schema {database} on server {server} in {organization}.
        slots:
          database: path.database
          server: path.server
          organization: path.organization
      - text: Get the details of server {server}'s schema {database} in org {organization}.
        slots:
          database: path.database
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/schemas/{database}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database schema from a server
      effect: destructive
      questions:
      - How do I remove a database schema I no longer need from my server?
      - Can I delete one schema on a server and leave its other databases alone?
      instructions:
      - text: Delete database schema {database} from server {server} in {organization}.
        slots:
          database: path.database
          server: path.server
          organization: path.organization
      - text: Drop schema {database} on server {server}, org {organization}.
        slots:
          database: path.database
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/schemas/synchronizations'].post
  update:
    x-apievangelist-phrasing:
      intent: Sync database schemas from a server
      effect: write
      questions:
      - I created databases directly on the server — can I sync them into Forge?
      - What refreshes the list of schemas Forge knows about for a server?
      instructions:
      - text: Synchronize the database schemas on server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Re-scan server {server} ({organization}) and pick up databases created outside the dashboard.
        slots:
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List database users on a server
      effect: read
      questions:
      - Which database users exist on my server?
      - Can I filter a server's database users by name or status?
      instructions:
      - text: List the database users on server {server} in organization {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Find database users 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/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a database user on a server
      effect: write
      questions:
      - How do I add a read-only database user for reporting?
      - Can a new database user be granted access to specific databases only?
      instructions:
      - text: Create database user {name} with password {password} on server {server} in {organization}.
        slots:
          name: requestBody.name
          password: requestBody.password
          server: path.server
          organization: path.organization
      - text: Add read-only user {name} (password {password}) on server {server}, {organization}, read only {read_only}.
        slots:
          name: requestBody.name
          password: requestBody.password
          server: path.server
          organization: path.organization
          read_only: requestBody.read_only
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/users/{databaseUser}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a database user on a server
      effect: read
      questions:
      - Which databases can a given database user access?
      - Can I look up one database user on a server by ID?
      instructions:
      - text: Show database user {databaseUser} on server {server} in {organization}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
      - text: Get the details of db user {databaseUser} on server {server}, org {organization}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/users/{databaseUser}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a database user's password or access
      effect: write
      questions:
      - Can I change which databases an existing database user can reach?
      - How do I reset an existing database user's password on the server?
      instructions:
      - text: Set the password of database user {databaseUser} on server {server} in {organization} to {password}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
          password: requestBody.password
      - text: Grant db user {databaseUser} on server {server} ({organization}) access to databases {database_ids}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
          database_ids: requestBody.database_ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/users/{databaseUser}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database user from a server
      effect: destructive
      questions:
      - Can I remove a database user that a former contractor used?
      - What deletes a database user from my server?
      instructions:
      - text: Delete database user {databaseUser} from server {server} in {organization}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
      - text: Remove db user {databaseUser} on server {server}, org {organization}.
        slots:
          databaseUser: path.databaseUser
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/database/password'].put
  update:
    x-apievangelist-phrasing:
      intent: Record a changed root database password in Forge
      effect: write
      questions:
      - I changed the database password directly on the server — how do I tell Forge?
      - Does updating the stored database password also change it on the server itself?
      instructions:
      - text: Update the database password Forge has on file for server {server} in {organization} to {password}.
        slots:
          server: path.server
          organization: path.organization
          password: requestBody.password
      - text: Sync Forge's stored root database password for server {server} ({organization}) to {password}.
        slots:
          server: path.server
          organization: path.organization
          password: requestBody.password
      method: generated
      generated: '2026-10-01'