# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Lobby Lobbies API
  version: 1.0.0
extends: openapi/unity-lobbies-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: 7
- target: $.paths['/v1/lobbies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new game lobby
      effect: write
      questions:
      - How do I create a lobby that other players can join?
      - Can I make a private lobby with a cap on the number of players?
      - Who becomes the host when a player creates a lobby?
      instructions:
      - text: Create a lobby called {name} with room for {maxPlayers} players.
        slots:
          name: requestBody.name
          maxPlayers: requestBody.maxPlayers
      - text: 'Open a private lobby {name} for up to {maxPlayers} players (private: {isPrivate}).'
        slots:
          name: requestBody.name
          maxPlayers: requestBody.maxPlayers
          isPrivate: requestBody.isPrivate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a lobby's current state
      effect: read
      questions:
      - What is the current state and configuration of my lobby?
      - Can I check who is in a lobby and how it is set up?
      instructions:
      - text: Show the current state of lobby {lobbyId}.
        slots:
          lobbyId: path.lobbyId
      - text: Fetch the configuration and members of lobby {lobbyId}.
        slots:
          lobbyId: path.lobbyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lobby as its host
      effect: destructive
      questions:
      - Can the host shut down and delete a lobby?
      - Who is allowed to delete a lobby?
      instructions:
      - text: Delete lobby {lobbyId}.
        slots:
          lobbyId: path.lobbyId
      - text: Close and remove lobby {lobbyId} as the host.
        slots:
          lobbyId: path.lobbyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a lobby's settings or host
      effect: write
      questions:
      - Can I lock a lobby so nobody else can join?
      - Is it possible to hand off lobby host to another player?
      - Which lobby settings can the host change after creating it?
      instructions:
      - text: Rename lobby {lobbyId} to {name}.
        slots:
          lobbyId: path.lobbyId
          name: requestBody.name
      - text: 'Lock lobby {lobbyId} (locked: {isLocked}).'
        slots:
          lobbyId: path.lobbyId
          isLocked: requestBody.isLocked
      - text: Make player {hostId} the new host of lobby {lobbyId}.
        slots:
          hostId: requestBody.hostId
          lobbyId: path.lobbyId
      - text: Change the player limit of lobby {lobbyId} to {maxPlayers}.
        slots:
          lobbyId: path.lobbyId
          maxPlayers: requestBody.maxPlayers
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}/join'].post
  update:
    x-apievangelist-phrasing:
      intent: Join a lobby by its lobby ID
      effect: write
      questions:
      - Can a player join a lobby if they know its lobby ID?
      - What happens when I join a public lobby I found by ID?
      instructions:
      - text: Join lobby {lobbyId} as player {playerId}.
        slots:
          lobbyId: path.lobbyId
          playerId: requestBody.playerId
      - text: Add player {playerId} to lobby {lobbyId} using its ID.
        slots:
          playerId: requestBody.playerId
          lobbyId: path.lobbyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/code/{lobbyCode}'].post
  update:
    x-apievangelist-phrasing:
      intent: Join a private lobby with a join code
      effect: write
      questions:
      - How do I join a friend's private lobby with the code they shared?
      - Can players enter a lobby using a short join code instead of the ID?
      instructions:
      - text: Join the lobby with code {lobbyCode} as player {playerId}.
        slots:
          lobbyCode: path.lobbyCode
          playerId: requestBody.playerId
      - text: Use join code {lobbyCode} to put player {playerId} into that private lobby.
        slots:
          lobbyCode: path.lobbyCode
          playerId: requestBody.playerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}/heartbeat'].post
  update:
    x-apievangelist-phrasing:
      intent: Keep a lobby alive with a heartbeat
      effect: write
      questions:
      - Why did my lobby disappear after a while with no activity?
      - What keeps a lobby from being automatically deleted?
      instructions:
      - text: Send a heartbeat for lobby {lobbyId}.
        slots:
          lobbyId: path.lobbyId
      - text: Keep lobby {lobbyId} active by pinging its heartbeat.
        slots:
          lobbyId: path.lobbyId
      method: generated
      generated: '2026-10-01'