Skip to content
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

add callout to master data pagination guide #1469

Merged
merged 3 commits into from
Sep 27, 2024
Merged

add callout to master data pagination guide #1469

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0b9bfb2
add callout to master data pagination guide
julia-rabello Sep 27, 2024
5bf02ad
set hidden to false
julia-rabello Sep 27, 2024
e4d62e6
apply suggestion
julia-rabello Sep 27, 2024
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
4 changes: 3 additions & 1 deletion docs/guides/Master-Data/guides/pagination-in-the-master-data-api.md
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### Setting up pagination"]

dev-portal-content/docs/guides/Master-Data/guides/pagination-in-the-master-data-api.md

Line 56 in 0b9bfb2

### Setting up pagination

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### Retrieving subsequent page..."]

dev-portal-content/docs/guides/Master-Data/guides/pagination-in-the-master-data-api.md

Line 74 in 0b9bfb2

### Retrieving subsequent pages

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[markdownlint] reported by reviewdog 🐶
MD024/no-duplicate-heading Multiple headings with the same content [Context: "### Checking if more pages are..."]

dev-portal-content/docs/guides/Master-Data/guides/pagination-in-the-master-data-api.md

Line 90 in 0b9bfb2

### Checking if more pages are available

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Pagination in the Master Data API"
slug: "pagination-in-the-master-data-api"
hidden: true
hidden: false
createdAt: "2024-09-06T18:10:15.623Z"
updatedAt: "2024-09-06T18:10:15.623Z"
---
Expand All @@ -28,6 +28,8 @@ To paginate your results using the search endpoint, include the `REST-Range` hea

For example, `resources=0-100` would return the first 100 documents from index 0 to 99. Note that you are limited to retrieving 100 documents per query.

>ℹ When paginating, the `_sort` parameter is recommended. The API does not guarantee a specific order by default; therefore, omitting the `_sort` parameter may lead to duplicate documents or return unexpected pages.

### Retrieving subsequent pages

To retrieve the next set of results, adjust the `x` and `y` values accordingly. For example, to get the next 100 documents after the first set, your `REST-Range` header would look like this: `resources=100-200`.
Expand Down
Loading