Added json.md - Serialization part #1083
Open
+107
−0
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
Jai2305
requested review from
reta,
Bukhtawar,
dblock,
szczepanczykd,
madhusudhankonda,
saratvemulapalli,
VachaShah and
Xtansia
as code owners
|
In response to @dblock's ask for documentation I have added json.md in guides folder with code samples demonstrating the usage of toJsonString. |
reta
reviewed
Jul 15, 2024
guides/json.md
Outdated
| ``` | ||
| ### Using toJsonString method | ||
| For classes implementing `PlainJsonSerializable`, which extends `JsonpSerializable`, a default `toJsonString` method is provided. | ||
| This method utilizes the default mapper and generator from the JsonpUtils class within the package to streamline the serialization process. |
There was a problem hiding this comment.
Suggested change
| This method utilizes the default mapper and generator from the JsonpUtils class within the package to streamline the serialization process. | |
| This implementation uses `jakarta.json.spi.JsonProvider` SPI to discover the available JSON provider instance from the classpath and to create a new mapper. The `JsonpUtils` utility class streamlines this serialization process. |
Signed-off-by: Jai2305 <jainjai2305@gmail.com>
reta
approved these changes
Jul 15, 2024
dblock
requested changes
Jul 15, 2024
| @@ -16,6 +16,7 @@ This section is for maintaining a changelog for all breaking changes for the cli | |||
| - Document HTTP/2 support ([#330](https://github.com/opensearch-project/opensearch-java/pull/330)) | |||
| - Add support for phase_took & search_pipeline request params ([#1036](https://github.com/opensearch-project/opensearch-java/pull/1036)) | |||
| - Add an interface PlainJsonSerializable inherit from JsonpSerializable with a default method streamlining serialization ([#1064](https://github.com/opensearch-project/opensearch-java/pull/1064)) | |||
| - Add a new file json.md in guides and SerializationBasics in samples/json ([#1083](https://github.com/opensearch-project/opensearch-java/pull/1083)) | |||
There was a problem hiding this comment.
Nit: I would collapse the two changelog items and just say that we added request serialization to JSON.
| @@ -0,0 +1,59 @@ | |||
| - [Working with Json](#working-with-json) | |||
| - [Serialization](#serialization) | |||
| - [Using toJsonString method](#using-tojsonstring-method) | |||
There was a problem hiding this comment.
Using toJsonString (quote, remove method)
| - [Working with Json](#working-with-json) | ||
| - [Serialization](#serialization) | ||
| - [Using toJsonString method](#using-tojsonstring-method) | ||
| - [Manual serialization](#manually-serialize-by-providing-mapper-and-generator) |
There was a problem hiding this comment.
Capitalize sections consistently, so "Manual Serialization"
|
|
||
| # Working with Json | ||
|
|
||
| OpenSearch Java client seamlessly integrate with JSON providing serialization and deserialization capability. |
| For demonstration let's consider an instance of `SearchRequest`. | ||
|
|
||
| ```java | ||
| public static void main(final String[] args) { |
There was a problem hiding this comment.
remove main, keep the body of it
| } | ||
|
|
||
| ``` | ||
|
|
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.
Description
toJsonStringmethod added here and manual serialization with serialize method inJsonpSerializableIssues Resolved
Documentation for Json serialization with code samples
Work samples demonstrating logging with toJsonString method.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.