API Evangelist conversational phrasing for Forge Integrations API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Forge Integrations API
  version: 1.0.0
extends: openapi/laravel-integrations-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: 20
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Horizon is enabled on a site
      effect: read
      questions:
      - Is Laravel Horizon set up to run the queue workers on my site?
      - Can I check the Horizon integration status for a Forge site?
      instructions:
      - text: Check the Horizon integration status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me if Horizon is enabled for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Laravel Horizon on a site
      effect: write
      questions:
      - How do I turn on Horizon so my site's Redis queues are managed?
      - Can I enable the Horizon integration through the API?
      instructions:
      - text: Enable Horizon on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Set up the Laravel Horizon integration for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/horizon'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable Laravel Horizon on a site
      effect: destructive
      questions:
      - Can I remove Horizon from a site that no longer uses queues?
      - What turns off the Horizon integration for a site?
      instructions:
      - text: Disable Horizon on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove the Laravel Horizon integration from site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Octane is enabled on a site
      effect: read
      questions:
      - Is my site being served by Laravel Octane?
      - How can I see if the Octane integration is turned on for a site?
      instructions:
      - text: Check the Octane integration status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me whether Octane is enabled for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Laravel Octane on a site
      effect: write
      questions:
      - Can I run my site on Octane with a specific port and server engine?
      - Which settings does enabling Octane on a site require?
      instructions:
      - text: Enable Octane on site {site} (server {server}, {organization}) using the {engine} engine on port {port}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          engine: requestBody.server
          port: requestBody.port
      - text: Turn on Laravel Octane for site {site} on server {server} in {organization} listening on port {port}, engine {engine}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          port: requestBody.port
          engine: requestBody.server
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/octane'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable Laravel Octane on a site
      effect: destructive
      questions:
      - How do I move a site off Octane back to regular PHP-FPM serving?
      - Can I switch off the Octane integration for one site?
      instructions:
      - text: Disable Octane on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove the Laravel Octane integration from site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Reverb is enabled on a site
      effect: read
      questions:
      - Is the Reverb WebSocket server running for my site?
      - Can I check the Reverb integration status of a site?
      instructions:
      - text: Check the Reverb integration status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me whether Reverb is enabled for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Laravel Reverb on a site
      effect: write
      questions:
      - How do I set up Reverb WebSockets on a site with my own host, port and connection limit?
      - What do I need to provide to enable Reverb for a site?
      instructions:
      - text: Enable Reverb on site {site} (server {server}, {organization}) at host {host}, port {port}, max {connections} connections.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          host: requestBody.host
          port: requestBody.port
          connections: requestBody.connections
      - text: Set up Laravel Reverb for site {site} on server {server} in {organization} with host {host}, port {port} and {connections} connections.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          host: requestBody.host
          port: requestBody.port
          connections: requestBody.connections
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/reverb'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable Laravel Reverb on a site
      effect: destructive
      questions:
      - Can I shut down the Reverb WebSocket server for a site?
      - What removes the Reverb integration from a site?
      instructions:
      - text: Disable Reverb on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove the Laravel Reverb integration from site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Inertia SSR is enabled on a site
      effect: read
      questions:
      - Is Inertia server-side rendering enabled for my site?
      - Can I check a site's Inertia SSR integration status?
      instructions:
      - text: Check the Inertia SSR status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me whether Inertia SSR is on for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/inertia'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Inertia SSR on a site
      effect: write
      questions:
      - How do I turn on Inertia server-side rendering for a site?
      - Can the Inertia SSR process be enabled from the API?
      instructions:
      - text: Enable Inertia SSR on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Set up the Inertia integration for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether Pulse is enabled on a site
      effect: read
      questions:
      - Is Laravel Pulse monitoring switched on for my site?
      - Can I check a site's Pulse integration status?
      instructions:
      - text: Check the Pulse integration status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me whether Pulse is enabled for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable Laravel Pulse on a site
      effect: write
      questions:
      - How do I start collecting Pulse performance metrics for a site?
      - Can the Pulse integration be enabled through the API?
      instructions:
      - text: Enable Pulse on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Set up the Laravel Pulse integration for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/pulse'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable Laravel Pulse on a site
      effect: destructive
      questions:
      - Can I turn off Pulse monitoring for a site?
      - What removes the Pulse integration from a site?
      instructions:
      - text: Disable Pulse on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove the Laravel Pulse integration from site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a site is in maintenance mode
      effect: read
      questions:
      - Is my site currently down for maintenance?
      - Can I check a site's maintenance mode status?
      instructions:
      - text: Check whether site {site} on server {server} in {organization} is in maintenance mode.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show the maintenance mode status of site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance'].post
  update:
    x-apievangelist-phrasing:
      intent: Put a site into maintenance mode
      effect: write
      questions:
      - How do I take my site down for maintenance with a bypass secret?
      - Can maintenance mode redirect visitors and return a custom HTTP status?
      instructions:
      - text: Put site {site} on server {server} in {organization} into maintenance mode with status {status}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          status: requestBody.status
      - text: Enable maintenance on site {site} (server {server}, {organization}) returning {status}, bypass secret {secret}, redirect to {redirect}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          status: requestBody.status
          secret: requestBody.secret
          redirect: requestBody.redirect
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-maintenance'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bring a site out of maintenance mode
      effect: destructive
      questions:
      - How do I bring my site back online after maintenance?
      - Can an agent lift maintenance mode on a site?
      instructions:
      - text: Take site {site} on server {server} in {organization} out of maintenance mode.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Disable maintenance mode for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether the Laravel scheduler runs for a site
      effect: read
      questions:
      - Is the scheduler cron job running my site's scheduled tasks?
      - Can I check if the Laravel Scheduler integration is enabled on a site?
      instructions:
      - text: Check the scheduler integration status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me whether schedule:run is set up for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable the Laravel scheduler job for a site
      effect: write
      questions:
      - How do I get my site's scheduled commands to actually run on the server?
      - Can I create the scheduler job for a site through the API?
      instructions:
      - text: Enable the Laravel Scheduler job for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Start running scheduled tasks for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/integrations/laravel-scheduler'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable the Laravel scheduler job for a site
      effect: destructive
      questions:
      - Can I stop a site's scheduled tasks from running?
      - What removes the scheduler integration job from a site?
      instructions:
      - text: Remove the Laravel Scheduler job from site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Stop scheduled tasks running for site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'