Add GraphQL pagination to Decision Records

[t2gran]

Summary

Add a page for best practices for API Design and add a guideline for pagination to it.

Issue

This was discussed in the developer meeting on 19. Sep 2024

Unit tests

🟥 Not relevant

Documentation

✅ Add developer doc

Changelog

🟥 Not relevant

Bumping the serialization version id

🟥 Not relevant

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.90%. Comparing base (048a219) to head (f431d17).
Report is 580 commits behind head on dev-2.x.

Additional details and impacted files

@@              Coverage Diff              @@
##             dev-2.x    #6080      +/-   ##
=============================================
+ Coverage      69.78%   69.90%   +0.11%     
- Complexity     17357    17723     +366     
=============================================
  Files           1962     1998      +36     
  Lines          74359    75443    +1084     
  Branches        7624     7718      +94     
=============================================
+ Hits           51894    52741     +847     
- Misses         19821    20025     +204     
- Partials        2644     2677      +33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[leonardehrenfried]

A few typos

[optionsome]

I think there is some confusion here. The discussion we had yesterday related to #6045 . We debated if the leg should implement node interface (https://relay.dev/graphql/objectidentification.htm) and be refetchable through the node query. It's not really related to pagination. In the relay connection specification, there is a field called node, but it doesn't need to return a type that implements the node interface.

We have already added a planConnection query to the GTFS GraphQL API which implements the relay connection pagination. I think the persistence of the objects is not as important with pagination as it's not really used for refetching objects in the future but rather to search for more results with a cursor.

[t2gran]

@optionsome Sorry for mixing relay/node/connection/pagination - would you be intrested in taking this over. I can move the branch to the main repo so you can edit it? (I will in that case close this PR, and open a new one.)

[optionsome]

@optionsome Sorry for mixing relay/node/connection/pagination - would you be intrested in taking this over. I can move the branch to the main repo so you can edit it? (I will in that case close this PR, and open a new one.)

Yes, I can help you with this.

[t2gran]

This is replaced by #6193