# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Players API
  version: 1.0.0
extends: openapi/unity-players-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: 5
- target: $.paths['/v1/lobbies/{lobbyId}/players/{playerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a player from a lobby
      effect: destructive
      questions:
      - Can the lobby host kick a player out?
      - How does a player leave a lobby they joined?
      instructions:
      - text: Remove player {playerId} from lobby {lobbyId}.
        slots:
          playerId: path.playerId
          lobbyId: path.lobbyId
      - text: Kick {playerId} out of lobby {lobbyId}.
        slots:
          playerId: path.playerId
          lobbyId: path.lobbyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/lobbies/{lobbyId}/players/{playerId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a player's data inside a lobby
      effect: write
      questions:
      - Can I store per-player info like a selected character inside a lobby?
      - Is it possible to change a lobby member's custom data?
      instructions:
      - text: Update player {playerId}'s data in lobby {lobbyId} to {data}.
        slots:
          playerId: path.playerId
          lobbyId: path.lobbyId
          data: requestBody.data
      - text: Set lobby {lobbyId} member {playerId}'s custom data to {data}.
        slots:
          lobbyId: path.lobbyId
          playerId: path.playerId
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/players'].get
  update:
    x-apievangelist-phrasing:
      intent: List all players in the project
      effect: read
      questions:
      - Can an admin get a list of every player account in the project?
      - How many players are signed up for my game, page by page?
      instructions:
      - text: List all players in the project.
      - text: Show the next {limit} players after {after}.
        slots:
          limit: query.limit
          after: query.after
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/players/{playerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a player account's details
      effect: read
      questions:
      - What information is stored for a specific player account?
      - Can I look up a player by their player ID?
      instructions:
      - text: Show player account {playerId}.
        slots:
          playerId: path.playerId
      - text: Get account details for player {playerId}.
        slots:
          playerId: path.playerId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/players/{playerId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a player account and its data
      effect: destructive
      questions:
      - Can I delete a player account along with all their data?
      - What do I call to handle a player's request to erase their account?
      instructions:
      - text: Delete player account {playerId}.
        slots:
          playerId: path.playerId
      - text: Permanently erase player {playerId} and all associated data.
        slots:
          playerId: path.playerId
      method: generated
      generated: '2026-10-01'