facebook / facebook/relay

PaginationContainer inconsistent with connections spec

Open
#2,457 11 comments 2 reactions 0 assignees View on GitHub
wontfix
Dominant language
Rust
Stars
19k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

I recently added the PageInfo and Edge Type interfaces to my GraphQL schema in support of a relay PaginationContainer and noticed an inconsistency with the [connection spec](https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo). Relay requires both `startCursor` and `endCursor` fields in PageInfo, which are not mentioned in the spec. It also appears not to use the `cursor` field on Edge Types which is required by the spec (not needing this field actually simplifies things in my case, as my backing datastore has no native concept of a per-item cursor/token).

Should the spec be updated to reflect the type of connection Relay expects?

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked connection spec and comparing its PageInfo and Edge Type requirements with the behavior expected by Relay's PaginationContainer. The issue mentions no files or tests; done would require a decided resolution for the mismatch and a corresponding specification change if one is agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
graphql, javascript
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.