HAProxy Data Plane API
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

1.3 KiB

HAProxy

Contributing guide

This document is a short guide for contributing to this project.

API Specification - Development guide

Data Plane API is generated using go-swagger from the swagger spec found here using the following command.

make generate

or if you prefer to run it directly (not in docker)

make generate-native

make generate-native must also be used if you are using local client-native on disk (you have replace github.com/haproxytech/client-native/v6 => ../client-native in go.mod file)

This command generates some of the files in this project, which are marked with // Code generated by go-swagger; DO NOT EDIT. comments at the top of the files. These are not to be edited, as they are overwritten when specification is changed and the above-mentioned command is run. If you want to change those files, please change the specification where necessary and then generate them again.

Commit Messages and General Style

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