Skip to content

Commit

Permalink
Update parser.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ran-isenberg authored and rubenfonseca committed Aug 16, 2022
1 parent f741299 commit a0ef46d
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/utilities/parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: Parser
description: Utility
---
<!-- markdownlint-disable MD043 -->

This utility provides data parsing and deep validation using [Pydantic](https://pydantic-docs.helpmanual.io/).

Expand Down Expand Up @@ -166,6 +167,7 @@ Parser comes with the following built-in models:
| **SnsModel** | Lambda Event Source payload for Amazon Simple Notification Service |
| **APIGatewayProxyEventModel** | Lambda Event Source payload for Amazon API Gateway |
| **APIGatewayProxyEventV2Model** | Lambda Event Source payload for Amazon API Gateway v2 payload |
| **LambdaFunctionUrlModel** | Lambda Event Source payload for Lambda function URL payload |

### extending built-in models

Expand Down Expand Up @@ -305,6 +307,7 @@ Parser comes with the following built-in envelopes, where `Model` in the return
| **SnsSqsEnvelope** | 1. Parses data using `SqsModel`. <br/> 2. Parses SNS records in `body` key using `SnsNotificationModel`. <br/> 3. Parses data in `Message` key using your model and return them in a list. | `List[Model]` |
| **ApiGatewayEnvelope** | 1. Parses data using `APIGatewayProxyEventModel`. <br/> 2. Parses `body` key using your model and returns it. | `Model` |
| **ApiGatewayV2Envelope** | 1. Parses data using `APIGatewayProxyEventV2Model`. <br/> 2. Parses `body` key using your model and returns it. | `Model` |
| **LambdaFunctionUrlEnvelope** | 1. Parses data using `LambdaFunctionUrlModel`. <br/> 2. Parses `body` key using your model and returns it. | `Model` |

### Bringing your own envelope

Expand Down

0 comments on commit a0ef46d

Please sign in to comment.