spec changes for solana and v1 deprecations (#41)

neynarxyz · Feb 24, 2024 · c25076f · c25076f
1 parent d566e18
commit c25076f
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 12 deletions.
diff --git a/src/v1/spec.yaml b/src/v1/spec.yaml
@@ -795,7 +795,7 @@ paths:
     get:
       tags:
         - User
-      summary: Deprecated - Get User Information by FID
+      summary: DEPRECATED - Get User Information by FID
       description: Now deprecated, use [v2/user/bulk](https://docs.neynar.com/reference/user-bulk). Returns metadata about a specific user
       externalDocs:
         url: https://docs.neynar.com/reference/user-v1
@@ -868,7 +868,7 @@ paths:
     get:
       tags:
         - User
-      summary: Deprecated -- Get User Cast Likes
+      summary: DEPRECATED -- Get User Cast Likes
       description: Now deprecated. use [/v2/reactions/user](https://docs.neynar.com/reference/reactions-user). Fetch all the liked cast of a User
       externalDocs:
         url: https://docs.neynar.com/reference/user-cast-likes-v1
@@ -956,8 +956,8 @@ paths:
     get:
       tags:
         - User
-      summary: Get the custody address for a given FID
-      description: Returns the custody address for a given FID
+      summary: DEPRECATED - Get the custody address for a given FID
+      description: Now deprecated, use [v2/user/bulk](https://docs.neynar.com/reference/user-bulk), custody address is in the user object. Returns the custody address for a given FID
       externalDocs:
         url: https://docs.neynar.com/reference/custody-address-v1
       operationId: custody-address
@@ -983,7 +983,7 @@ paths:
     get:
       tags:
         - Cast
-      summary: Deprecated - Retrieve cast for a given hash
+      summary: DEPRECATED - Retrieve cast for a given hash
       description: Now deprecated, use [v2/cast](https://docs.neynar.com/reference/cast). Gets information about an individual cast
       externalDocs:
         url: https://docs.neynar.com/reference/cast-v1
@@ -1149,8 +1149,13 @@ paths:
     get:
       tags:
         - Verification
-      summary: Retrieve verifications for a given FID
-      description: Get all known verifications of a user
+      summary: DEPRECATED - Retrieve verifications for a given FID
+      description: Now deprecated, use [v2/user/bulk](https://docs.neynar.com/reference/user-bulk), verifications are in the user object. 
+
+
+      Get all known verifications of a user.
+
+
       externalDocs:
         url: https://docs.neynar.com/reference/verifications-v1
       operationId: verifications
@@ -1175,7 +1180,7 @@ paths:
     get:
       tags:
         - Verification
-      summary: Deprecated - Retrieve user for a given ethereum address
+      summary: DEPRECATED - Retrieve user for a given ethereum address
       description: >-
         Now deprecated. Use [v2/user/bulk-by-address](https://docs.neynar.com/reference/user-bulk-by-address). Checks if a given Ethereum address has a Farcaster user associated with it. Note: if an address is associated with multiple users, the API will return the user who most recently published a verification with the address (based on when Warpcast received the proof, not a self-reported timestamp).
       externalDocs:

diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml
@@ -1429,21 +1429,23 @@ paths:
     get:
       tags:
         - User
-      summary: Fetches all users based on multiple Ethereum addresses
-      description: Fetches all users based on multiple Ethereum addresses.
+      summary: Fetches users based on Eth or Sol addresses
+      description: Fetches all users based on multiple Ethereum or Solana addresses.
 
 
-        Each farcaster user has a custody Ethereum address and optionally verified Ethereum addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum addresses.
+        Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses.
 
 
         A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users.
+
+        You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses.
       externalDocs:
         url: https://docs.neynar.com/reference/user-bulk-by-address
       operationId: user-bulk-by-address
       parameters:
         - $ref: "#/components/parameters/ApiKey"
         - name: addresses
-          description: Comma separated list of Ethereum addresses, up to 350 at a time
+          description: Comma separated list of addresses, up to 350 at a time
           in: query
           required: true
           example: 0xa6a8736f18f383f1cc2d938576933e5ea7df01a1,0x7cac817861e5c3384753403fb6c0c556c204b1ce
@@ -2725,12 +2727,14 @@ paths:
           in: query
           required: true
           description: User who's profile you are looking at
+          example: 3
           schema:
             $ref: "#/components/schemas/Fid"
         - name: viewer_fid
           in: query
           required: true
           description: Viewer who's looking at the profile
+          example: 194
           schema:
             $ref: "#/components/schemas/Fid"
       responses: