Skip to content

Commit

Permalink
Rearrange limit, cursor positioning in v2 apis
Browse files Browse the repository at this point in the history
  • Loading branch information
Shreyaschorge committed Nov 21, 2023
1 parent da91517 commit b9d6fe1
Showing 1 changed file with 23 additions and 22 deletions.
45 changes: 23 additions & 22 deletions src/v2/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -689,6 +689,7 @@ components:
$ref: "#/components/schemas/Reactions"
next:
$ref: "#/components/schemas/NextCursor"

parameters:
ApiKey:
name: api_key
Expand Down Expand Up @@ -1145,11 +1146,12 @@ paths:
schema:
type: string
description: Used when filter_type=parent_url can be used to fetch content under any parent url e.g. FIP-2 channels on Warpcast. Requires feed_type and filter_type
- name: cursor
- name: with_recasts
in: query
description: Pagination cursor.
description: Include recasts in the response, true by default
schema:
type: string
type: boolean
default: true
- name: limit
in: query
description: Number of results to retrieve (default 25, max 100)
Expand All @@ -1158,12 +1160,11 @@ paths:
default: 25
minimum: 1
maximum: 100
- name: with_recasts
- name: cursor
in: query
description: Include recasts in the response, true by default
description: Pagination cursor.
schema:
type: boolean
default: true
type: string
responses:
"200":
description: Successful operation.
Expand Down Expand Up @@ -1427,12 +1428,6 @@ paths:
required: true
schema:
$ref: "#/components/schemas/Fid"
- name: cursor
in: query
description: Pagination cursor.
required: false
schema:
type: string
- name: limit
in: query
description: Number of results to retrieve (default 25, max 50)
Expand All @@ -1442,6 +1437,12 @@ paths:
default: 25
minimum: 1
maximum: 50
- name: cursor
in: query
description: Pagination cursor.
required: false
schema:
type: string
responses:
"200":
description: Successful response
Expand Down Expand Up @@ -1500,11 +1501,13 @@ paths:
example: 3
schema:
$ref: "#/components/schemas/Fid"
- name: cursor
- name: type
in: query
description: Pagination cursor.
required: true
description: Type of reaction to fetch (likes or recasts or all)
example: likes
schema:
type: string
$ref: "#/components/schemas/ReactionsType"
- name: limit
in: query
description: Number of results to retrieve (default 25, max 100)
Expand All @@ -1513,13 +1516,11 @@ paths:
default: 25
minimum: 1
maximum: 100
- name: type
- name: cursor
in: query
required: true
description: Type of reaction to fetch (likes or recasts or all)
example: likes
description: Pagination cursor.
schema:
$ref: "#/components/schemas/ReactionsType"
type: string
responses:
"200":
description: Successful operation.
Expand All @@ -1528,4 +1529,4 @@ paths:
schema:
$ref: "#/components/schemas/ReactionsResponse"
"400":
$ref: "#/components/responses/400Response"
$ref: "#/components/responses/400Response"

0 comments on commit b9d6fe1

Please sign in to comment.