# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Unity Leaderboards Scores API
  version: 1.0.0
extends: openapi/unity-scores-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['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a player's score and rank on a leaderboard
      effect: read
      questions:
      - What rank and score does a specific player have on a leaderboard?
      - Where does my player currently place on the weekly leaderboard?
      instructions:
      - text: Show player {playerId}'s score on leaderboard {leaderboardId} in project {projectId}, environment {environmentId}.
        slots:
          playerId: path.playerId
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Get the rank of {playerId} on leaderboard {leaderboardId} (project {projectId}, env {environmentId}).
        slots:
          playerId: path.playerId
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a player's score to a leaderboard
      effect: write
      questions:
      - How do I post a player's score to a leaderboard?
      - Can I attach metadata to a submitted score?
      instructions:
      - text: Submit score {score} for player {playerId} on leaderboard {leaderboardId} in project {projectId}, environment {environmentId}.
        slots:
          score: requestBody.score
          playerId: path.playerId
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Post {score} with metadata {metadata} for {playerId} to leaderboard {leaderboardId} (project {projectId}, env {environmentId}).
        slots:
          score: requestBody.score
          metadata: requestBody.metadata
          playerId: path.playerId
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the top scores on a leaderboard
      effect: read
      questions:
      - Who are the top players on a leaderboard?
      - Can I page through leaderboard rankings with an offset and limit?
      instructions:
      - text: Show the top scores on leaderboard {leaderboardId} in project {projectId}, environment {environmentId}.
        slots:
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: List {limit} scores starting at offset {offset} on leaderboard {leaderboardId} (project {projectId}, env {environmentId}).
        slots:
          limit: query.limit
          offset: query.offset
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'