# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Laravel Cloud WebSocket Clusters API
  version: 1.0.0
extends: openapi/laravel-websocket-clusters-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['/websocket-servers'].get
  update:
    x-apievangelist-phrasing:
      intent: List WebSocket clusters
      effect: read
      questions:
      - Which WebSocket clusters does my organization run?
      - Can I filter WebSocket clusters by region or status?
      instructions:
      - text: List my WebSocket clusters.
      - text: Show WebSocket clusters in region {region}.
        slots:
          region: query.filter[region]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WebSocket cluster
      effect: write
      questions:
      - How do I create a managed WebSocket cluster for real-time features?
      - Does a new WebSocket cluster come with an application already set up?
      instructions:
      - text: Create a {type} WebSocket cluster named {name} in {region} allowing {max_connections} connections.
        slots:
          type: requestBody.type
          name: requestBody.name
          region: requestBody.region
          max_connections: requestBody.max_connections
      - text: Spin up WebSocket cluster {name} in {region}, type {type}, max {max_connections} connections.
        slots:
          name: requestBody.name
          region: requestBody.region
          type: requestBody.type
          max_connections: requestBody.max_connections
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers/{websocketServer}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WebSocket cluster's details
      effect: read
      questions:
      - What connection limit and region does one WebSocket cluster have?
      - Can I look up a single WebSocket cluster by ID?
      instructions:
      - text: Show WebSocket cluster {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      - text: Get the details of WebSocket cluster {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers/{websocketServer}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a WebSocket cluster
      effect: destructive
      questions:
      - What happens to its applications when I delete a WebSocket cluster?
      - How do I tear down a WebSocket cluster?
      instructions:
      - text: Delete WebSocket cluster {websocketServer} and its applications.
        slots:
          websocketServer: path.websocketServer
      - text: Tear down WebSocket cluster {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers/{websocketServer}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or resize a WebSocket cluster
      effect: write
      questions:
      - Can I raise the connection limit on an existing WebSocket cluster?
      - Is renaming a WebSocket cluster possible after creation?
      instructions:
      - text: Set WebSocket cluster {websocketServer} max connections to {max_connections}.
        slots:
          websocketServer: path.websocketServer
          max_connections: requestBody.max_connections
      - text: Rename WebSocket cluster {websocketServer} to {name}.
        slots:
          websocketServer: path.websocketServer
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers/{websocketServer}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metrics for a WebSocket cluster
      effect: read
      questions:
      - How many connections and messages is my WebSocket cluster handling?
      - Can I pull WebSocket cluster metrics for a chosen period?
      instructions:
      - text: Show metrics for WebSocket cluster {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      - text: Get WebSocket cluster {websocketServer} metrics over {period}.
        slots:
          websocketServer: path.websocketServer
          period: query.period
      method: generated
      generated: '2026-10-01'