avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Sean Busbey (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (AVRO-2019) Improve documentation for logical type annotations in IDL
Date Fri, 15 Sep 2017 13:06:00 GMT

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

Sean Busbey commented on AVRO-2019:
-----------------------------------

Given the docs on logical types elsewhere, I think it's worth calling out this particular
use of annotations in IDL. Folks who rely on IDL to use Avro shouldn't have to know the implementation
details of how logical types are implemented via properties so that they can reason out how
to use them in IDL.

> Improve documentation for logical type annotations in IDL
> ---------------------------------------------------------
>
>                 Key: AVRO-2019
>                 URL: https://issues.apache.org/jira/browse/AVRO-2019
>             Project: Avro
>          Issue Type: Improvement
>          Components: doc, logical types
>            Reporter: Andrew Rosca
>            Priority: Minor
>         Attachments: AVRO-2019.patch
>
>
> The IDL documentation lacks information for how annotations can be specified for logical
types, like in the following example:
> {code}
> protocol test {
>     record test {
>         @logicalType("timestamp-millis")
>         long time;
>     }
> }
> {code}



--
This message was sent by Atlassian JIRA
(v6.4.14#64029)

Mime
View raw message