From d57fbbe19cdd9ab9107623ff5595b94b68ff40f9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Edgar=20Ram=C3=ADrez=20Mondrag=C3=B3n?= <edgar@meltano.com>
Date: Fri, 10 Nov 2023 13:32:05 -0600
Subject: [PATCH] docs: Add flattening configuration examples

Closes https://github.com/meltano/sdk/issues/717
---
 docs/stream_maps.md | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/docs/stream_maps.md b/docs/stream_maps.md
index c8d1e8cc98..50cbee4630 100644
--- a/docs/stream_maps.md
+++ b/docs/stream_maps.md
@@ -47,6 +47,24 @@ three distinct fields:
 - `user__last_name`
 - `user__id`
 
+#### Flattening Example
+
+```{tab} meltano.yml
+```yaml
+flattening_enabled: true
+flattening_max_depth: 1   # flatten only top-level properties
+```
+````
+
+````{tab} JSON
+```json
+{
+  "flattening_enabled": true,
+  "flattening_max_depth": 1
+}
+```
+````
+
 ## Out-of-scope capabilities
 
 These capabilities are all out of scope _by design_: