Skip to content

Conversation

Chaymee
Copy link
Contributor

@Chaymee Chaymee commented Oct 2, 2025

Updated the JCSMP tutorial page to include the SERDES features.

✨ PR Description

Purpose: Add Schema Registry serialization/deserialization (SERDES) tutorial for JCSMP API to document JSON Schema validation capabilities.

Main changes:

  • Created new tutorial markdown file explaining JSON Schema SERDES integration with JCSMP
  • Updated Git commit reference for JCSMP-Samples to include the latest Schema Registry examples
  • Documented configuration, serialization/deserialization patterns, and error handling for Schema Registry

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀

Included JSON tutorial but left out AVRO and generic as they are essentially identical
@Chaymee Chaymee requested a review from TamimiGitHub October 2, 2025 16:04
@TamimiGitHub TamimiGitHub requested a review from Copilot October 2, 2025 16:05
Copy link

@gitstream-cm gitstream-cm bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✨ PR Review

The PR introduces a comprehensive tutorial for JCSMP SERDES features with good documentation structure. The changes include updating a commit reference and adding new tutorial content.

2 issues detected:

🧾 Readability - Image reference may point to a non-existent file causing broken link

Details: The tutorial references an image file 'image.png' that may not exist in the repository, which could result in a broken image link on the rendered tutorial page.
File: src/pages/tutorials/jcsmp/schema-registry-serdes.md (22-22)

🧾 Readability - Missing bullet point marker creates inconsistent list formatting

Details: The prerequisites section has inconsistent bullet point formatting where one line uses proper markdown bullet syntax while the following line does not.
File: src/pages/tutorials/jcsmp/schema-registry-serdes.md (38-38)

Generated by LinearB AI and added by gitStream.
AI-generated content may contain inaccuracies. Please verify before using. We'd love your feedback! 🚀


The Solace Schema Registry provides a centralized repository for managing message schemas, enabling schema validation, versioning, and evolution across your event-driven applications. The Schema Registry SERDES integration with JCSMP allows you to serialize and deserialize messages while automatically validating them against registered schemas.

![Schema Registry Flow](image.png)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧾 Readability - Missing Image File: Verify that the image.png file exists in the correct location or update the image path to point to the correct file location.

Suggested change
![Schema Registry Flow](image.png)
![Schema Registry Flow](https://docs.solace.com/Schema-Registry/Images/schema-registry-flow.png)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally rename image.png to ./serdes_arch.png or something similar

Copy link

gitstream-cm bot commented Oct 2, 2025

Please mark whether you used Copilot to assist coding in this PR

  • Copilot Assisted

Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds comprehensive documentation for the Schema Registry Serialize/Deserialize (SERDES) features to the JCSMP tutorial. The documentation covers JSON Schema serialization and deserialization capabilities with the Solace Schema Registry.

  • Adds a new tutorial page explaining Schema Registry SERDES functionality
  • Updates the Git commit reference for the JCSMP samples repository
  • Provides code examples for both serialization and deserialization workflows

Reviewed Changes

Copilot reviewed 2 out of 4 changed files in this pull request and generated 2 comments.

File Description
src/pages/tutorials/jcsmp/schema-registry-serdes.md New tutorial documentation explaining Schema Registry SERDES features with JSON Schema examples
gatsby-config.js Updates commit hash reference for JCSMP samples repository

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

* Access to the Schema Registry with appropriate credentials
* JSON Schema files uploaded to the Schema Registry
* There must be a suitable [Client Profile](https://docs.solace.com/Configuring-and-Managing/Configuring-Client-Profiles.htm) configured on your broker
For guidance on schema registry setup complete the [Schema registry codelab](https://codelabs.solace.dev/codelabs/schema-registry/?index=..%2F..index#0)
Copy link

Copilot AI Oct 2, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing comma after 'setup'. Should be 'For guidance on schema registry setup, complete the...'

Suggested change
For guidance on schema registry setup complete the [Schema registry codelab](https://codelabs.solace.dev/codelabs/schema-registry/?index=..%2F..index#0)
For guidance on schema registry setup, complete the [Schema registry codelab](https://codelabs.solace.dev/codelabs/schema-registry/?index=..%2F..index#0)

Copilot uses AI. Check for mistakes.

@TamimiGitHub TamimiGitHub merged commit c5b7797 into SolaceDev:master Oct 3, 2025
4 of 5 checks passed
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