/data-plane-api

[READ ONLY MIRROR] Envoy REST/proto API definitions and documentation.

Primary LanguagePythonApache License 2.0Apache-2.0

Data plane API

This tree hosts the configuration and APIs that drive Envoy. The APIs are also in some cases used by other proxy solutions that aim to interoperate with management systems and configuration generators that are built against this standard. Thus, we consider these a set of universal data plane APIs. See this blog post for more information on the universal data plane concept.

Generating haskell types and datastructures

The .proto files in the protos directory have been placed such that simply running the protoc compiler will generate the required code.

protoc --plugin=protoc-gen-haskell-protolens=<path to proto-lens-protoc>  --haskell-protolens_out=./<path to output folder> $(find protos -type f) --proto_path=./protos

Repository structure

The API tree can be found at two locations:

Further API reading