Unity Leaderboards API — Leaderboards

naftiko: 1.0.0-alpha2
info:
  label: Unity Leaderboards API — Leaderboards
  description: 'Unity Leaderboards API — Leaderboards. 5 operations. Lead operation: List Leaderboards. Self-contained Naftiko
    capability covering one Unity business surface.'
  tags:
  - Unity
  - Leaderboards
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITY_API_KEY: UNITY_API_KEY
capability:
  consumes:
  - type: http
    namespace: leaderboards-leaderboards
    baseUri: https://leaderboards.services.api.unity.com
    description: Unity Leaderboards API — Leaderboards business capability. Self-contained, no shared references.
    resources:
    - name: v1-projects-projectId-environments-environmentId-leaderboards
      path: /v1/projects/{projectId}/environments/{environmentId}/leaderboards
      operations:
      - name: listleaderboards
        method: GET
        description: List Leaderboards
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: projectId
          in: path
          type: string
          description: The Unity project identifier
          required: true
        - name: environmentId
          in: path
          type: string
          description: The environment identifier
          required: true
        - name: limit
          in: query
          type: integer
          description: Maximum number of leaderboards to return
        - name: cursor
          in: query
          type: string
          description: Cursor for pagination
      - name: createleaderboard
        method: POST
        description: Create Leaderboard
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId
      path: /v1/projects/{projectId}/environments/{environmentId}/leaderboards/{leaderboardId}
      operations:
      - name: getleaderboard
        method: GET
        description: Get Leaderboard
        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: updateleaderboard
        method: PUT
        description: Update Leaderboard
        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: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteleaderboard
        method: DELETE
        description: Delete Leaderboard
        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
    authentication:
      type: bearer
      token: '{{env.UNITY_API_KEY}}'
  exposes:
  - type: rest
    namespace: leaderboards-leaderboards-rest
    port: 8080
    description: REST adapter for Unity Leaderboards API — Leaderboards. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/projects/{projectid}/environments/{environmentid}/leaderboards
      name: v1-projects-projectid-environments-environmentid-leaderboards
      description: REST surface for v1-projects-projectId-environments-environmentId-leaderboards.
      operations:
      - method: GET
        name: listleaderboards
        description: List Leaderboards
        call: leaderboards-leaderboards.listleaderboards
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          limit: rest.limit
          cursor: rest.cursor
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createleaderboard
        description: Create Leaderboard
        call: leaderboards-leaderboards.createleaderboard
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/projects/{projectid}/environments/{environmentid}/leaderboards/{leaderboardid}
      name: v1-projects-projectid-environments-environmentid-leaderboards-leaderboardid
      description: REST surface for v1-projects-projectId-environments-environmentId-leaderboards-leaderboardId.
      operations:
      - method: GET
        name: getleaderboard
        description: Get Leaderboard
        call: leaderboards-leaderboards.getleaderboard
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateleaderboard
        description: Update Leaderboard
        call: leaderboards-leaderboards.updateleaderboard
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteleaderboard
        description: Delete Leaderboard
        call: leaderboards-leaderboards.deleteleaderboard
        with:
          projectId: rest.projectId
          environmentId: rest.environmentId
          leaderboardId: rest.leaderboardId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: leaderboards-leaderboards-mcp
    port: 9090
    transport: http
    description: MCP adapter for Unity Leaderboards API — Leaderboards. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-leaderboards
      description: List Leaderboards
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leaderboards-leaderboards.listleaderboards
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        limit: tools.limit
        cursor: tools.cursor
      outputParameters:
      - type: object
        mapping: $.
    - name: create-leaderboard
      description: Create Leaderboard
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: leaderboards-leaderboards.createleaderboard
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-leaderboard
      description: Get Leaderboard
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: leaderboards-leaderboards.getleaderboard
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-leaderboard
      description: Update Leaderboard
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: leaderboards-leaderboards.updateleaderboard
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-leaderboard
      description: Delete Leaderboard
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: leaderboards-leaderboards.deleteleaderboard
      with:
        projectId: tools.projectId
        environmentId: tools.environmentId
        leaderboardId: tools.leaderboardId
      outputParameters:
      - type: object
        mapping: $.