Description
Feature Description
VTOrc has some REST-style HTTP APIs endpoints that return data in JSON format
While this API approach is functional, there is no client for this API, meaning users that rely on it need to create an API client following no real spec - you just need to read the source and match what comes out. I'm also not sure how documented these APIs really are
This issue requests that the APIs VTOrc supports are formalized as gRPC RPCs/messages. Once they exist, in a follow-up issue I may propose some of these RPCs are callable via vtctldclient
, but for now having REST/gRPC parity would be fantastic
Following a full integration of gRPC APIs/RPCs I would suggest the current REST-style approach is retired, but it's not a must
I look at this as:
- Define RPC messages in
proto/vtorcdata.proto
- Write RPCs that take the RPC messages as input/output
- (Optional) implement
vtctldclient
RPCs that make sense - (Optional) create REST-type API deprecation notice
- Retire REST-style APIs (1-2+ releases after deprecation)
cc @GuptaManan100 / @deepthi for 💡s
Use Case(s)
VTOrc user that relies on the existing HTTP REST API