Files
clean-architecture-backend-…/docs/web/patch-contract.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.6 KiB

Web patch: the client contract

Two patch formats, and they are not interchangeable. Both appliers are library code in adapter:inbound:web-advanced (opt-in): a service adds the leaf and calls JsonMergePatchApplier or JsonPatchApplier from its controller.

Choosing one

A route accepts exactly one, and sending the other is a 415 rather than a best-effort guess. The reason is that a mismatch is silent in the worst direction:

  • {"a": null} as a merge patch deletes a. As a JSON Patch it is not a patch at all — it is an object where an array was required.
  • A JSON Patch array read as a merge patch is a document whose fields are array indices. It merges nothing and reports success.
Merge patch JSON Patch
Media type application/merge-patch+json application/json-patch+json
RFC 7396 6902
Shape A partial document An ordered array of operations
Delete "field": null {"op":"remove","path":"/field"}
Arrays Replaced whole Addressable per index
Preconditions If-Match only If-Match, plus per-field test

Use merge patch for "change these fields". Use JSON Patch when you need array element edits or a precondition on one field that If-Match cannot express.

What is refused

Fields outside the allowlist. The server declares which fields a merge patch may modify and which pointers a JSON Patch may address. Anything else is refused, and every refused path is named — you will not discover them one round trip at a time.

The allowlist is checked before anything is applied. A refusal tells you nothing about the current values, which is deliberate: deciding afterwards whether a refused field "actually changed anything" would answer a question about data you may not read.

Pointer permission does not travel upwards. Permission on /profile covers /profile/displayName; permission on /profile/displayName does not cover /profile, because replacing the parent deletes every sibling.

A move needs permission on both ends. Checking only the destination would let you relocate data out of a field you may not touch.

Limits. At most 100 operations, pointer depth at most 16, merge-patch nesting depth at most 32. The first two multiply — each operation walks its pointer over a document the server deep-copied first.

Atomicity

A JSON Patch document applies entirely or not at all. Every operation runs against a working copy; the resource is not touched until all of them have succeeded and the result has passed full validation.

This is what makes test useful. A client putting a test first is relying on nothing after it having happened when the test fails, and that reliance holds:

[
  {"op": "test",    "path": "/version",     "value": 4},
  {"op": "replace", "path": "/displayName", "value": "new"}
]

A failed test is 409, not 400: the document was well-formed and permitted, and the resource simply was not in the state you expected. Re-read and retry. The response names the pointer that failed and does not return the server's value — returning it would make test a read primitive for fields you may not read.

Validation

The patched result is validated as a whole document, not field by field. A patch whose individual fields are all valid can produce an object that is not — two fields that must agree, a state transition that is not allowed — and validating only what changed sees none of it.

Preconditions

Patch routes require If-Match. A partial update against a resource that moved underneath you applies your changes to a version you never saw.