API

Protobuf definitions for Viam's public-facing API.

Contributing

Development

make setup - Setup your development environment
make all - Clean and build the Go and web generated libraries
make dist/buf - Build the Go and web generated libraries without cleaning
make clean - Clean tool cache

Submitting PRs for Protobuf Changes

Only submit PRs with changes to .proto files, CI will handle generating other files.
- Upon (first) approval of the PR, file generation will happen.
- Wait for it to complete (it will add a protos-compiled label and new files to the PR) before merging.
- Do not make further changes after this point.
- If stuck waiting for merge checks after protos-compiled is added, try adding an unrelated label (ex: enhancement) to trigger it again.
Do not make breaking changes to APIs if it can be avoided.
Always use semantic version tags (not hashes) when importing this into other projects, such as RDK.
- For example, use go get go.viam.com/[email protected] NOT go get go.viam.com/api@037415e
- Add a new (semantic version compatible) tag when needed for this.
- Do NOT duplicate, move, or remove version tags.

License

Copyright 2023 Viam Inc.

Apache 2.0 - See LICENSE file