user's active channels OAS spec (#43)

neynarxyz · Feb 27, 2024 · 218550c · 218550c
1 parent 7001247
commit 218550c
Showing 1 changed file with 34 additions and 0 deletions.
diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -2651,6 +2651,40 @@ paths:
                 $ref: "#/components/schemas/UsersResponse"
         "400":
           $ref: "#/components/responses/400Response"
+  /farcaster/channel/user:
+    get:
+      tags:
+        - User
+      summary: Get channels that a user is active in. 
+      description: Fetches all channels that a user has casted in, in reverse chronological order. Once follows are on the protocol, we will allow choosing for different types of user activity (e.g. casted, followed, etc.). 
+      operationId: active-channels
+      parameters:
+        - $ref: "#/components/parameters/ApiKey"
+        - name: fid
+          in: query
+          required: true
+          schema:
+            $ref: '#/components/schemas/Fid'
+          description: The user's fid (identifier)
+          example: 194
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  user:
+                    $ref: '#/components/schemas/User' 
+                  channels:
+                    type: array
+                    items:
+                      $ref: '#/components/schemas/Channel'
+        '400':
+          $ref: "#/components/responses/400Response"
+        '404':
+          $ref: "#/components/responses/400Response"
   /farcaster/channel/users:
     get:
       tags: