docs(parser): add JSON string field extension example #1526
Conversation
This file contains 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
rubenfonseca
requested review from
heitorlessa
and removed request for
a team
boring-cyborg
bot
added
the
documentation
pull-request-size
bot
added
the
size/S
heitorlessa
suggested changes
Sep 21, 2022
docs/utilities/parser.md
Outdated
| 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.
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
pull-request-size
bot
added
size/M
|
@heitorlessa created two samples and referenced them in the docs, ready for another review |
heitorlessa
reviewed
Sep 23, 2022
examples/parser/src/extending_built_in_models_with_json_mypy.py
Outdated
Show resolved
Hide resolved
examples/parser/src/extending_built_in_models_with_json_mypy.py
Outdated
Show resolved
Hide resolved
examples/parser/src/extending_built_in_models_with_json_validator.py
Outdated
Show resolved
Hide resolved
heitorlessa
approved these changes
Sep 23, 2022
7 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Issue number: #1518
Summary
Changes
This PR adds a small tip to the parser documentation, highlighting how to override a string field containing Json.
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.
View rendered docs/utilities/parser.md