README.md

HAProxy Data Plane API Specification

This is the OpenAPI 2.0 (fka Swagger) specification for the HAProxy Data Plane API project

Contributing

When contributing, change files located in paths/ and models/ directories and the haproxy-spec.yaml, and then build the resulting one-file spec build/haproxy_spec.yaml.

On linux, use the build binary:

cd build
./build -file ../haproxy-spec.yaml > haproxy_spec.yaml

On MacOS, you will need golang installed:

cd build
go run build.go -file ../haproxy-spec.yaml > haproxy_spec.yaml

For commit messages and general style please follow the haproxy project's CONTRIBUTING guide and use that where applicable.