# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Commands API
  version: 1.0.0
extends: openapi/laravel-commands-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: 8
- target: $.paths['/environments/{environment}/commands'].get
  update:
    x-apievangelist-phrasing:
      intent: List commands run on a Cloud environment
      effect: read
      questions:
      - Which commands have been run against my Laravel Cloud environment?
      - Can I filter an environment's command history by status or command text?
      instructions:
      - text: List the commands run on environment {environment}.
        slots:
          environment: path.environment
      - text: Find commands on environment {environment} matching {command}.
        slots:
          environment: path.environment
          command: query.filter[command]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/commands'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on a Cloud environment
      effect: write
      questions:
      - How do I run php artisan migrate on a cloud environment?
      - Can an agent execute a one-off command in an environment?
      instructions:
      - text: Run {command} on environment {environment}.
        slots:
          command: requestBody.command
          environment: path.environment
      - text: Execute the command {command} in cloud environment {environment}.
        slots:
          command: requestBody.command
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/commands/{command}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud command run's details
      effect: read
      questions:
      - Did the cloud command I ran finish successfully?
      - What output and status does a specific environment command have?
      instructions:
      - text: Show the details of cloud command {command}.
        slots:
          command: path.command
      - text: Check the status of environment command run {command}.
        slots:
          command: path.command
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/commands'].get
  update:
    x-apievangelist-phrasing:
      intent: List command runs on a Forge site
      effect: read
      questions:
      - Which commands have been run on my Forge site?
      - Can I filter a site's command history by the user who ran it?
      instructions:
      - text: List command runs for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show site {site} commands on server {server} ({organization}) run by user {user_id}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          user_id: query.filter[user_id]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/commands'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a command on a Forge site
      effect: write
      questions:
      - How do I run an artisan command in a site's directory on my server?
      - Can I execute a shell command for a site without SSHing in?
      instructions:
      - text: Run {command} on site {site} on server {server} in {organization}.
        slots:
          command: requestBody.command
          site: path.site
          server: path.server
          organization: path.organization
      - text: Execute {command} in site {site}'s directory on server {server}, org {organization}.
        slots:
          command: requestBody.command
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/commands/{command}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one command run on a Forge site
      effect: read
      questions:
      - What status did a specific site command finish with?
      - Can I look up one past command run on a site?
      instructions:
      - text: Show command run {command} on site {site}, server {server}, {organization}.
        slots:
          command: path.command
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get the details of site {site} command {command} on server {server} in {organization}.
        slots:
          site: path.site
          command: path.command
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/commands/{command}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a site command from history
      effect: destructive
      questions:
      - Can I clear a command I ran from a site's command history?
      - What removes one entry from a site's command log?
      instructions:
      - text: Delete command {command} from the history of site {site} on server {server} in {organization}.
        slots:
          command: path.command
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove command history entry {command} for site {site}, server {server}, org {organization}.
        slots:
          command: path.command
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/commands/{command}/output'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the output of a site command run
      effect: read
      questions:
      - What did a command print when it ran on my site?
      - Where do I find the console output of a site command?
      instructions:
      - text: Show the output of command {command} on site {site}, server {server}, {organization}.
        slots:
          command: path.command
          site: path.site
          server: path.server
          organization: path.organization
      - text: Fetch what site {site} command {command} printed on server {server} in {organization}.
        slots:
          site: path.site
          command: path.command
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'