facebook / relay

Relay is a JavaScript framework for building data-driven React applications.
https://relay.dev
MIT License
18.28k stars 1.81k forks source link

Docs: Object Identification Spec Examples use non-global id values #3012

Open focusaurus opened 4 years ago

focusaurus commented 4 years ago

The Object Identification Spec docs describe id needing to be refetchable without additional type information and thus typical systems would need to encode some kind of type information into the id value itself. However, in the examples throughout the documentation, the id values used are simple small integers or stringified small integers. This has been causing us a lot of confusion as we are discussing our implementation. My proposed fix would be use realistic id values that encode the type information something like pseudo-code: base64("user:" + "4"). That way the doc examples would accurately reflect a compliant implementation and thus reduce confusion.

stale[bot] commented 3 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.