[GitHub] avro pull request #197: AVRO-2001 Adding support for doc attribute

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

[GitHub] avro pull request #197: AVRO-2001 Adding support for doc attribute

GitHub user lostphilosopher opened a pull request:


    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:


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


If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [hidden email] or file a JIRA ticket
with INFRA.