api/

directory
v2.0.0-beta5+incompatible Latest Latest
Warning

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

Go to latest
Published: Jul 30, 2019 License: AGPL-3.0

README

pmm-api

Build Status

PMM 2.x APIs.

All generated files (Go code, Swagger spec, documentation) are already stored in this repository.

Browsing documentation

  1. Generate TLS certificate for nginx for local testing (once):
brew install mkcert
mkcert -install
make cert
  1. Serve API documentation with nginx:
make serve

Updating APIs

  1. Edit .proto files. Do not edit Swagger, .pb.go, .pb.gw.go. You can use make clean to remove all generated files.

  2. Install prototool and fill vendor/ (once):

make init
  1. Generate files:
make gen

Directories

Path Synopsis
Package agentlocalpb is a reverse proxy.
Package agentlocalpb is a reverse proxy.
Package inventorypb is a reverse proxy.
Package inventorypb is a reverse proxy.
Package managementpb is a reverse proxy.
Package managementpb is a reverse proxy.
Package qanpb is a reverse proxy.
Package qanpb is a reverse proxy.
Package serverpb is a reverse proxy.
Package serverpb is a reverse proxy.

Jump to

Keyboard shortcuts

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