# 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 Applications API
  version: 1.0.0
extends: openapi/laravel-websocket-applications-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/{websocketServer}/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List applications on a WebSocket cluster
      effect: read
      questions:
      - Which WebSocket applications run on one of my WebSocket clusters?
      - Can I list every app attached to a WebSocket server?
      instructions:
      - text: List the applications on WebSocket cluster {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      - text: Show every WebSocket app hosted on server {websocketServer}.
        slots:
          websocketServer: path.websocketServer
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-servers/{websocketServer}/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a WebSocket application
      effect: write
      questions:
      - How do I create a new WebSocket application on my cluster?
      - Can I restrict which origins may connect to a new WebSocket app?
      instructions:
      - text: Create a WebSocket application named {name} on cluster {websocketServer}.
        slots:
          name: requestBody.name
          websocketServer: path.websocketServer
      - text: Add WebSocket app {name} to {websocketServer} allowing origins {allowed_origins}.
        slots:
          name: requestBody.name
          websocketServer: path.websocketServer
          allowed_origins: requestBody.allowed_origins
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-applications/{websocketApplication}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WebSocket application and its credentials
      effect: read
      questions:
      - Where do I find the key and secret for my WebSocket application?
      - Can I fetch a single WebSocket app's settings?
      instructions:
      - text: Show WebSocket application {websocketApplication} with its credentials.
        slots:
          websocketApplication: path.websocketApplication
      - text: Get the connection credentials for WebSocket app {websocketApplication}.
        slots:
          websocketApplication: path.websocketApplication
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-applications/{websocketApplication}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a WebSocket application
      effect: destructive
      questions:
      - How do I delete a WebSocket application I no longer use?
      - Can I remove one WebSocket app without deleting the cluster?
      instructions:
      - text: Delete WebSocket application {websocketApplication}.
        slots:
          websocketApplication: path.websocketApplication
      - text: Remove WebSocket app {websocketApplication} from its cluster.
        slots:
          websocketApplication: path.websocketApplication
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-applications/{websocketApplication}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a WebSocket application's settings
      effect: write
      questions:
      - Can I change the allowed origins of an existing WebSocket app?
      - How do I adjust the ping interval or activity timeout for WebSocket connections?
      instructions:
      - text: Set allowed origins of WebSocket application {websocketApplication} to {allowed_origins}.
        slots:
          websocketApplication: path.websocketApplication
          allowed_origins: requestBody.allowed_origins
      - text: Change WebSocket app {websocketApplication} to ping every {ping_interval} with an activity timeout of {activity_timeout}.
        slots:
          websocketApplication: path.websocketApplication
          ping_interval: requestBody.ping_interval
          activity_timeout: requestBody.activity_timeout
      method: generated
      generated: '2026-10-01'
- target: $.paths['/websocket-applications/{websocketApplication}/metrics'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a WebSocket application's metrics
      effect: read
      questions:
      - How much traffic is my WebSocket application handling?
      - Can I view WebSocket app metrics for a specific time period?
      instructions:
      - text: Show metrics for WebSocket application {websocketApplication}.
        slots:
          websocketApplication: path.websocketApplication
      - text: Get WebSocket app {websocketApplication} metrics over the {period} period.
        slots:
          websocketApplication: path.websocketApplication
          period: query.period
      method: generated
      generated: '2026-10-01'