[jira] [Comment Edited] (AVRO-2997) Documentation is missing in string representation of named schemas

["Lucas Heimberg (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/AVRO-2997?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17245125#comment-17245125 ] 

Lucas Heimberg edited comment on AVRO-2997 at 12/7/20, 10:40 AM:
-----------------------------------------------------------------

Please review the patch, which adds the doc field of EnumSchema and RecordSchema to their canonical JSON representation as returned by their ToString() methods. 


was (Author: l.heimberg):
This patch adds the doc field of EnumSchema and RecordSchema to their canonical JSON representation as returned by their ToString() methods.

> Documentation is missing in string representation of named schemas
> ------------------------------------------------------------------
>
>                 Key: AVRO-2997
>                 URL: https://issues.apache.org/jira/browse/AVRO-2997
>             Project: Apache Avro
>          Issue Type: Bug
>          Components: csharp
>    Affects Versions: 1.10.0
>            Reporter: Lucas Heimberg
>            Priority: Major
>         Attachments: AVRO-2997.patch
>
>
> The named schema types record and enum have a documentation field. In contrast to the Java implementation, the C# implementation of Avro is missing this field in their canonical string representation returned by ToString().
> To fix this, it seems that it is enough to add writing the documentation string to the WriteJsonFields method of RecordSchema and EnumSchema.
> This is more than a cosmetical problem as, for example, the Confluent schema registry decides equivalence of schemas based on the canonical string representation. The missing doc field in the C# implementation makes it hard to emulate this concept of schema equivalence in an application using the C# implementation of Avro.



--
This message was sent by Atlassian Jira
(v8.3.4#803005)