-
Notifications
You must be signed in to change notification settings - Fork 77
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
Write documentation on using the smithy4s json module directly #1653
base: series/0.18
Are you sure you want to change the base?
Conversation
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few minor clarifications here on the wording and then also I think we should add the following warning to these docs as well
* Beware : using this method with a non-static schema (for instance, dynamically generated) may |
Co-authored-by: Jeff Lewis <lewisjkl@me.com>
Gentle reminder that we already have documentation regarding serialisation in different formats : https://disneystreaming.github.io/smithy4s/docs/02.1-serialisation/serialisation#json It may be valuable to split this page into different pages (per serialisation format), and possibly to re-order the entries in the sidebar such that the serialisation section appears higher. The contents of this PR, if needed, should go in the JSON specific page. |
If you would like to enhance description for customization then please see here a lot of examples of smithy4s-json custom codecs for efficient working with arrays and tuples, skipping default values of case class fields, etc. |
PR Checklist (not all items are relevant to all PRs)