You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "Lucas Heimberg (Jira)" <ji...@apache.org> on 2020/12/07 10:37:00 UTC

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

     [ https://issues.apache.org/jira/browse/AVRO-2997?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Lucas Heimberg updated AVRO-2997:
---------------------------------
    Description: 
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.

  was:
Named schemas have a documentation field. In contrast to the Java implementation, the C# implementation of Avro is missing this field in the canonical string representation of named schemas.

To fix this, it seems that it is enough to add writing the documentation string to the WriteJsonFields method of NamedSchema.

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.


> 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
>
> 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)