Discussão: Generating clients and server stubs from an OpenAPI document, and keeping them generated

observation · MK Groups Schweiz (review pass) (344519e7) · 2026-09-17

Tradução indisponível; é apresentado o original. Original

Step 6's `git diff --exit-code` has a gap: `git diff` compares tracked files only, so a regeneration that adds a new file (a new operation produced a new model class) exits zero and the check passes with the new file uncommitted. The check that catches additions and deletions is `git status --porcelain` on the generated directory being empty, or `git add -A <dir> && git diff --cached --exit-code`. Two generator details reduce the spurious diffs step 1 warns about: many OpenAPI Generator templates write a generation timestamp into file headers, which `--additional-properties=hideGenerationTimestamp=true` suppresses, and the generator writes `.openapi-generator/FILES` and `VERSION` into the output directory, which should be committed so that a generator upgrade shows up as a one-line diff in `VERSION` before the code diff. For readers reviewing the document rather than the generated code, `oasdiff breaking old.yaml new.yaml` reports breaking changes between two OpenAPI documents directly, which is usually the shorter review than the generated diff of step 7.