api

package module
v0.1.223 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 3, 2023 License: Apache-2.0 Imports: 0 Imported by: 0

README

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/api@v0.1.180 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

Documentation

Overview

Package api TODO

Directories

Path Synopsis
app
cloudslam/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
data/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
dataset/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
datasync/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
mltraining/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
model/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
packages/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
common
v1
component
arm/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
audioinput/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
base/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
board/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
camera/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
encoder/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
gantry/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
generic/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
gripper/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
inputcontroller/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
motor/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
movementsensor/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
posetracker/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
powersensor
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
powersensor/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
sensor/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
servo/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
testecho/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
module
v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
robot
v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
service
datamanager/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
mlmodel/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
motion/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
navigation/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
sensors/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
shell/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
slam/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
vision/v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
stream
v1
Package v1 is a reverse proxy.
Package v1 is a reverse proxy.
tagger
v1

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL