# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Deployments API
  version: 1.0.0
extends: openapi/laravel-deployments-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: 23
- target: $.paths['/environments/{environment}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployments for a Cloud environment
      effect: read
      questions:
      - Which deployments have run against my Laravel Cloud environment?
      - Can I filter an environment's deployments by branch name or commit hash?
      - How do I find failed deployments for one environment?
      instructions:
      - text: List the deployments for environment {environment}.
        slots:
          environment: path.environment
      - text: Show environment {environment} deployments from branch {branch}.
        slots:
          environment: path.environment
          branch: query.filter[branch_name]
      - text: Find deployments of environment {environment} with status {status}.
        slots:
          environment: path.environment
          status: query.filter[status]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a Cloud environment
      effect: write
      questions:
      - How do I kick off a new deployment of a cloud environment?
      - Can an agent start an environment deploy without opening the dashboard?
      instructions:
      - text: Start a deployment of environment {environment}.
        slots:
          environment: path.environment
      - text: Redeploy the cloud environment {environment} now.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deployments/{deployment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Cloud deployment's details
      effect: read
      questions:
      - What is the status of a specific cloud deployment I started?
      - Which commit and branch did a given environment deployment use?
      instructions:
      - text: Show the details of cloud deployment {deployment}.
        slots:
          deployment: path.deployment
      - text: Check whether cloud deployment {deployment} has finished.
        slots:
          deployment: path.deployment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deployments/{deployment}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Read build and deploy logs for a Cloud deployment
      effect: read
      questions:
      - Where can I see the build logs for a cloud deployment that failed?
      - Does the API return both build and deploy step logs for an environment deployment?
      instructions:
      - text: Fetch the build and deploy logs for cloud deployment {deployment}.
        slots:
          deployment: path.deployment
      - text: Show me why cloud deployment {deployment} broke by pulling its logs.
        slots:
          deployment: path.deployment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List deployment webhooks for a Forge site
      effect: read
      questions:
      - Which webhook URLs get notified when my Forge site deploys?
      - Can I page through and sort a site's deployment webhooks?
      instructions:
      - text: List the deployment webhooks on site {site} of server {server} in organization {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show every webhook configured for site {site} on 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}/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a deployment webhook to a site
      effect: write
      questions:
      - How can I get pinged at my own URL every time a site finishes deploying?
      - Can I register a webhook endpoint for a Forge site's deployments?
      instructions:
      - text: Add a deployment webhook to {url} for site {site} on server {server} in org {organization}.
        slots:
          url: requestBody.url
          site: path.site
          server: path.server
          organization: path.organization
      - text: Notify {url} whenever site {site} on server {server} ({organization}) deploys.
        slots:
          url: requestBody.url
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one deployment webhook on a site
      effect: read
      questions:
      - What URL does a particular site deployment webhook point to?
      - Can I look up a single site webhook by its ID?
      instructions:
      - text: Show webhook {deploymentWebhook} on site {site}, server {server}, organization {organization}.
        slots:
          deploymentWebhook: path.deploymentWebhook
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get the details of deployment webhook {deploymentWebhook} for site {site} on server {server} in {organization}.
        slots:
          deploymentWebhook: path.deploymentWebhook
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/webhooks/{deploymentWebhook}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a deployment webhook from a site
      effect: destructive
      questions:
      - How do I stop a site from calling an old webhook URL after deploys?
      - Can I delete just one deployment webhook and keep the others on the site?
      instructions:
      - text: Delete webhook {deploymentWebhook} from site {site} on server {server} in org {organization}.
        slots:
          deploymentWebhook: path.deploymentWebhook
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove deployment webhook {deploymentWebhook} from site {site}, server {server}, {organization}.
        slots:
          deploymentWebhook: path.deploymentWebhook
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List recent deployments of a Forge site
      effect: read
      questions:
      - What were the recent deployments of my Forge site?
      - Can I filter a site's deployment history by commit author or commit message?
      instructions:
      - text: List recent deployments for site {site} on server {server} in organization {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Find deployments of site {site} on server {server} ({organization}) authored by {author}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          author: query.filter[commit_author]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Trigger a deployment of a Forge site
      effect: write
      questions:
      - How do I deploy the latest code to a site on my server?
      - Can I trigger a site deployment from a script instead of the deploy button?
      instructions:
      - text: Deploy site {site} on server {server} in organization {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Trigger a new deployment for site {site} on 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}/deployments/status'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a site's current deployment state
      effect: read
      questions:
      - Is a deployment currently running on my site right now?
      - What deployment state is a Forge site stuck in?
      instructions:
      - text: Check the current deployment status of site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Tell me if site {site} on server {server} ({organization}) is mid-deploy.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments/status'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a site's stuck deployment state
      effect: destructive
      questions:
      - My site says it's still deploying but nothing is happening — can I reset that?
      - How do I clear a stuck deployment state on a site?
      instructions:
      - text: Reset the deployment state for site {site} on server {server} in organization {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Clear the stuck deploy status on site {site}, server {server}, {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}/deployments/script'].get
  update:
    x-apievangelist-phrasing:
      intent: View a site's deployment script
      effect: read
      questions:
      - What commands run when my site deploys?
      - Where can I read the current deploy script for a site?
      instructions:
      - text: Show the deployment script for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Print the deploy script of site {site}, server {server}, organization {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}/deployments/script'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a site's deployment script
      effect: write
      questions:
      - Can I change the commands my site runs on deploy, like adding a migration step?
      - Is there an option to auto-source environment variables in the deploy script?
      instructions:
      - text: Set the deploy script for site {site} on server {server} in {organization} to {content}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          content: requestBody.content
      - text: Replace site {site}'s deploy script on server {server} ({organization}) with {content} and auto-source env {auto_source}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
          content: requestBody.content
          auto_source: requestBody.auto_source
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments/deploy-hook'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's deployment trigger URL
      effect: read
      questions:
      - What URL can my CI call to trigger a deploy of a site?
      - Where do I find the deploy hook URL for a site?
      instructions:
      - text: Get the deployment trigger URL for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Show the deploy hook URL 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}/deployments/deploy-hook'].put
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a site's deploy hook token
      effect: write
      questions:
      - My deploy trigger URL leaked — can I rotate its token?
      - How do I regenerate the token in a site's deployment trigger URL?
      instructions:
      - text: Regenerate the deploy hook token for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Rotate the deployment trigger URL of site {site}, server {server}, organization {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}/deployments/push-to-deploy'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable push to deploy for a site
      effect: write
      questions:
      - Can my site deploy automatically every time I push to the repository?
      - How do I turn on push to deploy for a site?
      instructions:
      - text: Enable push to deploy on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Make site {site} on server {server} ({organization}) auto-deploy on every git push.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments/push-to-deploy'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable push to deploy for a site
      effect: destructive
      questions:
      - Can I stop a site from auto-deploying when I push code?
      - What turns off push to deploy so I deploy manually again?
      instructions:
      - text: Disable push to deploy on site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Turn off automatic git-push deploys 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}/deployments/{deployment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one deployment of a Forge site
      effect: read
      questions:
      - Which commit did a particular site deployment ship?
      - Can I look up a single past deployment on a Forge site?
      instructions:
      - text: Show deployment {deployment} of site {site} on server {server} in {organization}.
        slots:
          deployment: path.deployment
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get the details of site deployment {deployment} for site {site}, server {server}, org {organization}.
        slots:
          deployment: path.deployment
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deployments/{deployment}/log'].get
  update:
    x-apievangelist-phrasing:
      intent: Read the output of a site deployment
      effect: read
      questions:
      - What did the deploy script print during a specific site deployment?
      - Where is the output of a site deployment that failed on my server?
      instructions:
      - text: Show the output of deployment {deployment} on site {site}, server {server}, {organization}.
        slots:
          deployment: path.deployment
          site: path.site
          server: path.server
          organization: path.organization
      - text: Fetch the deploy script output for site {site} deployment {deployment} on server {server} in {organization}.
        slots:
          deployment: path.deployment
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/servers/{server}/sites/{site}/deploy-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a site's repository deploy key
      effect: read
      questions:
      - What SSH deploy key should I add to my git repository for this site?
      - Does my site already have a deploy key?
      instructions:
      - text: Show the deploy key for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Get the public deploy key 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}/deploy-key'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a repository deploy key for a site
      effect: write
      questions:
      - How do I generate a deploy key so the site can pull from a private repo?
      - What happens if I create a deploy key for a site that already has one?
      instructions:
      - text: Create a deploy key for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Generate a repository deploy key 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}/deploy-key'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a site's repository deploy key
      effect: destructive
      questions:
      - Can I revoke the deploy key a site uses to access its repository?
      - How do I delete a site's deploy key?
      instructions:
      - text: Delete the deploy key for site {site} on server {server} in {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      - text: Remove the repository deploy key from site {site}, server {server}, org {organization}.
        slots:
          site: path.site
          server: path.server
          organization: path.organization
      method: generated
      generated: '2026-10-01'