Skip to content

Kschappacher/api

This branch is 46 commits behind viamrobotics/api:main.

Folders and files

NameName
Last commit message
Last commit date
Sep 5, 2024
Nov 1, 2024
May 14, 2024
Nov 1, 2024
Aug 15, 2022
Nov 8, 2022
Nov 1, 2024
Mar 22, 2024
Nov 1, 2024
Feb 6, 2024
Oct 11, 2024
Nov 1, 2024
Oct 28, 2024
Nov 10, 2023
Mar 25, 2022
Aug 12, 2022
Mar 25, 2022
Sep 14, 2022
Jun 5, 2023
Apr 17, 2024
Sep 12, 2022
Apr 13, 2022
Sep 5, 2024
Oct 27, 2023
Sep 16, 2022
Sep 16, 2022

Repository files navigation

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

Please only edit .proto files. The generated interfaces build in CI.

To build protos for a PR:

  • add the ready-for-protos label
  • adding the label will compile your protos, and commit the compiled changes to your PR branch from the github-actions bot
    • the bot commit will also add a protos-compiled label which is checked to merge. subsequent manual commits remove this label
  • when you're ready to merge, remove the ready-for-protos label; that will trigger lint and merge checks
  • in order to merge, the last commit to your PR must be a bot commit. (this is enforced through labeling)

Other guidelines:

  • 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

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.9%
  • Other 0.1%