Unity Leaderboards API — Scores

naftiko: 1.0.0-alpha2
info:
  label: Unity Leaderboards API — Scores
  description: 'Unity Leaderboards API — Scores. 3 operations. Lead operation: Get Leaderboard Scores. Self-contained Naftiko
    capability covering one Unity business surface.'
  tags:
  - Unity
  - Scores
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITY_API_KEY: UNITY_API_KEY
capability:
  consumes:
  - type: http
    namespace: leaderboards-scores
    baseUri: https://leaderboards.services.api.unity.com
    description: Unity Leaderboards API — Scores business capability. Self-contained, no shared references.
    resources:
    - name: v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId-scor
      path: /v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores
      operations:
      - name: getleaderboardscores
        method: GET
        description: Get Leaderboard Scores
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: leaderboardId
          in: path
          type: string
          required: true
        - name: offset
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
        - name: includeMetadata
          in: query
          type: boolean
    - name: v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId-scor
      path: /v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}/scores/players/{playerId}
      operations:
      - name: addleaderboardplayerscore
        method: POST
        description: Add Player Score
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: leaderboardId
          in: path
          type: string
          required: true
        - name: playerId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: getleaderboardplayerscore
        method: GET
        description: Get Player Score
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          required: true
        - name: environmentId
          in: path
          type: string
          required: true
        - name: leaderboardId
          in: path
          type: string
          required: true
        - name: playerId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.UNITY_API_KEY}}'
  exposes:
  - type: rest
    namespace: leaderboards-scores-rest
    port: 8080
    description: REST adapter for Unity Leaderboards API — Scores. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/projects/{projectid}/environments/{environmentid}/leaderboards/{leaderboardid}/scores
      name: v1-projects-projectid-environments-environmentid-leaderboards-leaderboardid-scor
      description: REST surface for v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId-scor.
      operations:
      - method: GET
        name: getleaderboardscores
        description: Get Leaderboard Scores
        call: leaderboards-scores.getleaderboardscores
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
          offset: rest.offset
          limit: rest.limit
          includeMetadata: rest.includeMetadata
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{projectid}/environments/{environmentid}/leaderboards/{leaderboardid}/scores/players/{playerid}
      name: v1-projects-projectid-environments-environmentid-leaderboards-leaderboardid-scor
      description: REST surface for v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId-scor.
      operations:
      - method: POST
        name: addleaderboardplayerscore
        description: Add Player Score
        call: leaderboards-scores.addleaderboardplayerscore
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
          playerId: rest.playerId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getleaderboardplayerscore
        description: Get Player Score
        call: leaderboards-scores.getleaderboardplayerscore
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
          playerId: rest.playerId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: leaderboards-scores-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unity Leaderboards API — Scores. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-leaderboard-scores
      description: Get Leaderboard Scores
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leaderboards-scores.getleaderboardscores
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
        offset: tools.offset
        limit: tools.limit
        includeMetadata: tools.includeMetadata
      outputParameters:
      - type: object
        mapping: $.
    - name: add-player-score
      description: Add Player Score
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leaderboards-scores.addleaderboardplayerscore
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
        playerId: tools.playerId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-player-score
      description: Get Player Score
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leaderboards-scores.getleaderboardplayerscore
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
        playerId: tools.playerId
      outputParameters:
      - type: object
        mapping: $.