API Evangelist conversational phrasing for WSO2 API Manager - Admin Platform Gateways API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for WSO2 API Manager - Admin Platform Gateways API
  version: 1.0.0
extends: openapi/wso2-platform-gateways-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['/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List platform gateways
      effect: read
      questions:
      - Which platform gateways are registered for our organization?
      - Can I see every gateway connected to the control plane?
      instructions:
      - text: List all registered platform gateways.
      - text: Show the platform gateways in my organization.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a platform gateway
      effect: write
      questions:
      - How do I register a new platform gateway and get its connection token?
      - Is the gateway registration token shown more than once?
      instructions:
      - text: Register a platform gateway named {name} at {vhost} displayed as {displayName}.
        slots:
          name: requestBody.name
          vhost: requestBody.vhost
          displayName: requestBody.displayName
      - text: Add gateway {name} with URL {vhost}, label {displayName}, and description {description}.
        slots:
          name: requestBody.name
          vhost: requestBody.vhost
          displayName: requestBody.displayName
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways/{gatewayId}/regenerate-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Regenerate a gateway's registration token
      effect: destructive
      questions:
      - How do I get a new registration token if a gateway's token was lost?
      - Does regenerating a gateway token revoke the old one?
      instructions:
      - text: Regenerate the registration token for gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      - text: Rotate the control plane token of platform gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways/{gatewayId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a platform gateway
      effect: write
      questions:
      - Can I change a platform gateway's display name or description?
      - Which gateway fields can be updated, and are name and URL fixed?
      instructions:
      - text: Rename gateway {gatewayId} (name {name}, vhost {vhost}) to display as {displayName}.
        slots:
          gatewayId: path.gatewayId
          name: requestBody.name
          vhost: requestBody.vhost
          displayName: requestBody.displayName
      - text: Update gateway {gatewayId} ({name} at {vhost}) to display {displayName} with properties {properties}.
        slots:
          gatewayId: path.gatewayId
          name: requestBody.name
          vhost: requestBody.vhost
          displayName: requestBody.displayName
          properties: requestBody.properties
      method: generated
      generated: '2026-10-01'
- target: $.paths['/gateways/{gatewayId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a platform gateway
      effect: destructive
      questions:
      - How do I remove a platform gateway and its tokens?
      - Why would deleting a gateway fail while APIs are still deployed to it?
      instructions:
      - text: Delete platform gateway {gatewayId}.
        slots:
          gatewayId: path.gatewayId
      - text: Remove gateway {gatewayId} and all its deployment records.
        slots:
          gatewayId: path.gatewayId
      method: generated
      generated: '2026-10-01'