fix: shorten titles (#239)

neynarxyz · Oct 24, 2024 · c14a995 · c14a995
1 parent b92da99
commit c14a995
Show file tree

Hide file tree

Showing 4 changed files with 91 additions and 93 deletions.
diff --git a/src/hub-rest-api/spec.yaml b/src/hub-rest-api/spec.yaml
@@ -38,7 +38,7 @@ paths:
     get:
       tags:
         - Casts
-      summary: Fetch a cast by its FID and Hash.
+      summary: By FID and Hash
       operationId: GetCastById
       parameters:
         - name: fid
@@ -69,7 +69,7 @@ paths:
     get:
       tags:
         - Casts
-      summary: Fetch all casts authored by an FID.
+      summary: By FID
       operationId: ListCastsByFid
       parameters:
         - name: fid
@@ -107,7 +107,7 @@ paths:
     get:
       tags:
         - Casts
-      summary: Fetch all casts that mention an FID
+      summary: Mentioning an FID
       operationId: ListCastsByMention
       parameters:
         - name: fid
@@ -145,7 +145,7 @@ paths:
     get:
       tags:
         - Casts
-      summary: Fetch all casts by parent cast's FID and Hash OR by the parent's URL
+      summary: By parent cast's FID and Hash OR by the parent's URL
       operationId: ListCastsByParent
       parameters:
         - name: fid
@@ -193,7 +193,7 @@ paths:
     get:
       tags:
         - Reactions
-      summary: Fetch a reaction by its created FID and target Cast.
+      summary: By its created FID and target cast
       operationId: GetReactionById
       parameters:
         - name: fid
@@ -236,7 +236,7 @@ paths:
     get:
       tags:
         - Reactions
-      summary: Fetch all reactions to a cast
+      summary: On cast
       operationId: ListReactionsByCast
       parameters:
         - name: target_fid
@@ -287,7 +287,7 @@ paths:
     get:
       tags:
         - Reactions
-      summary: Fetch all reactions by an FID
+      summary: By FID
       operationId: ListReactionsByFid
       parameters:
         - name: fid
@@ -332,7 +332,7 @@ paths:
       tags:
         - Reactions
       operationId: ListReactionsByTarget
-      summary: Fetch all reactions to a target URL
+      summary: To a target URL
       parameters:
         - name: url
           in: query
@@ -375,7 +375,7 @@ paths:
     get:
       tags:
         - Links
-      summary: Fetch a link by its FID and target FID.
+      summary: By its FID and target FID.
       operationId: GetLinkById
       parameters:
         - name: fid
@@ -411,7 +411,7 @@ paths:
     get:
       tags:
         - Links
-      summary: Fetch all links from a source FID
+      summary: From source FID
       operationId: ListLinksByFid
       parameters:
         - name: fid
@@ -455,7 +455,7 @@ paths:
     get:
       tags:
         - Links
-      summary: Fetch all links to a target FID
+      summary: To target FID
       operationId: ListLinksByTargetFid
       parameters:
         - name: target_fid
@@ -569,7 +569,7 @@ paths:
       tags:
         - Storage
       operationId: GetStorageLimitsByFid
-      summary: Fetch an FID's storage limits.
+      summary: FID's limits
       parameters:
         - name: fid
           in: query
@@ -592,7 +592,7 @@ paths:
       tags:
         - Usernames
       operationId: ListUsernameProofsByFid
-      summary: Fetch a list of proofs provided by an FID
+      summary: Proofs provided by an FID
       parameters:
         - name: fid
           in: query
@@ -614,7 +614,7 @@ paths:
     get:
       tags:
         - Usernames
-      summary: Fetch an proof for a username by the Farcaster username
+      summary: Proof for a username
       operationId: GetUsernameProof
       parameters:
         - name: name
@@ -642,7 +642,7 @@ paths:
       tags:
         - Verifications
       operationId: ListVerificationsByFid
-      summary: Fetch a list of verifications provided by an FID
+      summary: Provided by an FID
       parameters:
         - name: fid
           in: query

diff --git a/src/v1/spec.yaml b/src/v1/spec.yaml
@@ -792,13 +792,13 @@ paths:
         - name: fid
           in: query
           required: true
-          description: fid of a user
+          description: FID of a user
           schema:
             $ref: "#/components/schemas/Fid"
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           schema:
             $ref: "#/components/schemas/Fid"
@@ -834,7 +834,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           schema:
             $ref: "#/components/schemas/Fid"
@@ -869,7 +869,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           schema:
             $ref: "#/components/schemas/Fid"
@@ -909,7 +909,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -950,7 +950,7 @@ paths:
         - name: fid
           in: query
           required: true
-          description: fid of a user
+          description: FID of a user
           schema:
             $ref: "#/components/schemas/Fid"
       responses:
@@ -982,7 +982,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -1016,7 +1016,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -1043,7 +1043,7 @@ paths:
         - name: fid
           in: query
           required: true
-          description: fid of a user
+          description: FID of a user
           schema:
             $ref: "#/components/schemas/Fid"
         - name: parent_url
@@ -1057,7 +1057,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -1099,7 +1099,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -1193,13 +1193,13 @@ paths:
         - name: fid
           in: query
           required: true
-          description: fid of a user
+          description: FID of a user
           schema:
             $ref: "#/components/schemas/Fid"
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           schema:
@@ -1232,14 +1232,14 @@ paths:
         - name: fid
           in: query
           required: true
-          description: fid of a user
+          description: FID of a user
           example: 6131
           schema:
             $ref: "#/components/schemas/Fid"
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           example: 3
@@ -1289,7 +1289,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           example: 194
@@ -1339,7 +1339,7 @@ paths:
         - name: viewerFid
           in: query
           description: >-
-            fid of the user viewing this information, needed for contextual
+            FID of the user viewing this information, needed for contextual
             information.
           required: false
           example: 194