docs: Documented how context fields are passed to a child stream

meltano · May 17, 2024 · 6a54e36 · 6a54e36
1 parent b8219d0
commit 6a54e36
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/parent_streams.md b/docs/parent_streams.md
@@ -69,6 +69,10 @@ class EpicIssuesStream(GitlabStream):
     # ...
 ```
 
+```{note}
+All the keys in the `context` dictionary are added to the child's record, but they will be automatically removed if they are not present in the child's schema. If you wish to preserve these keys in the child's record, you must add them to the child's schema.
+```
+
 ## Additional Parent-Child References
 
 - [Singer State in SDK Taps](./implementation/state.md)