compose/pkg/api
Nicolas De Loof c86790ce58 docs(api): document the zero values, replica selection and the meaning of All
An options struct left at its zero value does not always behave like the
matching command run without flags, because the CLI fills in some defaults
before calling the API (Inherit is the sharpest case: its zero value is the
opposite of the CLI default). Index 0 and All also mean different things
depending on the operation.

Describe them in a package comment, and on the fields they concern. No code
change.

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2026-11-16 17:01:39 +01:00
..
api.go docs(api): document the zero values, replica selection and the meaning of All 2026-11-16 17:01:39 +01:00
api_test.go build(deps): adopt compose-go jobs and the container-spec layering 2026-09-21 16:35:20 +02:00
context.go Introduce abstractions to support SDK usage without requiring Docker CLI 2025-10-27 16:17:50 +01:00
doc.go docs(api): document the zero values, replica selection and the meaning of All 2026-11-16 17:01:39 +01:00
env.go restore support for COMPOSE_COMPATIBILITY 2025-12-07 18:42:04 +01:00
errors.go api: reject incompatible Up options with a typed error 2026-10-26 14:49:08 +01:00
errors_test.go deps: remove deprecated github.com/pkg/errors 2023-09-29 06:28:58 +02:00
event.go docs(api): state that EventProcessor.Done reports cancellation as failure 2026-11-16 14:34:24 +01:00
feature.go refactor(up): inject the navigation menu instead of importing cmd/formatter 2026-10-12 10:50:38 +02:00
labels.go docs(compose): state that a relay-only endpoint also needs an interface-pinned bind 2026-10-02 12:33:26 +02:00
labels_test.go golangci-lint: use gci formatter instead of goimports 2025-12-01 12:21:50 +01:00
up_options.go api: reject incompatible Up options with a typed error 2026-10-26 14:49:08 +01:00
up_options_test.go api: reject incompatible Up options with a typed error 2026-10-26 14:49:08 +01:00