Skip to content

Commit f8d99bd

Browse files
committed
fix: amend doc, remove pagination
1 parent 490bc0d commit f8d99bd

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/specs/openapi/admin/admin.yaml

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ paths:
426426
get:
427427
summary: Get Sponsorships
428428
description: |
429-
Returns a list of sponsorships associated with the specified policy ID.
429+
Returns a list of sponsorships associated with the specified policy ID. The results are paginated.
430430
431431
<Note title="Header Access Token">
432432
To call this endpoint, you must use your [access token](/docs/how-to-create-access-keys) in the [authorization header](/docs/how-to-use-api-keys-in-http-headers) of the API request.
@@ -448,6 +448,18 @@ paths:
448448
schema:
449449
type: integer
450450
default: 5
451+
- name: after
452+
in: query
453+
description: Limits the number of sponsorships returned. If provided, will return sponsors after the page. Can not set if `before` is set.
454+
schema:
455+
type: string
456+
default: 5
457+
- name: before
458+
in: query
459+
description: Limits the number of sponsorships returned. If provided, will return sponsors before the page. Can not set if `after` is set.
460+
schema:
461+
type: string
462+
default: 5
451463
responses:
452464
"200":
453465
description: Sponsorships fetched successfully
@@ -459,6 +471,12 @@ paths:
459471
data:
460472
type: object
461473
properties:
474+
before:
475+
type: string
476+
description: String - used for pagination. If there are previous results, `before` field is returned in the response and can be passed in the request to fetch the previous page. Can be null if there are no previous results.
477+
after:
478+
type: string
479+
description: String - used for pagination. If more results are available `after` field is returned in the response and can be passed in the request to fetch the next page. Can be null if there are no more results.
462480
sponsorships:
463481
type: array
464482
items:

0 commit comments

Comments
 (0)