Update and add details & examples in GraphQL API migration guides #2828
Conversation
meganelacheny
commented
Nov 19, 2025
meganelacheny
commented
- Update step by step guide
- Add new entry in migration FAQ
- Rename "flag" into "header" for more homogeneity throughout the docs
- Update "new response format" and "GraphQL API" breaking change pages
meganelacheny
added
pr: updated content
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
pwizla
left a comment
pwizla
left a comment
There was a problem hiding this comment.
Great job, Mégane!
I simply added a few inline comments, to ensure we restore some code comments that were deleted. I think these are useful to end users and we should preserve them for further explanations.
Apart from that, everything is perfect! #chefkiss
| } | ||
| } | ||
| } | ||
| images_connection { |
There was a problem hiding this comment.
Here I would preserve the inline comment that was deleted from line 190 😊 So we still have # collection fields can be renamed to _connection to get a v4-compatible response and then images_connection on the next line
| field | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Same comment as a few lines above, i think it's worth repeating the comment that was deleted (# collection fields can be renamed…) so if people skip parts of the code block, they will still get the info. Plus, it will be read by Kapa when clicking on the contextual Ask AI button, enhancing the context and providing even better explanations 🤓
| ``` | ||
| ```graphql | ||
| { | ||
| restaurants_connection { |
There was a problem hiding this comment.
Same here. I think you can repeat this at least once per code block, so that people know why we have suffixed collection fields names with _collection
| } | ||
| ``` | ||
| ```graphql | ||
| { |
There was a problem hiding this comment.
I believe we should also preserve the # Rename data to nodes & … comment, so the deleted line needs to be restored, now becoming:
- Line 273, only
{ - line 274 :
# Rename data to nodes…(use the comment in full, on one line - everything else is just pushed one line below, line 275 starting with
restaurants_connection {and so on
| ``` | ||
| ```graphql | ||
| { | ||
| restaurants { |
There was a problem hiding this comment.
Let's preserve the comment here as well 😊
2 participants
