# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Background Processes API
  version: 1.0.0
extends: openapi/laravel-background-processes-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: 11
- target: $.paths['/instances/{instance}/background-processes'].get
  update:
    x-apievangelist-phrasing:
      intent: List background processes on a Cloud instance
      effect: read
      questions:
      - What background processes are running on one of my Laravel Cloud instances?
      - Can I see the queue workers configured on a Cloud instance?
      instructions:
      - text: List the background processes on Cloud instance {instance}.
        slots:
          instance: path.instance
      - text: Show the workers configured for instance {instance}.
        slots:
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/instances/{instance}/background-processes'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a background process to a Cloud instance
      effect: write
      questions:
      - How do I add a queue worker to a Cloud instance?
      - Can I run a custom long-running command as a background process on an instance?
      instructions:
      - text: Add a {type} background process with {processes} processes to Cloud instance {instance}.
        slots:
          type: requestBody.type
          processes: requestBody.processes
          instance: path.instance
      - text: Run custom command {command} as {processes} {type} processes on instance {instance}.
        slots:
          command: requestBody.command
          processes: requestBody.processes
          type: requestBody.type
          instance: path.instance
      method: generated
      generated: '2026-10-01'
- target: $.paths['/background-processes/{backgroundProcess}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud background process
      effect: read
      questions:
      - What command and process count does a Cloud background process use?
      - Can I look up a Laravel Cloud background process by ID alone?
      instructions:
      - text: Show Cloud background process {backgroundProcess}.
        slots:
          backgroundProcess: path.backgroundProcess
      - text: Get the configuration of background process {backgroundProcess} on Laravel Cloud.
        slots:
          backgroundProcess: path.backgroundProcess
      method: generated
      generated: '2026-10-01'
- target: $.paths['/background-processes/{backgroundProcess}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a Cloud background process
      effect: destructive
      questions:
      - How do I stop and remove a worker from a Laravel Cloud instance?
      - Can I delete a Cloud background process by its ID?
      instructions:
      - text: Delete Cloud background process {backgroundProcess}.
        slots:
          backgroundProcess: path.backgroundProcess
      - text: Remove worker {backgroundProcess} from Laravel Cloud.
        slots:
          backgroundProcess: path.backgroundProcess
      method: generated
      generated: '2026-10-01'
- target: $.paths['/background-processes/{backgroundProcess}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Cloud background process
      effect: write
      questions:
      - Can I change the number of processes a Cloud worker runs?
      - How do I change the command of an existing Laravel Cloud background process?
      instructions:
      - text: Scale Cloud background process {backgroundProcess} to {processes} processes.
        slots:
          backgroundProcess: path.backgroundProcess
          processes: requestBody.processes
      - text: Change the command of Cloud background process {backgroundProcess} to {command}.
        slots:
          backgroundProcess: path.backgroundProcess
          command: requestBody.command
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes'].get
  update:
    x-apievangelist-phrasing:
      intent: List background processes on a Forge server
      effect: read
      questions:
      - Which supervisor daemons are running on my Forge server?
      - Can I filter a server's background processes by user, site or directory?
      instructions:
      - text: List the background processes on Forge server {server} in {organization}.
        slots:
          server: path.server
          organization: path.organization
      - text: Show daemons on server {server} in {organization} running as user {user}.
        slots:
          server: path.server
          organization: path.organization
          user: query.filter[user]
      - text: List background processes for site {site_id} on server {server} in {organization}.
        slots:
          site_id: query.filter[site_id]
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a supervisor daemon on a Forge server
      effect: write
      questions:
      - How do I keep a command running permanently under supervisor on my server?
      - Can I choose the user, directory and stop signal for a new daemon?
      instructions:
      - text: Create a daemon named {name} on server {server} in {organization} running {command} as {user} with {processes} processes.
        slots:
          name: requestBody.name
          server: path.server
          organization: path.organization
          command: requestBody.command
          user: requestBody.user
          processes: requestBody.processes
      - text: 'Start background process {name} on {server} in {organization}: run {command} as {user} from {directory}, {processes} processes.'
        slots:
          name: requestBody.name
          server: path.server
          organization: path.organization
          command: requestBody.command
          user: requestBody.user
          directory: requestBody.directory
          processes: requestBody.processes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a background process on a Forge server
      effect: read
      questions:
      - What are the settings of one daemon on my Forge server?
      - Can I check a server background process by its ID?
      instructions:
      - text: Show background process {backgroundProcess} on server {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      - text: Get daemon {backgroundProcess} details from Forge server {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a daemon's supervisor configuration
      effect: write
      questions:
      - How do I edit the supervisor config of a daemon on my server?
      - Can I rename a background process on a Forge server?
      instructions:
      - text: Rename daemon {backgroundProcess} on server {server} in {organization} to {name}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
          name: requestBody.name
      - text: Update the supervisor config of daemon {backgroundProcess} ({name}) on {server} in {organization} to {config}.
        slots:
          backgroundProcess: path.backgroundProcess
          name: requestBody.name
          server: path.server
          organization: path.organization
          config: requestBody.config
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a daemon from a Forge server
      effect: destructive
      questions:
      - How do I remove a supervisor daemon from my server?
      - Can I delete a server background process I no longer need?
      instructions:
      - text: Delete daemon {backgroundProcess} from server {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      - text: Remove background process {backgroundProcess} on Forge server {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/background-processes/{backgroundProcess}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Read a daemon's log output
      effect: read
      questions:
      - Why does my daemon keep restarting? Can I read its log?
      - Where do I see the output of a background process on my server?
      instructions:
      - text: Show the log of daemon {backgroundProcess} on server {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      - text: Fetch the output log for background process {backgroundProcess} on {server} in {organization}.
        slots:
          backgroundProcess: path.backgroundProcess
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'