protos

This repo contains the common protobuf definitions for all of the streamdal components.

Release

1. git clone [email protected]:streamdal/mono
2. cd mono/libs/protos
3. git checkout -b your-branch
4. Make your changes (such as updating or adding .proto files)
5. make setup
6. make generate
7. git add . && git commit -m "your message" && git push origin head

Release Tags

streamdal/mono/libs/protos uses libs/protos/vX.Y.Z format tags.

This is done primarily for Go, as it has a very specific way it handles modules that exist in subdirs.

Usage

To fetch this module, you will have to use the following cmd:

go get github.com/streamdal/mono/libs/[email protected]

To use the protos pkg in your code, the import will look like this:

import "github.com/streamdal/mono/libs/protos/build/go/protos"

gRPC API

The protos expose two gRPC APIs: external_api.proto and internal_api.proto.

Both APIs are implemented by streamdal/server.

• external is intended to be used by non-SDK clients (such as the UI).
• internal is intended to be used by SDK clients.

Auth

All gRPC methods require you to insert an authorization k/v into the request context/metadata.

Request/Response ID

All gRPC requests allow you to insert your own request-id into the context/metadata. This request-id can be used to correlate requests, responses, logs, etc. If a request-id is not specified, streamdal/server will generate one automatically.