Skip to content

Commit f84d45e

Browse files
committed
docs(jmespath-functions): extract inline code examples into snippet files
Extract 4 inline C# code blocks from docs/utilities/jmespath-functions.md into standalone snippet files under docs/snippets/jmespath/ using pymdownx.snippets includes. No visual changes to rendered documentation. Closes #1183 Refs #794, #1104
1 parent fe0e0db commit f84d45e

2 files changed

Lines changed: 37 additions & 17 deletions

File tree

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
// This file is referenced by docs/utilities/jmespath-functions.md
2+
// via pymdownx.snippets (mkdocs).
3+
4+
namespace AWS.Lambda.Powertools.Docs.Snippets.JmespathFunctions;
5+
6+
// --8<-- [start:transform_json]
7+
var transformer = JsonTransformer.Parse("powertools_json(body).customerId");
8+
using var result = transformer.Transform(doc.RootElement);
9+
10+
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
11+
// --8<-- [end:transform_json]
12+
13+
// --8<-- [start:idempotency_event_key_jmespath]
14+
Idempotency.Configure(builder =>
15+
builder
16+
.WithOptions(optionsBuilder =>
17+
optionsBuilder.WithEventKeyJmesPath("powertools_json(Body).[\"user_id\", \"product_id\"]"))
18+
.UseDynamoDb("idempotency_table"));
19+
// --8<-- [end:idempotency_event_key_jmespath]
20+
21+
// --8<-- [start:powertools_base64]
22+
var transformer = JsonTransformer.Parse("powertools_base64(body).customerId");
23+
using var result = transformer.Transform(doc.RootElement);
24+
25+
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
26+
// --8<-- [end:powertools_base64]
27+
28+
// --8<-- [start:powertools_base64_gzip]
29+
var transformer = JsonTransformer.Parse("powertools_base64_gzip(body).customerId");
30+
using var result = transformer.Transform(doc.RootElement);
31+
32+
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
33+
// --8<-- [end:powertools_base64_gzip]

docs/utilities/jmespath-functions.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,7 @@ You can use the `JsonTransformer.Transform` function with any [JMESPath expressi
3535

3636
=== "Transform"
3737
```csharp hl_lines="1 2"
38-
var transformer = JsonTransformer.Parse("powertools_json(body).customerId");
39-
using var result = transformer.Transform(doc.RootElement);
40-
41-
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
38+
--8<-- "docs/snippets/jmespath/ExtractingData.cs:transform_json"
4239
```
4340

4441
=== "Payload"
@@ -90,11 +87,7 @@ This sample will deserialize the JSON string within the `body` key before [Idemp
9087
=== "Idempotency utility: WithEventKeyJmesPath"
9188

9289
```csharp hl_lines="4"
93-
Idempotency.Configure(builder =>
94-
builder
95-
.WithOptions(optionsBuilder =>
96-
optionsBuilder.WithEventKeyJmesPath("powertools_json(Body).[\"user_id\", \"product_id\"]"))
97-
.UseDynamoDb("idempotency_table"));
90+
--8<-- "docs/snippets/jmespath/ExtractingData.cs:idempotency_event_key_jmespath"
9891
```
9992

10093
=== "Payload"
@@ -141,10 +134,7 @@ This sample will decode the base64 value within the `data` key, and deserialize
141134
=== "Function"
142135

143136
```csharp
144-
var transformer = JsonTransformer.Parse("powertools_base64(body).customerId");
145-
using var result = transformer.Transform(doc.RootElement);
146-
147-
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
137+
--8<-- "docs/snippets/jmespath/ExtractingData.cs:powertools_base64"
148138
```
149139

150140
=== "Payload"
@@ -173,10 +163,7 @@ This sample will decompress and decode base64 data from Cloudwatch Logs, then us
173163
=== "Function"
174164

175165
```csharp
176-
var transformer = JsonTransformer.Parse("powertools_base64_gzip(body).customerId");
177-
using var result = transformer.Transform(doc.RootElement);
178-
179-
Logger.LogInformation(result.RootElement.GetRawText()); // "dd4649e6-2484-4993-acb8-0f9123103394"
166+
--8<-- "docs/snippets/jmespath/ExtractingData.cs:powertools_base64_gzip"
180167
```
181168

182169
=== "Payload"

0 commit comments

Comments
 (0)