Skip to content

Commit c2ca59a

Browse files
committed
Document response_model must match response_builder in app developer guide
1 parent 9f9f6be commit c2ca59a

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

docs/development/app-developer-guide.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -992,6 +992,11 @@ app = TaskExecutionApp(
992992
)
993993
```
994994

995+
When you supply an explicit `response_builder`, set `response_model` to the same
996+
class the builder's return annotation declares. The derived list route serializes
997+
the builder's model, and every other `response_model` reader — including the
998+
`list_view` column gate — measures that field; construction rejects a mismatch.
999+
9951000
`TaskExecutionApp` also exposes `update_handler` / `delete_handler`
9961001
(`app/sep/apps/framework/apps.py`) for fully replacing a mutation handler — no app
9971002
in the tree overrides those today; prefer the lighter response-builder override

0 commit comments

Comments
 (0)