API Evangelist conversational phrasing for WSO2 API Manager - Admin Environments 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 Environments API
  version: 1.0.0
extends: openapi/wso2-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: 6
- target: $.paths['/environments'].get
  update:
    x-apievangelist-phrasing:
      intent: List gateway environments
      effect: read
      questions:
      - Which gateway environments are registered?
      - What environments can I deploy APIs to?
      instructions:
      - text: List all gateway environments.
      - text: Show the registered gateway environments.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a gateway environment
      effect: write
      questions:
      - Can I register a new gateway environment with its own virtual hosts?
      - What gateway type can a new environment use?
      instructions:
      - text: Add gateway environment {name} with vhosts {vhosts}.
        slots:
          name: requestBody.name
          vhosts: requestBody.vhosts
      - text: Create environment {name} of gateway type {gatewayType} using vhosts {vhosts}.
        slots:
          name: requestBody.name
          gatewayType: requestBody.gatewayType
          vhosts: requestBody.vhosts
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a gateway environment
      effect: read
      questions:
      - What is the configuration of one gateway environment?
      - Can I look up an environment by its ID?
      instructions:
      - text: Show gateway environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Get the configuration of environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a gateway environment
      effect: write
      questions:
      - Can I change the virtual hosts of an existing environment?
      - How do I edit a gateway environment's settings?
      instructions:
      - text: Update environment {environmentId} named {name} with vhosts {vhosts}.
        slots:
          environmentId: path.environmentId
          name: requestBody.name
          vhosts: requestBody.vhosts
      - text: Change the display name of environment {environmentId} ({name}, vhosts {vhosts}) to {displayName}.
        slots:
          environmentId: path.environmentId
          name: requestBody.name
          vhosts: requestBody.vhosts
          displayName: requestBody.displayName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a gateway environment
      effect: destructive
      questions:
      - Can I remove a gateway environment I no longer need?
      - Is deleting an environment possible from the admin side?
      instructions:
      - text: Delete gateway environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Remove environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/environments/{environmentId}/gateways'].get
  update:
    x-apievangelist-phrasing:
      intent: List gateway instances in an environment
      effect: read
      questions:
      - Which gateway instances are running in an environment?
      - Can I see the gateway nodes attached to one environment?
      instructions:
      - text: List the gateway instances in environment {environmentId}.
        slots:
          environmentId: path.environmentId
      - text: Show the running gateway nodes of environment {environmentId}.
        slots:
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'