Protos

This repository contains protocol buffers definitions for fishjam-cloud organization repositories.

For detailed protobuf definitions and usage, please refer to the documentation.

How to add this repo as a git submodule in your own repository

Use the command below:

git submodule add https://github.com/fishjam-cloud/protos.git`

How to update docs

Install protoc-gen-doc plugin.

Use the command below:

find fishjam/ -name "*.proto" | sort | xargs protoc --doc_out=./doc --doc_opt=markdown,docs.md

or

find fishjam -name "*.proto" | sort | xargs docker run --rm -v $(pwd)/doc:/out -v $(pwd):/protos pseudomuto/protoc-gen-doc --doc_opt=markdown,docs.md

Lint and formatting

The files can be formatted using buf. Check out installation page for buf.

buf format -w

and linted

buf lint

Copyright and License

Copyright 2023, Software Mansion

Licensed under the Apache License, Version 2.0