Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion openapi/components/parameters/After.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: after
in: query
required: false
description: Use the `endCursor` as a value for the `after` parameter to get the next page.
description: Use the `nextPage` value as the `after` parameter to get the next page.
schema:
type: string
2 changes: 1 addition & 1 deletion openapi/components/parameters/Before.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@ name: before
in: query
required: false
description: |
Use the `startCursor` as a value for the `before` parameter to get the previous page.
Use the `previousPage` value as the `before` parameter to get the previous page.
schema:
type: string
25 changes: 6 additions & 19 deletions openapi/components/schemas/Page.yaml
Original file line number Diff line number Diff line change
@@ -1,41 +1,28 @@
type: object
properties:
endCursor:
nextPage:
type:
- string
- 'null'
description: |-
Use with the `after` query parameter to load the next page of data.
When `null`, there is no data.
When `null`, there is no next page.
The cursor is opaque and internal structure is subject to change.
startCursor:
previousPage:
type:
- string
- 'null'
description: |-
Use with the `before` query parameter to load the previous page of data.
When `null`, there is no data.
When `null`, there is no previous page.
The cursor is opaque and internal structure is subject to change.
hasNextPage:
type: boolean
description: Indicates if there is a next page with items.
hasPrevPage:
type: boolean
description: Indicates if there is a previous page with items.
limit:
type: integer
minimum: 1
maximum: 100
default: 10
description: Value showing how many items are in the page limit.
total:
type: integer
description: Count of items across all pages.
minimum: 0
required:
- endCursor
- startCursor
- hasNextPage
- hasPrevPage
- nextPage
- previousPage
- limit
- total
Comment thread
DaveTheWebDev marked this conversation as resolved.
Loading