[jira] [Commented] (AVRO-2001) Add support for doc in the Ruby library for Avro schemas

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (AVRO-2001) Add support for doc in the Ruby library for Avro schemas

JIRA jira@apache.org

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

ASF GitHub Bot commented on AVRO-2001:
--------------------------------------

GitHub user lostphilosopher opened a pull request:

    https://github.com/apache/avro/pull/197

    AVRO-2001 Adding support for doc attribute

    The Avro schema and protocol specification(http://avro.apache.org/docs/current/spec.html) allows for an optional attribute "doc" defined as, "a JSON string describing this field for users." Users should be able to include a doc with each field for "records" (http://avro.apache.org/docs/current/spec.html#N10085) and "enums" (http://avro.apache.org/docs/current/spec.html#N10186).
   
    This doc attribute should be stripped when transforming into "Parsing Canonical Form" (http://avro.apache.org/docs/current/spec.html#N10815).
   
    Currently, the Ruby Avro library (https://github.com/apache/avro/tree/master/lang/ruby) does not support doc. It is supported in other languages libraries, for example PHP (https://github.com/apache/avro/blob/master/lang/php/lib/avro/schema.php#L46).

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/lostphilosopher/avro avro_2001

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/avro/pull/197.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #197
   
----
commit 654bedf194196b5f6d8ba5f28f516010c0be89b8
Author: lostphilosopher <[hidden email]>
Date:   2017-02-15T19:05:43Z

    AVRO-2001 Adding support for doc attribute

----


> Add support for doc in the Ruby library for Avro schemas
> --------------------------------------------------------
>
>                 Key: AVRO-2001
>                 URL: https://issues.apache.org/jira/browse/AVRO-2001
>             Project: Avro
>          Issue Type: New Feature
>          Components: ruby
>            Reporter: Wyatt Anderse
>            Priority: Minor
>              Labels: features
>
> The Avro schema and protocol specification(http://avro.apache.org/docs/current/spec.html) allows for an optional attribute "doc" defined as, "a JSON string describing this field for users." Users should be able to include a doc with each field for "records" (http://avro.apache.org/docs/current/spec.html#N10085) and "enums" (http://avro.apache.org/docs/current/spec.html#N10186).
> This doc attribute should be stripped when transforming into "Parsing Canonical Form" (http://avro.apache.org/docs/current/spec.html#N10815).
> Currently, the Ruby Avro library (https://github.com/apache/avro/tree/master/lang/ruby) does not support doc. It is supported in other languages libraries, for example PHP (https://github.com/apache/avro/blob/master/lang/php/lib/avro/schema.php#L46).
> Not supporting doc in Ruby causes confusion for the end user, and prevents that end use from taking advantage of a useful tool for managing complex schema.
> doc should be supported for schema and protocols in the Apache Ruby Avro library.
> Possible implementation: https://github.com/lostphilosopher/avro/tree/add_doc_to_schema based on https://github.com/apache/avro/pull/14/commits/164fb49f80dfaac421639e6249a6f92c802a50b6.



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)