Use grpc-gateway to create restful services.

* Add grpc-gateway annotations to the services and include them
  in the buf file

* We will use grpc-gateway to create restful services accessible
  form the vscode extension so that we don't have to rely on grpc-web

protos/README.md

@@ -0,0 +1,21 @@
+# Protocol buffers
+
+We use protocol buffers as a way of defining APIs and data resources.
+
+## Developer Guide
+
+Language bindings are generated using [buf](https://buf.build/docs/introduction)
+
+```
+buf generate
+```
+
+In the past we've run into issues generating grpc bindings for python; 
+see [bufbuild/buf#1344](https://github.com/bufbuild/buf/issues/1344). As of right
+now we aren't using grpc in python so hopefully we don't need to worry about this and
+if we do hopefully the issue has been resolved by now.
+
+
+## GRPC-Gateway
+
+We [grpc-gateway](https://grpc-ecosystem.github.io/grpc-gateway/) to generate RESTful services from our grpc services.

protos/buf.gen.yaml

@@ -9,6 +9,10 @@ plugins:
       # then its pased on the path relative to the location of the buf.yaml file.
       - paths=source_relative
   - name: go-grpc
+    out: go/
+    opt:
+      - paths=source_relative
+  - plugin: grpc-gateway
     out: go/
     opt:
       - paths=source_relative

protos/buf.lock

@@ -0,0 +1,8 @@
+# Generated by buf. DO NOT EDIT.
+version: v1
+deps:
+  - remote: buf.build
+    owner: googleapis
+    repository: googleapis
+    commit: 7a6bc1e3207144b38e9066861e1de0ff
+    digest: shake256:d646836485c34192401253703c4e7ce899c826fceec060bf4b2a62c4749bd9976dc960833e134a1f814725e1ffd60b1bb3cf0335a7e99ef0e8cec34b070ffb66

protos/buf.yaml

@@ -5,3 +5,5 @@ breaking:
 lint:
   use:
     - DEFAULT
+deps:
+  - buf.build/googleapis/googleapis

protos/foyle/v1alpha1/agent.proto

@@ -5,6 +5,10 @@ import "foyle/v1alpha1/doc.proto";
 
 option go_package = "github.com/jlewi/foyle/protos/go/v1alpha1";
 
+// grpc-gateway
+// https://github.com/grpc-ecosystem/grpc-gateway
+import "google/api/annotations.proto";
+
 message GenerateRequest {
   Doc doc = 1;
 }
@@ -16,7 +20,11 @@ message GenerateResponse {
 // Generate completions using AI
 service GenerateService {
   // Generate generates new cells given an existing document.
-  rpc Generate (GenerateRequest) returns (GenerateResponse) {}
+  rpc Generate (GenerateRequest) returns (GenerateResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha1/generate"
+    };
+  }
 }
 
 message ExecuteRequest {
@@ -30,5 +38,9 @@ message ExecuteResponse {
 // Execute code and commands
 service ExecuteService {
   // Execute executes a cell in an existing document.
-  rpc Execute(ExecuteRequest) returns (ExecuteResponse) {}
+  rpc Execute(ExecuteRequest) returns (ExecuteResponse) {
+    option (google.api.http) = {
+      post: "/v1alpha1/execute"
+    };
+  }
 }