# 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 API
  version: 1.0.0
extends: openapi/unity-leaderboards-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/projects/{projectId}/environments/{environmentId}/leaderboards'].get
  update:
    x-apievangelist-phrasing:
      intent: List leaderboards in an environment
      effect: read
      questions:
      - Which leaderboards have I defined for my game environment?
      - Can I page through leaderboard definitions with a cursor?
      instructions:
      - text: List the leaderboards in environment {environmentId} of project {projectId}.
        slots:
          environmentId: path.environmentId
          projectId: path.projectId
      - text: Show up to {limit} leaderboard definitions for project {projectId}, environment {environmentId}.
        slots:
          limit: query.limit
          projectId: path.projectId
          environmentId: path.environmentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a leaderboard
      effect: write
      questions:
      - How do I create a new leaderboard for my game?
      - Can a leaderboard rank scores ascending instead of descending?
      - Is it possible to set a leaderboard to reset on a schedule or split players into buckets?
      instructions:
      - text: Create leaderboard {id} sorted {sortOrder} in project {projectId}, environment {environmentId}.
        slots:
          id: requestBody.id
          sortOrder: requestBody.sortOrder
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Add a leaderboard {id} named {name} with sort order {sortOrder} and bucket size {bucketSize} to environment {environmentId} of project {projectId}.
        slots:
          id: requestBody.id
          name: requestBody.name
          sortOrder: requestBody.sortOrder
          bucketSize: requestBody.bucketSize
          environmentId: path.environmentId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a leaderboard's configuration
      effect: read
      questions:
      - What are the settings of one specific leaderboard?
      - Can I see how a leaderboard is sorted and when it resets?
      instructions:
      - text: Show leaderboard {leaderboardId} configuration in project {projectId}, environment {environmentId}.
        slots:
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Get the settings of leaderboard {leaderboardId} for environment {environmentId} of project {projectId}.
        slots:
          leaderboardId: path.leaderboardId
          environmentId: path.environmentId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a leaderboard's settings
      effect: write
      questions:
      - Can I change the reset schedule of an existing leaderboard?
      - Is it possible to rename a leaderboard after creating it?
      instructions:
      - text: Change the reset config of leaderboard {leaderboardId} in project {projectId}, environment {environmentId}, to {resetConfig}.
        slots:
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
          resetConfig: requestBody.resetConfig
      - text: Rename leaderboard {leaderboardId} to {name} in environment {environmentId} of project {projectId}.
        slots:
          leaderboardId: path.leaderboardId
          name: requestBody.name
          environmentId: path.environmentId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a leaderboard and its scores
      effect: destructive
      questions:
      - Does deleting a leaderboard also wipe its scores?
      - Can I remove a leaderboard I no longer use?
      instructions:
      - text: Delete leaderboard {leaderboardId} from project {projectId}, environment {environmentId}.
        slots:
          leaderboardId: path.leaderboardId
          projectId: path.projectId
          environmentId: path.environmentId
      - text: Remove leaderboard {leaderboardId} and all its scores in environment {environmentId} of project {projectId}.
        slots:
          leaderboardId: path.leaderboardId
          environmentId: path.environmentId
          projectId: path.projectId
      method: generated
      generated: '2026-10-01'