Skip to content

Commit a394527

Browse files
committed
Update code generatino ADR
1 parent cf711a2 commit a394527

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

docs/adrs/003-code-generation.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,10 @@ For the **foundation models** we choose alternative **2**, generating about 80-9
7676
- We improve API quality on a best effort basis.
7777
- We test most (75% or more) of the functionality
7878

79-
For the **orchestration service** we choose alternative **2**
80-
- We generate all DTO classes
81-
- We test most (85% or more) of the functionality
79+
For the **orchestration service** we choose a mix of alternatives **2** and **3**.
80+
The main reason is that the desired API quality and stability can not be achieved with generated code alone.
81+
- We generate all DTO classes but mark them as beta and leave them in a dedicated `.dto` package.
82+
- We offer a hand-crafted convenience API on top that uses the DTO objects internally.
83+
- The convenience API is considered stable and is tested in full
84+
- The convenience API has the best API quality, but may not cover all edge cases and not allow for arbitrary customization
85+
- Users may transition to the low-level API, directly working with the DTOs, if the convenience API isn't flexible enough for their use case

0 commit comments

Comments
 (0)