Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id ED04D200C6F for ; Tue, 4 Apr 2017 01:17:47 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id EB873160BA4; Mon, 3 Apr 2017 23:17:47 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 3FFC5160B9F for ; Tue, 4 Apr 2017 01:17:47 +0200 (CEST) Received: (qmail 66356 invoked by uid 500); 3 Apr 2017 23:17:46 -0000 Mailing-List: contact dev-help@avro.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@avro.apache.org Delivered-To: mailing list dev@avro.apache.org Received: (qmail 66107 invoked by uid 99); 3 Apr 2017 23:17:46 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 03 Apr 2017 23:17:46 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id F217B1A0365 for ; Mon, 3 Apr 2017 23:17:45 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -100.002 X-Spam-Level: X-Spam-Status: No, score=-100.002 tagged_above=-999 required=6.31 tests=[RP_MATCHES_RCVD=-0.001, SPF_PASS=-0.001, USER_IN_WHITELIST=-100] autolearn=disabled Received: from mx1-lw-us.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id E4joySUZUf6U for ; Mon, 3 Apr 2017 23:17:45 +0000 (UTC) Received: from mailrelay1-us-west.apache.org (mailrelay1-us-west.apache.org [209.188.14.139]) by mx1-lw-us.apache.org (ASF Mail Server at mx1-lw-us.apache.org) with ESMTP id 0289B5FBFA for ; Mon, 3 Apr 2017 23:17:45 +0000 (UTC) Received: from jira-lw-us.apache.org (unknown [207.244.88.139]) by mailrelay1-us-west.apache.org (ASF Mail Server at mailrelay1-us-west.apache.org) with ESMTP id F362BE0BDD for ; Mon, 3 Apr 2017 23:17:43 +0000 (UTC) Received: from jira-lw-us.apache.org (localhost [127.0.0.1]) by jira-lw-us.apache.org (ASF Mail Server at jira-lw-us.apache.org) with ESMTP id 963EE2401E for ; Mon, 3 Apr 2017 23:17:42 +0000 (UTC) Date: Mon, 3 Apr 2017 23:17:42 +0000 (UTC) From: "Suraj Acharya (JIRA)" To: dev@avro.apache.org Message-ID: In-Reply-To: References: Subject: [jira] [Assigned] (AVRO-2001) Add support for doc in the Ruby library for Avro schemas MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 7bit X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394 archived-at: Mon, 03 Apr 2017 23:17:48 -0000 [ https://issues.apache.org/jira/browse/AVRO-2001?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ] Suraj Acharya reassigned AVRO-2001: ----------------------------------- Assignee: Wyatt Andersen > 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 Andersen > Assignee: Wyatt Andersen > Priority: Minor > Labels: features > Fix For: 1.9.0 > > > 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/avro_2001 based on https://github.com/apache/avro/pull/14/commits/164fb49f80dfaac421639e6249a6f92c802a50b6. -- This message was sent by Atlassian JIRA (v6.3.15#6346)