adding channel search to OAS

neynarxyz · Dec 19, 2023 · f00d290 · f00d290
1 parent ce79f26
commit f00d290
Showing 1 changed file with 25 additions and 0 deletions.
diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -1664,6 +1664,31 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ChannelListResponse"
+  /farcaster/channel/search: 
+    get:
+      tags:
+        - Channel
+      summary: Search for channels based on id or name
+      description: Returns a list of channels based on id or name
+      externalDocs:
+        url: https://docs.neynar.com/reference/search-channels
+      operationId: search-channels
+      parameters:
+        - $ref: "#/components/parameters/ApiKey"
+        - name: q
+          in: query
+          required: true
+          schema:
+            type: string
+          example: "neynar"
+          description: Channel ID or name for the channel being queried
+      responses:
+        "200":
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ChannelListResponse"
   /farcaster/channel:
     get:
       tags: