# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cohesity REST Vlan API
  version: 1.0.0
extends: openapi/cohesity-vlan-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: 5
- target: $.paths['/public/vlans'].get
  update:
    x-apievangelist-phrasing:
      intent: List the cluster's VLANs
      effect: read
      questions:
      - Which VLANs are configured on my cluster?
      - Can I list VLANs while skipping primary and bond interfaces?
      instructions:
      - text: List the cluster's VLANs.
      - text: List VLANs available to tenants {tenantIds}.
        slots:
          tenantIds: query.tenantIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vlans'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a VLAN
      effect: write
      questions:
      - How do I add a new VLAN with its own subnet and gateway?
      - Can a VLAN be shared by all tenants without assigning it to each?
      instructions:
      - text: Create VLAN {vlanName} on interface group {ifaceGroupName} with subnet {subnet} and gateway {gateway}.
        slots:
          vlanName: requestBody.vlanName
          ifaceGroupName: requestBody.ifaceGroupName
          subnet: requestBody.subnet
          gateway: requestBody.gateway
      - text: Create a VLAN with IPs {ips} for tenant {tenantId}.
        slots:
          ips: requestBody.ips
          tenantId: requestBody.tenantId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vlans/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single VLAN
      effect: read
      questions:
      - How do I see the details of one VLAN, by id or interface group name?
      - What IPs and gateway does a specific VLAN use?
      instructions:
      - text: Get VLAN {id}.
        slots:
          id: path.id
      - text: Show the configuration of VLAN {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vlans/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing VLAN
      effect: write
      questions:
      - Can I change the gateway or IP range of a VLAN that already exists?
      - Is it possible to change the MTU on a configured VLAN?
      instructions:
      - text: Update VLAN {id} to gateway {gateway}.
        slots:
          id: path.id
          gateway: requestBody.gateway
      - text: Change the IPs on VLAN {id} to {ips}.
        slots:
          id: path.id
          ips: requestBody.ips
      method: generated
      generated: '2026-10-01'
- target: $.paths['/public/vlans/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a VLAN
      effect: destructive
      questions:
      - How do I delete a VLAN from the cluster?
      - What does removing a VLAN return?
      instructions:
      - text: Remove VLAN {id}.
        slots:
          id: path.id
      - text: Delete VLAN {id} from the cluster.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'