API Evangelist conversational phrasing for Acquia Cloud API Documentation Private Networks API

# 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 Private Networks API
  version: 1.0.0
extends: openapi/acquia-private-networks-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: 20
- target: $.paths['/private-networks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a private network
      effect: write
      questions:
      - How do I set up a new private network for my subscription in a given region?
      - Can I configure VPN or VPC peer connections while creating a private network?
      instructions:
      - text: Create private network {name} in {region} for subscription {subscription_id} with connections {connections}.
        slots:
          name: requestBody.name
          region: requestBody.region
          subscription_id: requestBody.subscription_id
          connections: requestBody.connections
      - text: Set up a private network {name} in region {region} on subscription {subscription_id}, isolation {isolation}, connections {connections}.
        slots:
          name: requestBody.name
          region: requestBody.region
          subscription_id: requestBody.subscription_id
          isolation: requestBody.isolation
          connections: requestBody.connections
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private network
      effect: read
      questions:
      - What is configured on a specific private network?
      - Can I look up a private network by its ID?
      instructions:
      - text: Show private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Get the full configuration of private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a private network's label or description
      effect: write
      questions:
      - Can I change the label or description of an existing private network?
      - How do I rename a private network?
      instructions:
      - text: Change the label of private network {privateNetworkId} to {label}.
        slots:
          privateNetworkId: path.privateNetworkId
          label: requestBody.label
      - text: Update private network {privateNetworkId} description to {description}.
        slots:
          privateNetworkId: path.privateNetworkId
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a private network
      effect: destructive
      questions:
      - How do I tear down a private network I no longer need?
      - Can I delete a private network by ID?
      instructions:
      - text: Delete private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Remove private network {privateNetworkId} entirely.
        slots:
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/subscriptions/{subscriptionId}/private-networks'].get
  update:
    x-apievangelist-phrasing:
      intent: List private networks in a subscription
      effect: read
      questions:
      - Which private networks exist under my subscription?
      - Can I page through a subscription's private networks?
      instructions:
      - text: List private networks for subscription {subscriptionId}.
        slots:
          subscriptionId: path.subscriptionId
      - text: Show private networks in subscription {subscriptionId} matching {filter}.
        slots:
          subscriptionId: path.subscriptionId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpns'].get
  update:
    x-apievangelist-phrasing:
      intent: List VPNs on a private network
      effect: read
      questions:
      - Which VPN connections are attached to my private network?
      - Can I filter a private network's VPNs?
      instructions:
      - text: List the VPNs on private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Show VPN connections for private network {privateNetworkId} matching {filter}.
        slots:
          privateNetworkId: path.privateNetworkId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpns'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a VPN to a private network
      effect: write
      questions:
      - How do I connect my office network to a private network over VPN?
      - What do I need to supply to add a VPN, like the gateway IP and routes?
      instructions:
      - text: Add VPN {name} with gateway {gateway_ip} and routes {routes} to private network {privateNetworkId}.
        slots:
          name: requestBody.name
          gateway_ip: requestBody.gateway_ip
          routes: requestBody.routes
          privateNetworkId: path.privateNetworkId
      - text: Attach a new VPN called {name} to private network {privateNetworkId}, gateway IP {gateway_ip}, routing {routes}.
        slots:
          name: requestBody.name
          privateNetworkId: path.privateNetworkId
          gateway_ip: requestBody.gateway_ip
          routes: requestBody.routes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpns/{vpnId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one VPN on a private network
      effect: read
      questions:
      - What are the tunnel settings of a particular VPN?
      - Can I look up a single VPN connection by ID?
      instructions:
      - text: Show VPN {vpnId} on private network {privateNetworkId}.
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
      - text: Get the configuration of VPN {vpnId} in private network {privateNetworkId}.
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpns/{vpnId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a VPN by ID
      effect: write
      questions:
      - Can I change the routes or gateway of a VPN I already set up?
      - Is there a way to upsert a VPN under a known ID?
      instructions:
      - text: 'Update VPN {vpnId} on private network {privateNetworkId}: name {name}, gateway {gateway_ip}, routes {routes}.'
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
          name: requestBody.name
          gateway_ip: requestBody.gateway_ip
          routes: requestBody.routes
      - text: Put VPN {vpnId} into private network {privateNetworkId} named {name} with gateway {gateway_ip} and routes {routes}, creating it if missing.
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
          name: requestBody.name
          gateway_ip: requestBody.gateway_ip
          routes: requestBody.routes
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpns/{vpnId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VPN from a private network
      effect: destructive
      questions:
      - How do I disconnect a VPN from my private network?
      - Can I remove one VPN without touching the others?
      instructions:
      - text: Delete VPN {vpnId} from private network {privateNetworkId}.
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
      - text: Remove the VPN connection {vpnId} on private network {privateNetworkId}.
        slots:
          vpnId: path.vpnId
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpc-peers'].get
  update:
    x-apievangelist-phrasing:
      intent: List VPC peers on a private network
      effect: read
      questions:
      - Which AWS VPCs are peered with my private network?
      - Can I filter the VPC peering connections on a private network?
      instructions:
      - text: List VPC peers on private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Show VPC peering connections for private network {privateNetworkId} matching {filter}.
        slots:
          privateNetworkId: path.privateNetworkId
          filter: query.filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpc-peers'].post
  update:
    x-apievangelist-phrasing:
      intent: Peer an AWS VPC with a private network
      effect: write
      questions:
      - How do I peer my own AWS VPC with a private network?
      - Which details, like the VPC CIDR and AWS account, does a VPC peer need?
      instructions:
      - text: Peer VPC {vpc_id} in AWS account {aws_account} with private network {privateNetworkId}.
        slots:
          vpc_id: requestBody.vpc_id
          aws_account: requestBody.aws_account
          privateNetworkId: path.privateNetworkId
      - text: Add VPC peer {name} for VPC {vpc_id} with CIDR {vpc_cidr} to private network {privateNetworkId}.
        slots:
          name: requestBody.name
          vpc_id: requestBody.vpc_id
          vpc_cidr: requestBody.vpc_cidr
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one VPC peer on a private network
      effect: read
      questions:
      - What's the status of a specific VPC peering connection?
      - Can I look up one VPC peer by ID?
      instructions:
      - text: Show VPC peer {vpcPeerId} on private network {privateNetworkId}.
        slots:
          vpcPeerId: path.vpcPeerId
          privateNetworkId: path.privateNetworkId
      - text: Get details of VPC peering {vpcPeerId} in private network {privateNetworkId}.
        slots:
          vpcPeerId: path.vpcPeerId
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections/vpc-peers/{vpcPeerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a VPC peer from a private network
      effect: destructive
      questions:
      - How do I remove a VPC peering connection?
      - Can I unpeer one AWS VPC from my private network?
      instructions:
      - text: Delete VPC peer {vpcPeerId} from private network {privateNetworkId}.
        slots:
          vpcPeerId: path.vpcPeerId
          privateNetworkId: path.privateNetworkId
      - text: Unpeer {vpcPeerId} from private network {privateNetworkId}.
        slots:
          vpcPeerId: path.vpcPeerId
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections'].get
  update:
    x-apievangelist-phrasing:
      intent: Get all connections of a private network
      effect: read
      questions:
      - Can I see every VPN and VPC peer on a private network in one view?
      - What does the connections block of my private network contain?
      instructions:
      - text: Show the connections block for private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Get all VPNs and VPC peers together for private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/connections'].put
  update:
    x-apievangelist-phrasing:
      intent: Set private egress access on a private network
      effect: write
      questions:
      - Can I turn private egress access on or off for a private network?
      - How do I change the connections configuration of a private network?
      instructions:
      - text: Set private egress access on private network {privateNetworkId} to {private_egress_access}.
        slots:
          privateNetworkId: path.privateNetworkId
          private_egress_access: requestBody.private_egress_access
      - text: Update private network {privateNetworkId} connections so private egress is {private_egress_access}.
        slots:
          privateNetworkId: path.privateNetworkId
          private_egress_access: requestBody.private_egress_access
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/isolation'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private network's isolation settings
      effect: read
      questions:
      - Does my private network use dedicated compute or a dedicated network?
      - What isolation level is a private network running with?
      instructions:
      - text: Show isolation settings for private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Check whether private network {privateNetworkId} is on dedicated infrastructure.
        slots:
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/isolation'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a private network's isolation
      effect: write
      questions:
      - Can I switch a private network to dedicated compute?
      - How do I enable a dedicated network for an existing private network?
      instructions:
      - text: Set dedicated compute to {dedicated_compute} on private network {privateNetworkId}.
        slots:
          dedicated_compute: requestBody.dedicated_compute
          privateNetworkId: path.privateNetworkId
      - text: Turn dedicated network {dedicated_network} for private network {privateNetworkId}.
        slots:
          dedicated_network: requestBody.dedicated_network
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/ingress'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a private network's ingress settings
      effect: read
      questions:
      - Is Drupal SSH ingress allowed on my private network?
      - What inbound access is configured for a private network?
      instructions:
      - text: Show ingress settings for private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      - text: Check inbound access rules on private network {privateNetworkId}.
        slots:
          privateNetworkId: path.privateNetworkId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/private-networks/{privateNetworkId}/ingress'].put
  update:
    x-apievangelist-phrasing:
      intent: Update Drupal SSH ingress on a private network
      effect: write
      questions:
      - Can I allow or block Drupal SSH access into my private network?
      - How do I change the ingress configuration of a private network?
      instructions:
      - text: Set Drupal SSH ingress on private network {privateNetworkId} to {drupal_ssh}.
        slots:
          privateNetworkId: path.privateNetworkId
          drupal_ssh: requestBody.drupal_ssh
      - text: Update private network {privateNetworkId} ingress with drupal_ssh {drupal_ssh}.
        slots:
          privateNetworkId: path.privateNetworkId
          drupal_ssh: requestBody.drupal_ssh
      method: generated
      generated: '2026-09-26'