[RFC] REST API output on Hasura v3 #10475
Conversation
|
|
||
| Hasura will also generate an OpenAPI schema for complex filtering on nested types. As a result, any | ||
| auto-generated client would get full auto-complete and type-checking on any nested filtering | ||
| clauses. Check out <https://github.com/hasura/json-api-experiments> to see this in action. |
There was a problem hiding this comment.
I must have missed that we're able to get this working in a well-typed fashion. Nice!
|
|
||
| # OpenDD config | ||
|
|
||
| For the first iteration, to keep things simple, we are not introducing any OpenDD configuration. Any |
There was a problem hiding this comment.
I like this because we're keeping scope slim, but I am concerned about breakages - ie, if by default we expose all models as a JSON:API endpoint, and then we later make each model opt-in, does that constitute a breaking change?
Do we solve this by only offering this feature on a strictly "this is experimental" basis?
There was a problem hiding this comment.
That's a good point. It will be a breaking change, and I guess we would have to incorporate this via Compatibility Date. But let me see if we can do anything better here.
There was a problem hiding this comment.
Oh of course. If we just say "everything before this date gets all models, everything after gets specific ones", we're fine.
There was a problem hiding this comment.
Yeah, I'm thinking we can introduce a date after which it is still all models but user gets a warning. And after a second date, we switch to specific ones. Does this make sense?
There was a problem hiding this comment.
Yes this works, thanks!
Co-authored-by: Daniel Harvey <danieljamesharvey@gmail.com>
Description
This is our new proposal of auto-generating REST API output in Hasura v3.
Rendered