VNG-Realisatie / VNG-Realisatie/VNG-API-Lab

Pagination patterns

Open
#4 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Patronen
Dominant language
TypeScript
Stars
1
Forks
1
PR merge metrics
No merged PRs in 30d

Description

Pagination is essentieel op vrijwel ieder collection of query endpoint. Helaas wordt zeer vaak het wiel opnieuw uitgevonden, waardoor zelfs APIs binnen onze domeinen op subtiele manieren van elkaar verschillen. Met herbruikbare yml OAS componenten kunnen we dit langzaam naar elkaar toe laten bewegen.

@terborg werkt aan een artikel over verschillende manieren om paginering te doen.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's shared schemas and existing OpenAPI components, then read the pagination article being prepared by @terborg when available. Define the reusable YAML pagination components and confirm that they cover the agreed pagination patterns consistently across collection or query endpoints.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.