Update OpenAPI spec

Author: cbrinicombe13

openapi/admin.yml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Trophy
-  version: '1.11.0'
+  version: '1.12.0'
 paths:
   /attributes:
     servers:

openapi/application.yml

@@ -1,7 +1,7 @@
 openapi: 3.1.0
 info:
   title: Trophy
-  version: '1.11.0'
+  version: '1.12.0'
 paths:
   /achievements:
     servers:
@@ -1771,7 +1771,7 @@ paths:
                     periodStart: '2025-03-31'
                     periodEnd: '2025-04-05'
                     expires: '2025-04-12'
-                    rank: 5
+                    extended: '2025-04-03T14:30:00Z'
                     streakHistory:
                       - periodStart: '2025-03-30'
                         periodEnd: '2025-04-05'
@@ -1906,115 +1906,6 @@ paths:
       summary: Get the streak lengths of a list of users
       security:
         - ApiKeyAuth: []
-  /streaks/rankings:
-    servers:
-      - url: https://api.trophy.so/v1
-        description: Application API
-    parameters:
-      - $ref: '#/components/parameters/TenantId'
-    get:
-      description: Get the top users by streak length (active or longest).
-      operationId: streaks_rankings
-      x-fern-server-name: api
-      tags:
-        - Streaks
-      x-codeSamples:
-        - lang: javascript
-          source: |
-            import { TrophyApiClient } from '@trophyso/node';
-
-            const trophy = new TrophyApiClient({
-              apiKey: 'YOUR_API_KEY'
-            });
-
-            const response = await trophy.streaks.rankings({
-              limit: 20,
-              type: 'active'
-            });
-        - lang: python
-          source: |
-            from trophy import TrophyApi
-
-            client = TrophyApi(api_key='YOUR_API_KEY')
-
-            response = client.streaks.rankings(limit=20, type="active")
-        - lang: go
-          source: |
-            import (
-              "context"
-
-              api "github.com/trophyso/trophy-go"
-              trophyclient "github.com/trophyso/trophy-go/client"
-              "github.com/trophyso/trophy-go/option"
-            )
-
-            client := trophyclient.NewClient(
-              option.WithApiKey("YOUR_API_KEY"),
-            )
-
-            response, err := client.Streaks.Rankings(
-              context.TODO(),
-              &api.StreaksRankingsRequest{
-                Limit: api.Int(20),
-                Type: api.StreaksRankingsRequestTypeActive.Ptr(),
-              },
-            )
-      parameters:
-        - name: limit
-          in: query
-          description: Number of users to return. Must be between 1 and 100.
-          required: false
-          schema:
-            type: integer
-            minimum: 1
-            maximum: 100
-            default: 10
-          example: 20
-        - name: type
-          in: query
-          description: Whether to rank users by active streaks or longest streaks ever achieved.
-          required: false
-          schema:
-            type: string
-            enum: ['active', 'longest']
-            default: 'active'
-          example: 'active'
-      responses:
-        '200':
-          description: Successful operation
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '#/components/schemas/StreakRankingUser'
-              examples:
-                Successful operation:
-                  value:
-                    - userId: user-123
-                      name: Alice Johnson
-                      streakLength: 15
-                    - userId: user-456
-                      name: Bob Smith
-                      streakLength: 12
-                    - userId: user-789
-                      name: Charlie Brown
-                      streakLength: 8
-        '401':
-          description: 'Unauthorized'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorBody'
-        '422':
-          description: 'Unprocessible Entity'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorBody'
-      summary: Get top users by streak length
-      security:
-        - ApiKeyAuth: []
   /users/{id}/points/{key}:
     servers:
       - url: https://api.trophy.so/v1
@@ -4564,6 +4455,12 @@ components:
         - $ref: '#/components/schemas/BaseStreakResponse'
         - type: object
           properties:
+            extended:
+              type:
+                - string
+                - 'null'
+              format: date-time
+              description: The timestamp the streak was most recently extended. Null if the streak is not active.
             streakHistory:
               type: array
               description: >-
@@ -4596,15 +4493,9 @@ components:
                   - periodStart
                   - periodEnd
                   - length
-            rank:
-              type:
-                - integer
-                - 'null'
-              description: Deprecated. The user's rank across all users. Null if the user has no active streak.
-              deprecated: true
-              example: 5
           required:
-            - rank
+            - extended
+            - streakHistory
     PointsTrigger:
       title: PointsTrigger
       type: object
@@ -5659,29 +5550,6 @@ components:
         - badgeUrl
         - maxPoints
         - triggers
-    StreakRankingUser:
-      title: StreakRankingUser
-      type: object
-      description: A user with their streak length in the rankings.
-      properties:
-        userId:
-          type: string
-          description: The ID of the user.
-          example: user-123
-        name:
-          type:
-            - string
-            - 'null'
-          description: The name of the user. May be null if no name is set.
-          example: Alice Johnson
-        streakLength:
-          type: integer
-          description: The user's streak length (active or longest depending on query parameter).
-          example: 15
-      required:
-        - userId
-        - name
-        - streakLength
     LeaderboardRanking:
       title: LeaderboardRanking
       type: object