Skip to content
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

Open
wants to merge 4 commits into
base: series/0.18
Choose a base branch
from

Conversation

a-morales
Copy link

PR Checklist (not all items are relevant to all PRs)

  • Added unit-tests (for runtime code)
  • Added bootstrapped code + smoke tests (when the rendering logic is modified)
  • Added build-plugins integration tests (when reflection loading is required at codegen-time)
  • Added alloy compliance tests (when simpleRestJson protocol behaviour is expanded/updated)
  • Updated dynamic module to match generated-code behaviour
  • Added documentation
  • Updated changelog

@CLAassistant
Copy link

CLAassistant commented Feb 20, 2025

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link
Contributor

@lewisjkl lewisjkl left a 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

@Baccata
Copy link
Contributor

Baccata commented Feb 21, 2025

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.

@plokhotnyuk
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants