Files
clean-architecture-backend-…/docs/adr/ADR-WEB-ADV-003-openapi-32-remains-experimental.md
T
DongHyeonkaandClaude Opus 5.5 6d27356e2b refactor: 부가 기능을 capability 모듈로 포장하고 기본 조립을 web-only로 전환
설계: docs/superpowers/specs/2026-09-25-capability-module-packaging-design.md
계획/진행 기록: docs/superpowers/plans/2026-09-25-capability-module-packaging.md

- Wave 0: 규칙 고정(AGENTS.md capability 완료 기준·테스트 규칙) + 차단 결함 7건
  (compose overlay 검사, redis-sdk CI job, 적용된 V9/V13 원복 + V16, @EnableScheduling,
  messaging bridge 순서, prod 에러 상세 validator, sample loggers read-only)
- Wave 1: 데이터·보안 Critical 10건 (durable operation 25P02, operation 유스케이스 이동,
  outbox 재인코딩, Kafka TLS/SASL, 알림 트랜잭션, SNS 서명, tus checksum, GraphQL fragment,
  Redis lane, gRPC FAILED_TERMINAL)
- Wave 2: 리팩터링 잔재·실험용 자리 삭제, outbox v1 fencing(V17), 멱등성 V2 정본화
- Wave 3: 라이브러리형 코드 정리(동작하지 않는 설정·인터페이스·gate 제거, web-advanced 분리)
- Wave 4: capability 11개를 "있으면 켜짐" 모듈로 포장, 끄는 장치 제거, 기본 조립 web-only,
  qualificationBootJar 분리
- Wave 5: 빌드 로직 축소(17.2k -> 10.8k줄), sample 테스트 컨벤션 적용

삭제한 코드는 docs/capability-status.md "제거된 코드" 표에 복구 커밋(208077fd)과 함께 기록.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
2026-09-25 12:49:07 +09:00

3.1 KiB

ADR-WEB-ADV-003: OpenAPI 3.2 is generated in parallel and stays experimental

  • Status: Accepted
  • Date: 2026-08-25
  • Scope: adapter:inbound:web — advanced.openapi

Context

Advanced Task 17 adds an OpenAPI 3.2 generation lane beside the Stable 3.1.2 snapshot.

Generating 3.2 is cheap. Adopting it is not, and the two get conflated because the generated document looks fine. The value of an API description is entirely in what consumes it, and a document in a version a client generator does not fully understand produces a client that compiles and is wrong — which is worse than no document at all.

Decision

3.1.2 remains the release artifact. OpenApiVersionLane.STABLE_3_1.releaseArtifact() is true and EXPERIMENTAL_3_2's is false. This is a property of the type, not a configuration setting.

Generating 3.2 must not change the 3.1 snapshot. Both are produced from the same model, so a contributor that mutates it on the way to 3.2 changes the artifact that is actually shipped — silently, and only when the experimental lane runs. OpenApi32CompatibilityReport compares the snapshot hash before and after and makes a difference a promotion blocker.

2026-09-25: OpenApi32CompatibilityReport and OpenApiToolchainMatrix were removed — promotion checks kept in production code, called only by their own tests. WebOpenApi32Generator remains as library code in adapter:inbound:web-advanced; the decision below is unchanged.

Four kinds of tool are checked separately. A parser reports structural errors; a linter applies style rules and accepts documents a parser rejects; a generator produces client code, and this is where an unsupported construct surfaces — not as an error but as a method with the wrong signature; a compile of that generated code is the only step that catches it. "OpenAPI 3.2 works" is not a statement anybody can make. "This document is read correctly by these four tools at these versions" is.

Promotion requires an accepted ADR regardless of how green the matrix is. promotionBlockers(false) always contains that blocker. A machine-checkable matrix cannot decide whether the consumer population is ready.

Streaming description differences are reported separately. They are the substantive difference between the two versions for this application, and folding them into a pass/fail hides what changed.

Consequences

  • The 3.2 document is published as an artifact of the experimental workflow, never of the release workflow.
  • A client generator that only understands 3.1 is unaffected, which is the point.
  • Adopting 3.2 later is a documented decision with a named consumer matrix behind it.

Alternatives considered

  • Switch to 3.2 and keep a 3.1 downgrade. Rejected: the downgrade is lossy in exactly the constructs 3.2 was wanted for, so it would ship a description that is wrong for both audiences.
  • Generate only 3.2 and let consumers cope. Rejected: the failure mode is a generated client that compiles and misbehaves.
  • Skip the client-compile step in the matrix. Rejected: it is the only one that catches the failure the others miss.