docs: clarify Resource Route error patterns #14518
Conversation
…idelines for internal and external access methods.
|
docs/how-to/resource-routes.md
Outdated
| { status: 404 }, | ||
| ); | ||
| } | ||
| While we don't recommend it, you _can_ return plain JS objects from a resource route and they will be converted into an appropriate `Response` based on to the HTTP Request (a single-fetch response for `.data` requests or a JSON response for other external HTTP requests). We don't prefer this pattern because `new Response()`/`data()` calls keep the code explicit for API-only/non-UI routes. |
There was a problem hiding this comment.
This has enough "don't do this" language that I almost wonder if it's worth just removing/not mentioning. If you feel it needs to be explained though, that's fine. I think I would just flip it around a little:
It is recommended that you return `new Response()`/`data()` calls from resource routes keep the code explicit for API-only/non-UI routes. While you _can_ return a plain JS objects from a resource route, they will be converted into different a `Response` based on to the HTTP Request (a single-fetch response for `.data` requests or a JSON response for other external HTTP requests).
There was a problem hiding this comment.
yeah I went back and forth on that too - let's just remove it
Fixes #12888
I took a stab at letting AI summarize @brophdawg11 comment (#12888 (comment)) and then updating the Resource Route doc
I've given it a review and I think this improves the existing doc. Please share if you feel any other docs need to be updated from the original conversation in the issue or if you think the update is still unclear/missing anything