-
Notifications
You must be signed in to change notification settings - Fork 432
docs(parser): add JSON string field extension example #1526
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
8b59bdb
docs(parser): add JSON string field extension example
rubenfonseca e6fbae8
fix(docs): extracted examples
rubenfonseca ec6a6f8
chore: ignore assignment error only in mypy
heitorlessa 8906200
chore: ignore assignment error only in mypy
heitorlessa 120a33e
chore: ignore assignment error only in mypy
heitorlessa File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -171,7 +171,7 @@ Parser comes with the following built-in models: | |
| **KafkaSelfManagedEventModel** | Lambda Event Source payload for self managed Kafka payload | | ||
| **KafkaMskEventModel** | Lambda Event Source payload for AWS MSK payload | | ||
|
||
### extending built-in models | ||
### Extending built-in models | ||
|
||
You can extend them to include your own models, and yet have all other known fields parsed along the way. | ||
|
||
|
@@ -236,6 +236,19 @@ for order_item in ret.detail.items: | |
3. Defined how part of our EventBridge event should look like by overriding `detail` key within our `OrderEventModel` | ||
4. Parser parsed the original event against `OrderEventModel` | ||
|
||
???+ tip | ||
When extending a `string` field containing JSON, you need to wrap the field | ||
with [Pydantic's Json Type](https://pydantic-docs.helpmanual.io/usage/types/#json-type): | ||
|
||
```python | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could you create as a snippet file so it runs as-is? I'd like to prevent us from getting into where we were before with typos, and customers copying/pasting code that doesn't run |
||
from pydantic import Json | ||
|
||
... | ||
|
||
class OrderEventModel(APIGatewayProxyEventV2Model): | ||
body: Json[Order] | ||
``` | ||
|
||
## Envelopes | ||
|
||
When trying to parse your payloads wrapped in a known structure, you might encounter the following situations: | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.