Skip to content

PAPI-3321: Add information about cursor pagination support by metafield endpoints #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bc-tayvs wants to merge 4 commits into
base: main
Choose a base branch
from
Open

PAPI-3321: Add information about cursor pagination support by metafield endpoints #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fdb9a50
add cursor related data
bc-tayvs Jan 13, 2026
5c93c70
add cursor related data
bc-tayvs Jan 13, 2026
300de09
add cursor related data
bc-tayvs Jan 13, 2026
7229e5c
add cursor related data
bc-tayvs Jan 13, 2026
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 package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

161 changes: 114 additions & 47 deletions reference/carts.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,8 @@ paths:
- $ref: '#/components/parameters/date_modified_max'
- $ref: '#/components/parameters/date_created_min'
- $ref: '#/components/parameters/date_created_max'
- $ref: '#/components/parameters/BeforeCursorParam'
- $ref: '#/components/parameters/AfterCursorParam'
post:
summary: Create multiple Metafields
tags:
Expand Down Expand Up @@ -1290,6 +1292,101 @@ paths:
$ref: '#/components/schemas/MetaFieldCollectionResponsePartialSuccess_DELETE'
components:
schemas:
Pagination:
type: object
description: Data about the response, including pagination and collection totals.
title: Pagination
properties:
total:
type: integer
description: |
Total number of items in the result set.
example: 36
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
current_page:
type: integer
description: |
The page you are currently on within the collection.
example: 1
total_pages:
type: integer
description: |
The total number of pages in the collection.
example: 1
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Link to the previous page returned in the response.
current:
type: string
description: |
Link to the current page returned in the response.
example: '?page=1&limit=50'
next:
type: string
description: |
Link to the next page returned in the response.
x-internal: false
CursorPagination:
type: object
description: Data about the response, including cursor pagination and collection totals.
title: CursorPagination
properties:
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
start_cursor:
type: string
description: |
Cursor that is referring to a start of current page.
example: "aWQ6Nw=="
end_cursor:
type: string
description: |
Cursor that is referring to a end of current page. Should be used to fetch next page.
example: "aWQ6Nw=="
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Cursor to the previous page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
current:
type: string
description: |
Cursor to the current page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
next:
type: string
description: |
Cursor to the next page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
x-internal: false
CartUpdateRequest:
type: object
properties:
Expand Down Expand Up @@ -3667,53 +3764,9 @@ components:
description: Data about the response, including pagination and collection totals.
properties:
pagination:
type: object
description: Data about the response, including pagination and collection totals.
title: Pagination
properties:
total:
type: integer
description: |
Total number of items in the result set.
example: 36
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
current_page:
type: integer
description: |
The page you are currently on within the collection.
example: 1
total_pages:
type: integer
description: |
The total number of pages in the collection.
example: 1
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Link to the previous page returned in the response.
current:
type: string
description: |
Link to the current page returned in the response.
example: '?page=1&limit=50'
next:
type: string
description: |
Link to the next page returned in the response.
$ref: '#/components/schemas/Pagination'
cursor_pagination:
$ref: '#/components/schemas/CursorPagination'
additionalProperties: true
title: Collection Meta
x-internal: false
Expand Down Expand Up @@ -3779,6 +3832,20 @@ components:
meta:
$ref: '#/components/schemas/metaCollection_open'
parameters:
BeforeCursorParam:
name: 'before'
description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.'
in: query
required: false
schema:
type: string
AfterCursorParam:
name: 'after'
description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.'
in: query
required: false
schema:
type: string
Accept:
name: Accept
in: header
Expand Down
165 changes: 118 additions & 47 deletions reference/catalog/brands_catalog.v3.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1456,6 +1456,12 @@ paths:
- $ref: '#/components/parameters/MetafieldNamespaceInParam'
- $ref: '#/components/parameters/DirectionParam'
- $ref: '#/components/parameters/IncludeFieldsParamMetafields'
- $ref: '#/components/parameters/date_modified_min'
- $ref: '#/components/parameters/date_modified_max'
- $ref: '#/components/parameters/date_created_min'
- $ref: '#/components/parameters/date_created_max'
- $ref: '#/components/parameters/BeforeCursorParam'
- $ref: '#/components/parameters/AfterCursorParam'
post:
summary: Create multiple metafields
tags:
Expand Down Expand Up @@ -1656,6 +1662,101 @@ paths:
- $ref: '#/components/parameters/Accept'
components:
schemas:
Pagination:
type: object
description: Data about the response, including pagination and collection totals.
title: Pagination
properties:
total:
type: integer
description: |
Total number of items in the result set.
example: 36
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
current_page:
type: integer
description: |
The page you are currently on within the collection.
example: 1
total_pages:
type: integer
description: |
The total number of pages in the collection.
example: 1
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Link to the previous page returned in the response.
current:
type: string
description: |
Link to the current page returned in the response.
example: '?page=1&limit=50'
next:
type: string
description: |
Link to the next page returned in the response.
x-internal: false
CursorPagination:
type: object
description: Data about the response, including cursor pagination and collection totals.
title: CursorPagination
properties:
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
start_cursor:
type: string
description: |
Cursor that is referring to a start of current page.
example: "aWQ6Nw=="
end_cursor:
type: string
description: |
Cursor that is referring to a end of current page. Should be used to fetch next page.
example: "aWQ6Nw=="
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Cursor to the previous page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
current:
type: string
description: |
Cursor to the current page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
next:
type: string
description: |
Cursor to the next page returned in the response.
example: '?page=1&after=aWQ6Nw%3D%3D'
x-internal: false
brand_Full:
title: brand_Full
required:
Expand Down Expand Up @@ -2190,53 +2291,9 @@ components:
description: Data about the response, including pagination and collection totals.
properties:
pagination:
type: object
description: Data about the response, including pagination and collection totals.
title: Pagination
properties:
total:
type: integer
description: |
Total number of items in the result set.
example: 36
count:
type: integer
description: |
Total number of items in the collection response.
example: 36
per_page:
type: integer
description: |
The amount of items returned in the collection per page, controlled by the limit parameter.
example: 50
current_page:
type: integer
description: |
The page you are currently on within the collection.
example: 1
total_pages:
type: integer
description: |
The total number of pages in the collection.
example: 1
links:
type: object
description: |
Pagination links for the previous and next parts of the whole collection.
properties:
previous:
type: string
description: |
Link to the previous page returned in the response.
current:
type: string
description: |
Link to the current page returned in the response.
example: '?page=1&limit=50'
next:
type: string
description: |
Link to the next page returned in the response.
$ref: '#/components/schemas/Pagination'
cursor_pagination:
$ref: '#/components/schemas/CursorPagination'
additionalProperties: true
title: Collection Meta
x-internal: false
Expand Down Expand Up @@ -2395,6 +2452,20 @@ components:
type: object
properties: { }
parameters:
BeforeCursorParam:
name: 'before'
description: 'A cursor indicating where to start retrieving the previous page of results. Use this parameter to paginate backward. Not required for the initial request. For subsequent requests, use the end_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the after parameter.'
in: query
required: false
schema:
type: string
AfterCursorParam:
name: 'after'
description: 'A cursor indicating where to start retrieving the next page of results. Use this parameter to paginate forward. Not required for the initial request. For subsequent requests, use the start_cursor value returned in meta.cursor_pagination from the previous response. Works with limit, direction, and other supported query parameters. When specified, offset-based pagination (page) is ignored. Cannot be used in combination with the before parameter.'
in: query
required: false
schema:
type: string
DirectionQuery:
name: direction
in: query
Expand Down
Loading