This document is a short guide for contributing to this project.
Generation happens in two steps. Both run in CI (the diff job), so run both locally and commit the result whenever the specification changes:
make specification
make generate-native
make specification is the main step: it installs the pinned oapi-codegen into bin/ and runs cmd/generate/specification, which combines the OpenAPI 3 spec files under specification/ and regenerates the chi-based server code.
make generate-native regenerates only embedded_spec.go from the go-swagger spec in client-native. It needs the swagger binary on your PATH; make generate does the same inside Docker if you don't want to install it. Use make generate-native (not the Docker variant) when working against a local client-native checkout (a replace github.com/haproxytech/client-native/v6 => ../client-native directive in go.mod).
Generated files are marked with a // Code generated ... DO NOT EDIT. header and must not be edited by hand — change the specification and regenerate instead.
Some resources live under multiple parent types (e.g. acl belongs to backends, frontends, defaults, ...). Their parent expansion is handled as part of make specification: cmd/generate/specification template-expands each child's spec using the parent definitions in cmd/generate/parents/parents.go.
To add or change the parents of a child resource, update the relevant case in cmd/generate/parents/parents.go and re-run make specification. There is no separate generation step or CI job for parents — it is covered by the single make specification run.
For commit messages and general style please follow the haproxy project's CONTRIBUTING guide and use that where applicable.