diff --git a/src/hub-rest-api/spec.yaml b/src/hub-rest-api/spec.yaml index b241dd0..ba52d98 100644 --- 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 index 2ec726f..6d20470 100644 --- 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 diff --git a/src/v2/spec.yaml b/src/v2/spec.yaml index 4a23531..58e4c87 100644 --- a/src/v2/spec.yaml +++ b/src/v2/spec.yaml @@ -1374,7 +1374,7 @@ components: type: string target_author_fid: $ref: "#/components/schemas/Fid" - description: If the target is a cast hash, this value should indicate the target cast's author's fid (unsigned integer) + description: If the target is a cast hash, this value should indicate the target cast's author's FID (unsigned integer) idem: $ref: "#/components/schemas/Idem" ChannelType: @@ -3729,8 +3729,8 @@ paths: get: tags: - User - summary: Fetch fresh fid - description: Fetches fid to [assign it to new user](https://docs.neynar.com/reference/register-user) + summary: Fetch fresh FID + description: Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-user) externalDocs: url: https://docs.neynar.com/reference/get-fresh-fid operationId: get-fresh-fid @@ -3749,7 +3749,7 @@ paths: get: tags: - Signer - summary: Fetch status by public key + summary: Status by public key description: Fetches the status of a developer managed signer by public key externalDocs: url: https://docs.neynar.com/reference/developer-managed-signer @@ -3774,7 +3774,7 @@ paths: post: tags: - Signer - summary: Registers Signed Key + summary: Register Signed Key description: Registers an signed key and returns the developer managed signer status with an approval url. externalDocs: url: https://docs.neynar.com/reference/register-signed-key-for-developer-managed-signer @@ -3808,7 +3808,7 @@ paths: get: tags: - Signer - summary: Fetch status + summary: Status description: Gets information status of a signer by passing in a signer_uuid (Use post API to generate a signer) externalDocs: url: https://docs.neynar.com/reference/signer @@ -3862,7 +3862,7 @@ paths: tags: - Signer summary: Register Signed Key - description: Registers an app fid, deadline and a signature. Returns the signer status with an approval url. + description: Registers an app FID, deadline and a signature. Returns the signer status with an approval url. externalDocs: url: https://docs.neynar.com/reference/register-signed-key operationId: register-signed-key @@ -4127,8 +4127,8 @@ paths: get: tags: - Channel - summary: Fetch all channels that a given fid follows - description: Returns a list of all channels with their details that a fid follows. + summary: Following + description: Returns a list of all channels with their details that a FID follows. externalDocs: url: https://docs.neynar.com/reference/user-channels operationId: user-channels @@ -4137,7 +4137,7 @@ paths: - name: fid in: query required: true - description: The fid of the user. + description: The FID of the user. schema: $ref: "#/components/schemas/Fid" - name: limit @@ -4166,8 +4166,8 @@ paths: get: tags: - Channel - summary: Fetch all channels that a given fid is a member of - description: Returns a list of all channels with their details that an fid is a member of. Data may have a delay of up to 1 hour. + summary: Member of + description: Returns a list of all channels with their details that an FID is a member of. Data may have a delay of up to 1 hour. externalDocs: url: https://docs.neynar.com/reference/user-channel-memberships operationId: user-channel-memberships @@ -4249,11 +4249,11 @@ paths: post: tags: - User - summary: Register farcaster account + summary: Register new account description: | Register account on farcaster. - **Note:** This API must be called within 10 minutes of the fetch fid API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this fid to another available user. + **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. externalDocs: url: https://docs.neynar.com/reference/register-user operationId: register-user @@ -4292,7 +4292,7 @@ paths: post: tags: - Signer - summary: Publish a message to farcaster + summary: Publish message description: Publish a message to farcaster. The message must be signed by a signer managed by the developer. Use the @farcaster/core library to construct and sign the message. Use the Message.toJSON method on the signed message and pass the JSON in the body of this POST request. externalDocs: @@ -4649,7 +4649,7 @@ paths: $ref: "#/components/schemas/FeedType" default: following example: filter - description: Defaults to following (requires fid or address). If set to filter (requires filter_type) + description: Defaults to following (requires FID or address). If set to filter (requires filter_type) - name: filter_type in: query schema: @@ -4660,7 +4660,7 @@ paths: in: query schema: $ref: "#/components/schemas/Fid" - description: (Optional) fid of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type + description: (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type - name: fids in: query schema: @@ -4748,7 +4748,7 @@ paths: example: 3 schema: $ref: "#/components/schemas/Fid" - description: fid of user whose feed you want to create + description: FID of user whose feed you want to create - name: viewer_fid in: query required: false @@ -4801,7 +4801,7 @@ paths: example: 194 schema: $ref: "#/components/schemas/Fid" - description: fid of user whose feed you want to create + description: FID of user whose feed you want to create - name: viewer_fid in: query required: false @@ -4854,8 +4854,8 @@ paths: get: tags: - Subscribers - summary: Fetch created subscriptions for a given fid - description: Fetch created subscriptions for a given fid's. + summary: Subscriptions created by FID + description: Fetch created subscriptions for a given FID's. externalDocs: url: https://docs.neynar.com/reference/subscriptions-created operationId: subscriptions-created @@ -4886,8 +4886,8 @@ paths: get: tags: - Subscribers - summary: Fetch what a given fid is subscribed to - description: Fetch what fids and contracts a fid is subscribed to. + summary: Subscribed to + description: Fetch what fids and contracts a FID is subscribed to. externalDocs: url: https://docs.neynar.com/reference/subscribed-to operationId: subscribed-to @@ -4924,8 +4924,8 @@ paths: get: tags: - Subscribers - summary: Fetch subscribers for a given fid - description: Fetch subscribers for a given fid's contracts. Doesn't return addresses that don't have an fid. + summary: Subscribers of a user + description: Fetch subscribers for a given FID's contracts. Doesn't return addresses that don't have an FID. externalDocs: url: https://docs.neynar.com/reference/subscribers operationId: subscribers @@ -5226,7 +5226,7 @@ paths: example: 194 schema: $ref: "#/components/schemas/Fid" - description: fid of user whose feed you want to create + description: FID of user whose feed you want to create - name: viewer_fid in: query required: false @@ -5244,7 +5244,7 @@ paths: $ref: "#/components/responses/400Response" /farcaster/feed/user/replies_and_recasts: get: - summary: Recent replies and recasts + summary: Replies and recasts description: Fetch recent replies and recasts for a given user FID; sorted by most recent first externalDocs: url: https://docs.neynar.com/reference/feed-user-replies-recasts @@ -5259,7 +5259,7 @@ paths: example: 194 schema: $ref: "#/components/schemas/Fid" - description: fid of user whose replies and recasts you want to fetch + description: FID of user whose replies and recasts you want to fetch - name: filter in: query required: false @@ -5504,7 +5504,7 @@ paths: get: tags: - Frame - summary: Fetch the frame meta tags from the URL + summary: Meta tags from URL description: Fetches the frame meta tags from the URL operationId: frame-from-url parameters: @@ -5611,7 +5611,7 @@ paths: post: tags: - User - summary: Adds verification for an ethereum address or contract for the user + summary: Add verification description: | Adds verification for an eth address or contract for the user \ (In order to add verification `signer_uuid` must be approved) @@ -5640,7 +5640,7 @@ paths: delete: tags: - User - summary: Delete eth address verification + summary: Delete verification description: | Removes verification for an eth address for the user \ (In order to delete verification `signer_uuid` must be approved) @@ -5844,7 +5844,7 @@ paths: post: tags: - Frame - summary: Post a frame signature packet + summary: Signature packet description: | Post a frame action that has been signed with a developer managed signer @@ -6559,7 +6559,7 @@ paths: get: tags: - Channel - summary: Fetch by ID or parent_url + summary: By ID or parent_url description: Returns details of a channel externalDocs: url: https://docs.neynar.com/reference/channel-details @@ -6761,7 +6761,7 @@ paths: required: true schema: $ref: "#/components/schemas/Fid" - description: The user's fid (identifier) + description: The user's FID (identifier) example: 194 - name: limit in: query @@ -6865,7 +6865,7 @@ paths: get: tags: - Channel - summary: Fetch trending channels based on activity + summary: Channels by activity description: Returns a list of trending channels based on activity externalDocs: url: https://docs.neynar.com/reference/trending-channels @@ -7187,7 +7187,7 @@ paths: get: tags: - Storage - summary: Storage allocations of user + summary: Allocation of user description: Fetches storage allocations for a given user operationId: storage-allocations externalDocs: @@ -7213,7 +7213,7 @@ paths: get: tags: - Storage - summary: Storage usage of user + summary: Usage of user description: Fetches storage usage for a given user operationId: storage-usage externalDocs: @@ -7241,7 +7241,7 @@ paths: - Storage summary: Buy storage description: | - This api will help you rent units of storage for an year for a specific fid. + This api will help you rent units of storage for an year for a specific FID. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links. operationId: buy-storage externalDocs: @@ -7416,7 +7416,7 @@ paths: get: tags: - Mute - summary: Fetch fids that a user has muted + summary: Muted FIDs of user description: Fetches all fids that a user has muted. operationId: mute-list parameters: @@ -7426,7 +7426,7 @@ paths: required: true schema: $ref: "#/components/schemas/Fid" - description: The user's fid (identifier) + description: The user's FID (identifier) example: 194 - name: limit in: query @@ -7461,8 +7461,8 @@ paths: post: tags: - Mute - summary: Adds a mute for a fid - description: Adds a mute for a given fid. This is a whitelisted API, reach out if you want access. + summary: Mute FID + description: Adds a mute for a given FID. This is a whitelisted API, reach out if you want access. operationId: add-mute parameters: - $ref: "#/components/parameters/ApiKey" @@ -7488,8 +7488,8 @@ paths: delete: tags: - Mute - summary: Deletes a mute for a fid - description: Deletes a mute for a given fid. This is a whitelisted API, reach out if you want access. + summary: Unmute FID + description: Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access. operationId: delete-mute parameters: - $ref: "#/components/parameters/ApiKey" @@ -7516,7 +7516,7 @@ paths: get: tags: - Block - summary: Fetch fids that a user has blocked or has been blocked by + summary: Blocked / Blocked by FIDs description: Fetches all fids that a user has blocked or has been blocked by operationId: block-list parameters: @@ -7569,7 +7569,7 @@ paths: get: tags: - Ban - summary: Fetch fids that your app has banned + summary: Banned FIDs of app description: Fetches all fids that your app has banned. operationId: ban-list parameters: @@ -7607,7 +7607,7 @@ paths: post: tags: - Ban - summary: Bans a list of fids from your app. + summary: Ban FIDs from app description: Bans a list of fids from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds. operationId: add-ban parameters: @@ -7634,7 +7634,7 @@ paths: delete: tags: - Ban - summary: Deletes a list of fids from your app's ban list. + summary: Unban FIDs from app description: Deletes a list of fids from the app associated with your API key. operationId: delete-ban parameters: diff --git a/src/v2/stp/spec.yaml b/src/v2/stp/spec.yaml index 8d8a7e2..49219fd 100644 --- a/src/v2/stp/spec.yaml +++ b/src/v2/stp/spec.yaml @@ -10,12 +10,12 @@ security: components: securitySchemes: - ApiKeyAuth: - type: apiKey - in: header - name: x-api-key - description: "API key to authorize requests" - x-default: "NEYNAR_API_DOCS" + ApiKeyAuth: + type: apiKey + in: header + name: x-api-key + description: "API key to authorize requests" + x-default: "NEYNAR_API_DOCS" schemas: ConflictErrorRes: type: object @@ -49,7 +49,7 @@ components: SubscriptionCheckResponse: type: object additionalProperties: - $ref: '#/components/schemas/SubscriptionStatus' + $ref: "#/components/schemas/SubscriptionStatus" example: "0xedd3783e8c7c52b80cfbd026a63c207edc9cbee7": object: "subscribed_to_dehydrated" @@ -67,7 +67,7 @@ components: status: false expires_at: null subscribed_at: null - tier: null + tier: null SubscriptionStatus: type: object properties: @@ -85,7 +85,7 @@ components: format: int64 nullable: true tier: - $ref: '#/components/schemas/SubscriptionTier' + $ref: "#/components/schemas/SubscriptionTier" nullable: true required: - object @@ -150,14 +150,12 @@ components: schema: $ref: "#/components/schemas/ErrorRes" - - paths: /stp/subscription_check: get: tags: - STP - summary: Check if a wallet address is subscribed to a STP contract + summary: Subscription check by wallet address description: Check if a wallet address is subscribed to a given STP contract. operationId: subscription-check externalDocs: @@ -192,4 +190,4 @@ paths: schema: $ref: "#/components/schemas/SubscriptionCheckResponse" "400": - $ref: "#/components/responses/400Response" \ No newline at end of file + $ref: "#/components/responses/400Response"