feat: add channel details API

neynarxyz · Dec 18, 2023 · 37edc80 · 37edc80
1 parent a9649b1
commit 37edc80
Showing 1 changed file with 36 additions and 2 deletions.
diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -476,8 +476,8 @@ components:
           type: string
         image_url:
           type: string
-        lead_fid:
-          $ref: "#/components/schemas/Fid"
+        lead:
+          $ref: "#/components/schemas/User"
     ChannelListResponse:
       type: object
       required:
@@ -487,6 +487,13 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/Channel"
+    ChannelResponse:
+      type: object
+      required:
+        - channel
+      properties:
+        channel:
+          $ref: "#/components/schemas/Channel"
     UserSearchResponse:
       type: object
       required:
@@ -1648,6 +1655,33 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ChannelListResponse"
+  /farcaster/channel:
+    get:
+      tags:
+        - Channel
+      summary: Retrieve channel details by channel_id
+      description: Returns details of a channel
+      externalDocs:
+        url: https://docs.neynar.com/reference/channel-details
+      operationId: channel-details
+      parameters:
+        - $ref: "#/components/parameters/ApiKey"
+        - name: channel_id
+          in: query
+          required: true
+          schema:
+            type: string
+          example: "neynar"
+          description: Channel ID for the channel being queried
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ChannelResponse"
+        "404":
+          $ref: "#/components/responses/404Response"
   /farcaster/followers/relevant:
     get:
       tags: