Api.proto - versioning & single source of truth

Moved from GitHub dgo/16

Posted by rdewaele:


I hope this is the correct channel to post my question. If it is not, I apologise and kindly request redirection to the appropriate location. Thanks! On to the actual question:

I have a basic (functional) custom C++ gRPC client for Dgraph, based on the protos/api.proto file in this repository, as it is linked by the Dgraph client documentation.

Given that a number of different official clients exist, and that Dgraph itself has a number of releases (branches, tags, archives), but this client does not, I wonder about gRPC compatibility.

In other words, does this repository host the ultimate “correct” version of the api.proto file, and how should we proceed to maintain compatibility with Dgraph current and future releases?


srfrog commented :

Yes, this has the final API definition. The server code uses this proto so they must be kept in sync.
I would suggest you base your client from the api.proto in here.

Please post these questions in the forum, so others can benefit - https://discuss.dgraph.io