Skip to content

Commit

Permalink
Merge pull request #366 from carlosms/i-339-docs
Browse files Browse the repository at this point in the history
Add docs for bblfsh proxy
  • Loading branch information
smacker authored Nov 23, 2018
2 parents 650fcdd + 9d424c8 commit 1f6ce46
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ An analyzer is a [gRPC](https://grpc.io/) server that implements the [Analyzer s

At the same time, an analyzer acts as a gRPC client to access the [Data Server](https://github.com/src-d/lookout-sdk/blob/master/proto/service_data.proto) exposed by the lookout server. This endpoint will provide the necessary source code and [Babelfish Universal Abstract Syntax Trees (UAST)](https://doc.bblf.sh/uast/uast-specification.html). See `LOOKOUT_DATA_SERVER` environment variable below for more details.

If your analyzer needs to access the Babelfish API you can point your [Babelfish client](https://docs.sourced.tech/babelfish/using-babelfish/clients) to the same Data Server address (defined by `LOOKOUT_DATA_SERVER`). The lookout server will proxy these gRPC requests to Babelfish.

All the needed `.proto` files are located in the [/sdk directory](https://github.com/src-d/lookout-sdk/tree/master/proto).

## Code generation
Expand Down

0 comments on commit 1f6ce46

Please sign in to comment.