alphauslabs/blueapi

Protobuf definitions for Alphaus Blue API.

blueapi is the protobuf definition of Alphaus Blue API.

The folder google/* was cloned from github.com/googleapis/api-common-protos. The folder protoc-gen-openapiv2/* was cloned from github.com/grpc-ecosystem/grpc-gateway/protoc-gen-openapiv2.

You need to install the following tools to build locally:

• The protoc compiler
• The following compiler plugins:

$ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
$ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
$ go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
$ go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
$ go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest

• The buf tool

This repo depends on protos as a submodule. To update locally, you need to:

# First time cloning the repo:
$ git submodule update --init --recursive

# Otherwise:
$ git submodule update --remote --merge

Then run:

$ ./build.sh

Generated SDKs from updates to this repository:

• blue-sdk-go
• blue-sdk-python

The generated OpenAPI documentation can be found here.