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

Minor Changes on Serialization #2

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

khoramism
Copy link
Contributor

@khoramism khoramism commented Jun 26, 2024

Hey, Hope you guys are doing alright, I was reading the serialization part and i realized that we don't have much learning resources on Protocol Buffers and Avro, So the first commit is minor changes there.

I've also added the Json Schema in the Serialization Concept, Since it's being widely used in validation and serialization I felt it would be a shame not to have it on our wiki, I also checked the roadmap and we only have json there, do you guys think I should add it to there as well?

I'd very much appreciate your feedback on this pr, thanks :)

-Alireza

@niyushabaghayi
Copy link
Contributor

Hi Alireza,
Thanks for your invaluable PR!
According to chapter 4 (Encoding and Evolution) of the book Designing Data-Intensive Applications, all these are "formats of encoding data." However, unlike Avro and Protocol Buffers, JSON Schema is not a serialization format. JSON itself is the serialization format, while JSON Schema is a schema validation tool used to describe and validate the structure of data already encoded in JSON.
It may be more appropriate to include JSON Schema in the JSON section rather than under Serialization as a separate section.
Additionally, because XML Schema (XSD) works similarly to XML, it might also be nice to mention it beside XML.
What do you think?

PS, also thanks for adding resources for other documents :)) I have some comments there.

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.

2 participants