# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Amazon API Gateway Management Connections API
  version: 1.0.0
extends: openapi/aws-api-gateway-connections-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: 3
- target: $.paths['/@connections/{connectionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a WebSocket connection
      effect: read
      questions:
      - How do I check whether a WebSocket client is still connected?
      - What information can I get about a connected client?
      instructions:
      - text: Get info about WebSocket connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Check if client {connectionId} is still connected.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/@connections/{connectionId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to a WebSocket client
      effect: write
      questions:
      - How do I push a message from my backend to a connected WebSocket client?
      - Can my server send data to one specific WebSocket connection?
      instructions:
      - text: Send a message to WebSocket connection {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Push a notification to connected client {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/@connections/{connectionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disconnect a WebSocket client
      effect: destructive
      questions:
      - How do I force a WebSocket client to disconnect?
      - Can my backend kick a client off a WebSocket API?
      instructions:
      - text: Disconnect WebSocket client {connectionId}.
        slots:
          connectionId: path.connectionId
      - text: Force-close connection {connectionId}.
        slots:
          connectionId: path.connectionId
      method: generated
      generated: '2026-10-01'