# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Cloud Environments API
  version: 1.0.0
extends: openapi/laravel-environments-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: 12
- target: $.paths['/applications/{application}/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an application's environments
      effect: read
      questions:
      - Which environments does my Laravel Cloud application have?
      - Can I filter an app's environments by status or name?
      instructions:
      - text: List environments for application {application}.
        slots:
          application: path.application
      - text: Show environments of {application} with status {status}.
        slots:
          application: path.application
          status: query.filter[status]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/applications/{application}/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an environment for an application
      effect: write
      questions:
      - How do I add a staging environment to my application?
      - Can a new environment deploy from a different git branch?
      instructions:
      - text: Create environment {name} on application {application} from branch {branch}.
        slots:
          name: requestBody.name
          application: path.application
          branch: requestBody.branch
      - text: Add a {name} environment to {application} tracking branch {branch} on cluster {cluster_id}.
        slots:
          name: requestBody.name
          application: path.application
          branch: requestBody.branch
          cluster_id: requestBody.cluster_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Search an environment's logs
      effect: read
      questions:
      - Where can I read the application logs for an environment over a time range?
      - Can I search environment logs for a word with case sensitivity?
      instructions:
      - text: Get logs for environment {environment} from {from} to {to}.
        slots:
          environment: path.environment
          from: query.from
          to: query.to
      - text: Search logs of {environment} for {query} between {from} and {to}.
        slots:
          environment: path.environment
          query: query.query
          from: query.from
          to: query.to
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's details
      effect: read
      questions:
      - What are the settings of a specific environment?
      - Which branch and PHP version does an environment use?
      instructions:
      - text: Show environment {environment}.
        slots:
          environment: path.environment
      - text: Get details of environment {environment} including {include}.
        slots:
          environment: path.environment
          include: query.include
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an environment
      effect: destructive
      questions:
      - How do I delete an environment I no longer need?
      - Can I permanently remove a preview environment?
      instructions:
      - text: Delete environment {environment}.
        slots:
          environment: path.environment
      - text: Tear down and remove environment {environment}.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an environment's settings
      effect: write
      questions:
      - How do I change the branch or PHP version an environment deploys?
      - Can I turn on Octane or push-to-deploy for an environment?
      instructions:
      - text: Set the PHP version of environment {environment} to {php_version}.
        slots:
          environment: path.environment
          php_version: requestBody.php_version
      - text: Change environment {environment} to deploy branch {branch} with build command {build_command}.
        slots:
          environment: path.environment
          branch: requestBody.branch
          build_command: requestBody.build_command
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an environment and deploy
      effect: write
      questions:
      - How do I start a stopped environment?
      - Can I restart an environment on the same commit instead of the latest one?
      instructions:
      - text: Start environment {environment}.
        slots:
          environment: path.environment
      - text: 'Start {environment} and redeploy the last commit: {redeploy}.'
        slots:
          environment: path.environment
          redeploy: requestBody.redeploy
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/stop'].post
  update:
    x-apievangelist-phrasing:
      intent: Stop an environment
      effect: destructive
      questions:
      - How do I stop an environment that is running?
      - Will stopping an environment cancel the deployment in progress?
      instructions:
      - text: Stop environment {environment}.
        slots:
          environment: path.environment
      - text: Shut down {environment} and cancel its running deployment.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/purge-edge-cache'].post
  update:
    x-apievangelist-phrasing:
      intent: Purge an environment's edge cache
      effect: write
      questions:
      - How do I clear the CDN cache for all my environment's domains?
      - Can I purge cached pages at the edge after a content change?
      instructions:
      - text: Purge the edge cache for environment {environment}.
        slots:
          environment: path.environment
      - text: Clear cached responses at the edge for every domain on {environment}.
        slots:
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Add environment variables
      effect: write
      questions:
      - How do I add .env variables to an environment?
      - Can I append variables or must I replace the whole set?
      instructions:
      - text: Add variables {variables} to environment {environment}.
        slots:
          variables: requestBody.variables
          environment: path.environment
      - text: Set environment variables {variables} on {environment} using method {method}.
        slots:
          variables: requestBody.variables
          environment: path.environment
          method: requestBody.method
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/variables/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove environment variables by key
      effect: destructive
      questions:
      - How do I delete specific .env keys from an environment?
      - What happens if one of the variable keys I remove doesn't exist?
      instructions:
      - text: Delete variables {keys} from environment {environment}.
        slots:
          keys: requestBody.keys
          environment: path.environment
      - text: Remove env keys {keys} from {environment}.
        slots:
          keys: requestBody.keys
          environment: path.environment
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environment}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an environment's metrics
      effect: read
      questions:
      - How is my environment performing in terms of CPU and requests?
      - Can I see environment metrics for a chosen time period?
      instructions:
      - text: Show metrics for environment {environment}.
        slots:
          environment: path.environment
      - text: Get metrics for {environment} over period {period}.
        slots:
          environment: path.environment
          period: query.period
      method: generated
      generated: '2026-10-01'