Acquia · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Acquia Cloud API Documentation Environments API

103 actions 103 updates phrasing extends openapi/acquia-environments-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Acquia's API. It is a proposal applied on top of the contract, not a document Acquia publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 103 · first 16 shown; the file carries all of them

$.info
$.paths['/environments/{environmentId}'].get
$.paths['/environments/{environmentId}'].put
$.paths['/environments/{environmentId}'].delete
$.paths['/environments/{environmentId}'].options
$.paths['/environments/{environmentId}/actions/clear-caches'].post
$.paths['/environments/{environmentId}/actions/change-label'].post
$.paths['/environments/{environmentId}/artifacts/actions/switch'].post
$.paths['/environments/{environmentId}/operating-systems'].get
$.paths['/environments/{environmentId}/available-runtimes'].get
$.paths['/environments/{environmentId}/cdn'].get
$.paths['/environments/{environmentId}/cdn'].post
$.paths['/environments/{environmentId}/cdn'].delete
$.paths['/environments/{environmentId}/cloud-actions'].get
$.paths['/environments/{environmentId}/cloud-actions'].put
$.paths['/environments/{environmentId}/cloud-actions/actions/disable'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Acquia Cloud API Documentation Environments API
  version: 1.0.0
extends: openapi/acquia-environments-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 102
- target: $.paths['/environments/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View details of one environment
      effect: read
      questions:
      - What are the settings and status of a specific Acquia environment?
      - Can I pull up an environment's details by its ID?
      instructions:
      - text: Get the details of environment {env}.
        slots:
          env: path.environmentId
      - text: Show me everything about environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change PHP and runtime settings on an environment
      effect: write
      questions:
      - How do I raise the PHP memory limit on an environment?
      - Can I change the PHP version or max execution time for one environment?
      - Which environment-level PHP settings like opcache and upload size can I tune?
      instructions:
      - text: Set the PHP version on environment {env} to {version}.
        slots:
          env: path.environmentId
          version: requestBody.version
      - text: Raise the PHP memory limit on environment {env} to {memory_limit}.
        slots:
          env: path.environmentId
          memory_limit: requestBody.memory_limit
      - text: Set upload max filesize to {upload_max_filesize} and max execution time to {max_execution_time} on environment {env}.
        slots:
          upload_max_filesize: requestBody.upload_max_filesize
          max_execution_time: requestBody.max_execution_time
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CD environment
      effect: destructive
      questions:
      - Can I tear down a continuous delivery environment I no longer need?
      - What's the way to delete a CD environment by its ID?
      instructions:
      - text: Delete CD environment {env}.
        slots:
          env: path.environmentId
      - text: Tear down continuous delivery environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}'].options
  update:
    x-apievangelist-phrasing:
      intent: See configurable options for an environment
      effect: read
      questions:
      - What configuration options are allowed for this environment?
      - Which values can I choose from before modifying an environment?
      instructions:
      - text: Show the available options for environment {env}.
        slots:
          env: path.environmentId
      - text: Display the allowed configuration choices on environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/actions/clear-caches'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear Varnish and CDN caches for several domains
      effect: write
      questions:
      - Can I purge both Varnish and Platform CDN caches for a batch of domains at once?
      - What clears the full cache for multiple domains on one environment?
      instructions:
      - text: Clear Varnish and CDN caches for domains {domains} on environment {env}.
        slots:
          domains: requestBody.domains
          env: path.environmentId
      - text: Purge all caches, CDN included, for {domains} on environment {env}.
        slots:
          domains: requestBody.domains
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/actions/change-label'].post
  update:
    x-apievangelist-phrasing:
      intent: Rename an environment's label
      effect: write
      questions:
      - How do I change the display label of an environment?
      - Can I rename an environment to something more descriptive?
      instructions:
      - text: Change the label of environment {env} to {label}.
        slots:
          env: path.environmentId
          label: requestBody.label
      - text: Relabel environment {env} as {label}.
        slots:
          env: path.environmentId
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/artifacts/actions/switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy a build artifact to an environment
      effect: write
      questions:
      - Can I deploy a specific build artifact to an environment?
      - What switches an environment over to a different artifact?
      instructions:
      - text: Deploy artifact {artifact} to environment {env}.
        slots:
          artifact: requestBody.artifact_id
          env: path.environmentId
      - text: Switch environment {env} to build artifact {artifact}.
        slots:
          env: path.environmentId
          artifact: requestBody.artifact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/operating-systems'].get
  update:
    x-apievangelist-phrasing:
      intent: List operating systems for an environment
      effect: read
      questions:
      - Which operating systems can this environment run on?
      - What OS options are offered for an environment?
      instructions:
      - text: List the operating systems available to environment {env}.
        slots:
          env: path.environmentId
      - text: Show OS choices for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/available-runtimes'].get
  update:
    x-apievangelist-phrasing:
      intent: List runtimes available to an environment
      effect: read
      questions:
      - What runtimes can I pick for this environment?
      - Which runtime versions are available before I upgrade an environment?
      instructions:
      - text: List the available runtimes for environment {env}.
        slots:
          env: path.environmentId
      - text: Show which runtimes environment {env} can switch to.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cdn'].get
  update:
    x-apievangelist-phrasing:
      intent: Check CDN status on an environment
      effect: read
      questions:
      - Is the CDN enabled and healthy on this environment?
      - What's the current CDN status for one of my environments?
      instructions:
      - text: Check the CDN status on environment {env}.
        slots:
          env: path.environmentId
      - text: Tell me whether the CDN is on for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cdn'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable the CDN on an environment
      effect: write
      questions:
      - How do I turn on the CDN for an environment?
      - Can I put a CDN in front of one environment?
      instructions:
      - text: Enable the CDN on environment {env}.
        slots:
          env: path.environmentId
      - text: Turn on CDN delivery for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cdn'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disable the CDN on an environment
      effect: destructive
      questions:
      - Can I switch off the CDN for an environment?
      - What removes CDN delivery from an environment?
      instructions:
      - text: Disable the CDN on environment {env}.
        slots:
          env: path.environmentId
      - text: Turn off CDN delivery for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cloud-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List Cloud Actions configured on an environment
      effect: read
      questions:
      - Which Cloud Actions run on this environment after a deploy?
      - What post-deploy actions are configured for an environment?
      instructions:
      - text: List the Cloud Actions on environment {env}.
        slots:
          env: path.environmentId
      - text: Show which Cloud Actions are set for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cloud-actions'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the set of Cloud Actions on an environment
      effect: write
      questions:
      - Can I edit which Cloud Actions run on an environment?
      - How do I replace the Cloud Actions list for an environment?
      instructions:
      - text: Set the Cloud Actions on environment {env} to {cloud_actions}.
        slots:
          env: path.environmentId
          cloud_actions: requestBody.cloud-actions
      - text: Update environment {env} so its Cloud Actions are {cloud_actions}.
        slots:
          env: path.environmentId
          cloud_actions: requestBody.cloud-actions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cloud-actions/actions/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn off Cloud Actions on an environment
      effect: write
      questions:
      - Can I stop Cloud Actions from running on an environment?
      - What disables all Cloud Actions for one environment?
      instructions:
      - text: Disable Cloud Actions on environment {env}.
        slots:
          env: path.environmentId
      - text: Stop Cloud Actions from running on environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cloud-actions/actions/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Turn on Cloud Actions on an environment
      effect: write
      questions:
      - How do I re-enable Cloud Actions that were switched off?
      - Can Cloud Actions be turned back on for an environment?
      instructions:
      - text: Enable Cloud Actions on environment {env}.
        slots:
          env: path.environmentId
      - text: Switch Cloud Actions back on for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/cloud-actions/actions/reset'].post
  update:
    x-apievangelist-phrasing:
      intent: Reset Cloud Actions to defaults
      effect: write
      questions:
      - Can I restore an environment's Cloud Actions to the default set?
      - What undoes my custom Cloud Actions changes on an environment?
      instructions:
      - text: Reset Cloud Actions on environment {env} to the defaults.
        slots:
          env: path.environmentId
      - text: Restore the default Cloud Actions for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/code'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy code from another environment
      effect: write
      questions:
      - How do I promote code from staging to production?
      - Can I attach a deploy message when pushing code to an environment?
      instructions:
      - text: Deploy code from environment {source} to environment {env}.
        slots:
          source: requestBody.source
          env: path.environmentId
      - text: Promote the code on {source} to environment {env} with message {message}.
        slots:
          source: requestBody.source
          env: path.environmentId
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/code/actions/switch'].post
  update:
    x-apievangelist-phrasing:
      intent: Switch an environment to a branch or tag
      effect: write
      questions:
      - Can I point an environment at a different git branch or release tag?
      - What checks out a new branch on a single environment?
      instructions:
      - text: Switch environment {env} to branch or tag {branch}.
        slots:
          env: path.environmentId
          branch: requestBody.branch
      - text: Check out {branch} on environment {env}.
        slots:
          branch: requestBody.branch
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/code/actions/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import a site into an environment
      effect: write
      questions:
      - Can I import an existing site archive from a URL into an environment?
      - What brings an external site into one of my environments?
      instructions:
      - text: Import the site at {url} into environment {env}.
        slots:
          url: requestBody.url
          env: path.environmentId
      - text: Import site {name} from {url} to environment {env}.
        slots:
          name: requestBody.name
          url: requestBody.url
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons'].get
  update:
    x-apievangelist-phrasing:
      intent: List cron jobs on an environment
      effect: read
      questions:
      - Which scheduled cron jobs are set up on this environment?
      - What cron tasks run on an environment?
      instructions:
      - text: List the cron jobs on environment {env}.
        slots:
          env: path.environmentId
      - text: Show all scheduled jobs for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons'].post
  update:
    x-apievangelist-phrasing:
      intent: Schedule a new cron job
      effect: write
      questions:
      - How do I schedule a drush command to run every hour?
      - Can I add a new cron job with its own label and frequency?
      instructions:
      - text: Create a cron job {label} on environment {env} running {command} at {frequency}.
        slots:
          label: requestBody.label
          env: path.environmentId
          command: requestBody.command
          frequency: requestBody.frequency
      - text: Schedule {command} on environment {env} with cron frequency {frequency}, labeled {label}.
        slots:
          command: requestBody.command
          env: path.environmentId
          frequency: requestBody.frequency
          label: requestBody.label
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons/{cronId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one cron job
      effect: read
      questions:
      - What command and schedule does a specific cron job use?
      - Is a particular cron job enabled?
      instructions:
      - text: Get cron job {cron} on environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      - text: Show the schedule and command of cron {cron} in environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons/{cronId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit an existing cron job
      effect: write
      questions:
      - Can I change how often an existing cron job runs?
      - What updates the command of a scheduled job I already created?
      instructions:
      - text: Change cron job {cron} on environment {env} to run at {frequency}.
        slots:
          cron: path.cronId
          env: path.environmentId
          frequency: requestBody.frequency
      - text: Update existing cron {cron} in environment {env} to run command {command}.
        slots:
          cron: path.cronId
          env: path.environmentId
          command: requestBody.command
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons/{cronId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cron job
      effect: destructive
      questions:
      - Can I permanently remove a cron job from an environment?
      - What deletes a scheduled job rather than just pausing it?
      instructions:
      - text: Delete cron job {cron} from environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      - text: Remove scheduled job {cron} on environment {env} for good.
        slots:
          cron: path.cronId
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons/{cronId}/actions/enable'].post
  update:
    x-apievangelist-phrasing:
      intent: Enable a paused cron job
      effect: write
      questions:
      - How do I resume a cron job that was disabled?
      - Can I switch a paused scheduled job back on?
      instructions:
      - text: Enable cron job {cron} on environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      - text: Resume scheduled job {cron} in environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/crons/{cronId}/actions/disable'].post
  update:
    x-apievangelist-phrasing:
      intent: Pause a cron job
      effect: write
      questions:
      - Can I pause a cron job without deleting it?
      - What temporarily stops a scheduled job from running?
      instructions:
      - text: Disable cron job {cron} on environment {env}.
        slots:
          cron: path.cronId
          env: path.environmentId
      - text: Pause scheduled job {cron} in environment {env} without deleting it.
        slots:
          cron: path.cronId
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases'].get
  update:
    x-apievangelist-phrasing:
      intent: List databases on an environment
      effect: read
      questions:
      - Which databases exist on this environment?
      - Can I filter an environment's databases by name?
      instructions:
      - text: List the databases on environment {env}.
        slots:
          env: path.environmentId
      - text: Find databases on environment {env} matching {filter}.
        slots:
          env: path.environmentId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy a database from another environment
      effect: write
      questions:
      - How do I copy the production database down to staging?
      - Can I copy one named database from another environment into this one?
      instructions:
      - text: Copy database {name} from environment {source} to environment {env}.
        slots:
          name: requestBody.name
          source: requestBody.source
          env: path.environmentId
      - text: Bring database {name} over from {source} into environment {env}.
        slots:
          name: requestBody.name
          source: requestBody.source
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one database on an environment
      effect: read
      questions:
      - What are the connection details and info for a specific database?
      - Can I look up one database on an environment by name?
      instructions:
      - text: Get database {database} on environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      - text: Show the details of the {database} database in environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/php-config'].get
  update:
    x-apievangelist-phrasing:
      intent: Get PHP configuration for a database
      effect: read
      questions:
      - What PHP settings file does my app need to connect to a database?
      - Can I fetch the PHP config snippet for a specific database?
      instructions:
      - text: Show the PHP configuration for database {database} on environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      - text: Get PHP connection settings for {database} in environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups'].get
  update:
    x-apievangelist-phrasing:
      intent: List backups of a database
      effect: read
      questions:
      - What backups exist for my production database?
      - Can I list database backups taken within a date range?
      - Which backups were manual versus scheduled?
      instructions:
      - text: List backups of database {database} on environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      - text: Show backups of {database} in environment {env} created between {from} and {to}.
        slots:
          database: path.databaseName
          env: path.environmentId
          from: query.from
          to: query.to
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups'].post
  update:
    x-apievangelist-phrasing:
      intent: Take an on-demand database backup
      effect: write
      questions:
      - How do I back up a database right before a risky deploy?
      - Can I trigger a manual database backup now?
      instructions:
      - text: Create a backup of database {database} on environment {env}.
        slots:
          database: path.databaseName
          env: path.environmentId
      - text: Back up {database} in environment {env} right now.
        slots:
          database: path.databaseName
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups/{backupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one database backup
      effect: read
      questions:
      - When was a specific backup taken and what type is it?
      - Can I look up the details of a single database backup?
      instructions:
      - text: Get backup {backup} of database {database} on environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      - text: Show details for backup {backup} of {database} in environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups/{backupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a database backup
      effect: destructive
      questions:
      - Can I delete an old database backup I no longer need?
      - What removes a specific backup permanently?
      instructions:
      - text: Delete backup {backup} of database {database} on environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      - text: Remove database backup {backup} for {database} from environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/download'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a database backup file
      effect: read
      questions:
      - How do I download a database backup to my machine?
      - Can I get the backup file itself rather than just its metadata?
      instructions:
      - text: Download backup {backup} of database {database} from environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      - text: Get the file for {database} backup {backup} on environment {env}.
        slots:
          database: path.databaseName
          backup: path.backupId
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/databases/{databaseName}/backups/{backupId}/actions/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a database from a backup
      effect: destructive
      questions:
      - Can I roll a database back to an earlier backup after a bad deploy?
      - What restores a backup over the current database?
      instructions:
      - text: Restore backup {backup} to database {database} on environment {env}.
        slots:
          backup: path.backupId
          database: path.databaseName
          env: path.environmentId
      - text: Roll {database} in environment {env} back to backup {backup}.
        slots:
          database: path.databaseName
          env: path.environmentId
          backup: path.backupId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/dns'].get
  update:
    x-apievangelist-phrasing:
      intent: Get DNS setup details for an environment
      effect: read
      questions:
      - What DNS records should I point my apex domain and subdomains at?
      - Which IPs and CNAMEs does an environment expect for DNS?
      instructions:
      - text: Show the DNS configuration for environment {env}.
        slots:
          env: path.environmentId
      - text: Tell me what DNS records to set for environment {env}.
        slots:
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains'].get
  update:
    x-apievangelist-phrasing:
      intent: List domains attached to an environment
      effect: read
      questions:
      - Which domains are attached to this environment?
      - Can I search an environment's domains by hostname?
      instructions:
      - text: List the domains on environment {env}.
        slots:
          env: path.environmentId
      - text: Find domains on environment {env} with hostname matching {filter}.
        slots:
          env: path.environmentId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a domain to an environment
      effect: write
      questions:
      - How do I attach a new hostname to an environment?
      - Can I add a custom domain to my production environment?
      instructions:
      - text: Add domain {hostname} to environment {env}.
        slots:
          hostname: requestBody.hostname
          env: path.environmentId
      - text: Attach hostname {hostname} to environment {env}.
        slots:
          hostname: requestBody.hostname
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains/actions/clear-varnish'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear Varnish only for several domains
      effect: write
      questions:
      - Can I flush just the Varnish cache for a list of domains, leaving the CDN alone?
      - What purges Varnish for multiple domains in one request?
      instructions:
      - text: Clear only the Varnish cache for domains {domains} on environment {env}.
        slots:
          domains: requestBody.domains
          env: path.environmentId
      - text: Flush Varnish for the domain list {domains} in environment {env}.
        slots:
          domains: requestBody.domains
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains/{domain}'].get
  update:
    x-apievangelist-phrasing:
      intent: View one domain on an environment
      effect: read
      questions:
      - What are the details of a specific domain on my environment?
      - Is a particular hostname attached to this environment?
      instructions:
      - text: Get domain {domain} on environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      - text: Show the record for hostname {domain} in environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains/{domain}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a domain from an environment
      effect: destructive
      questions:
      - Can I detach a hostname I no longer use from an environment?
      - What removes a domain from an environment?
      instructions:
      - text: Remove domain {domain} from environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      - text: Detach hostname {domain} from environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains/{domain}/actions/clear-varnish'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear Varnish for a single domain
      effect: write
      questions:
      - Can I purge the Varnish cache for just one domain?
      - What flushes Varnish for a single hostname without touching the CDN?
      instructions:
      - text: Clear the Varnish cache for domain {domain} on environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      - text: Flush Varnish only for hostname {domain} in environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/environments/{environmentId}/domains/{domain}/actions/clear-caches'].post
  update:
    x-apievangelist-phrasing:
      intent: Clear all caches for a single domain
      effect: write
      questions:
      - How do I purge both Varnish and the Platform CDN for one domain?
      - Can I clear every cache layer for a single hostname?
      instructions:
      - text: Clear Varnish and CDN caches for domain {domain} on environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      - text: Purge every cache layer for hostname {domain} in environment {env}.
        slots:
          domain: path.domain
          env: path.environmentId
      method: generated
      generated: '2026-09-26'


# --- truncated at 32 KB (73 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/acquia/refs/heads/main/overlays/acquia-environments-api-phrasing-overlay.yaml