microsoft / microsoft/api-guidelines
Paging Pattern document
Open
Nobody has claimed this yet.
Graph Guidelines
Microsoft Graph
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Describe when to use $top vs $maxPageSize.
$top shouldn't return nextlinks beyond the top number of entities. If $top > pagesize then the top n entities may come back on multiple pages.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named in the issue. Locate the existing paging pattern documentation, read its guidance for $top and $maxPageSize, and update it to explain when each applies and how $top limits next links and entities across pages.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100