Remove annotation `@Internal` from class `JsonObjectSerde`

[yawkat]

@dstepanov added you since you added the annotation

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information

[dstepanov]

Why does it need to be "public"?

[guillermocalvo]

@dstepanov Why does it need to be "public"?

Because documentation says it can be subclassed:

[dstepanov]

In what way would you do it?

[guillermocalvo]

In what way would you do it?

I'd say either we stop discouraging users from using this class (ie. remove @Internal), or we stop advertising it in the documentation (ie. remove that little ℹ️ box).

It all depends on what motivated the addition of this annotation in the first place. @dstepanov What was the rationale behind it?

[dstepanov]

I just don’t understand how it can be extended and used to register anything. If you thinks the use case is valid go ahead and remove the internal. My motivation was to not expose internal classes as over API.

[guillermocalvo]

My motivation was to not expose internal classes as over API.

If you believe this is really an internal class that shouldn't be directly subclassed by users, I can just remove that part of the guide. I'm good either way. Your call @dstepanov

Thoughts? @yawkat @sdelamo

[yawkat]

it seems to me that to customize kafka serialization, subclassing JsonObjectSerde and overriding the read/write methods makes sense. but we have no sample of this.

@graemerocher you wrote this initially, do you remember how it's supposed to be used?

@henriquelsmti can you share what you do in your subclass?

[henriquelsmti]

@yawkat after some refactoring, we'r using JsonObjectSerde only in kafka streams, as a superclass for Serdes of specific types.

[guillermocalvo]

There seem to be valid use cases for subclassing JsonObjectSerde. Shall we remove @Internal then?

@sdelamo @yawkat @dstepanov @graemerocher

[dstepanov]

If it’s a valid case then yes