Skip to content

packetbroker/go-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Packet Broker API for Go

go-api is the Packet Broker API for Go.

Installing

Use go get to retrieve the Go API.

$ go get go.packetbroker.org/api/v3
$ go get go.packetbroker.org/api/routing/v1
$ go get go.packetbroker.org/api/mapping/v2
$ go get go.packetbroker.org/api/iam
$ go get go.packetbroker.org/api/iam/v2

Regenerating

The generated protos are checked in to this repository. You only need to regenerate the protos to incorporate changes coming from upstream.

To generate protos, install the Protocol Compiler.

Before generating protos, get the dependencies:

$ make deps

Clean existing generated protos:

$ make clean

To generate protos, clone the Packet Broker API repository.

If you clone the API repository in ../../packetbroker/api relative to the path of this repository:

$ make

If you clone the API repository somewhere else, pass the import path where the packetbroker/api folder resides like this:

$ PBAPI=<path> make

License

The Go API is distributed under Apache License, Version 2.0. See LICENSE for more information.