Re: NEW: API Stability annotations!

2015-08-13 Thread Edward Ribeiro
Very cool! Congrats! :) My only comment is that, as Gwen pointed out in the first email, it is a set of API compatibility annotations, but the name is InterfaceStability. Wouldn't ApiStability be a better name? InterfaceStability looks a bit restrictive, imho.

Re: NEW: API Stability annotations!

2015-08-13 Thread Ewen Cheslack-Postava
We could potentially add more annotations to cover things like public/private APIs, deprecation, etc. I lifted this initial implementation from Hadoop (thanks for the pointer Gwen!). Hadoop also has a public/private annotation that we could lift, and they use this to filter javadocs. These are

Re: NEW: API Stability annotations!

2015-08-13 Thread Ismael Juma
On Thu, Aug 13, 2015 at 8:36 AM, Ewen Cheslack-Postava e...@confluent.io wrote: On deprecation, I think we should definitely use the standard annotation to handle this. Thanks Ewen. I agree that we should use @Deprecated for language-level deprecations. My question was regarding the

Re: NEW: API Stability annotations!

2015-08-13 Thread Gwen Shapira
IMO, both old producer and old consumer APIs should be marked as deprecated for 0.8.3 (since the new code will be in and we want to encourage the switch). I'd like to see 0.9 released with just the new java clients. On Thu, Aug 13, 2015 at 6:47 AM, Ismael Juma ism...@juma.me.uk wrote: On Thu,

Re: NEW: API Stability annotations!

2015-08-13 Thread Neha Narkhede
Thanks for starting the discussion around API annotations, Gwen! I think it is better to add the deprecated annotation after the new consumer API is successfully deployed at a couple places. On Thu, Aug 13, 2015 at 3:42 PM, Ismael Juma ism...@juma.me.uk wrote: On Thu, Aug 13, 2015 at 10:41 PM,

Re: NEW: API Stability annotations!

2015-08-13 Thread Ismael Juma
On Thu, Aug 13, 2015 at 10:41 PM, Gwen Shapira g...@confluent.io wrote: IMO, both old producer and old consumer APIs should be marked as deprecated for 0.8.3 (since the new code will be in and we want to encourage the switch). I can see the appeal of this, but it's also worth considering the

Re: NEW: API Stability annotations!

2015-08-13 Thread Gwen Shapira
Got it! I was under the impression that deprecated means there is something better now and we'll remove this in few releases. But yeah, lets avoid marking it for now. On Thu, Aug 13, 2015 at 4:58 PM, Neha Narkhede n...@confluent.io wrote: Thanks for starting the discussion around API

NEW: API Stability annotations!

2015-08-12 Thread Gwen Shapira
Hi Team Kafka, Ewen just added stability annotations to Apache Kafka (KAFKA-2429). In the same PR, we marked the new Consumer API as unstable since we are still actively iterating on them. The goal is to mark them as evolving before the next release and after one release to validate them, we

Re: NEW: API Stability annotations!

2015-08-12 Thread Grant Henke
This is a great idea! I do question the classifications a bit. @stable seams unreasonable as Kafka has not has a major release yet. I have typically thought of Kafka releases as 0.{major}.{minor}.{maintenance}. For instance 0.8.3 coming up has a significant amount of change. Though Kafka's

Re: NEW: API Stability annotations!

2015-08-12 Thread Gwen Shapira
Yeah, I agree that your description matches reality better :) By document do you have any suggestions where? The interface itself has documentation. Were you thinking Wiki? On Wed, Aug 12, 2015 at 3:48 PM, Grant Henke ghe...@cloudera.com wrote: This is a great idea! I do question the

Re: NEW: API Stability annotations!

2015-08-12 Thread Jiangjie Qin
Good annotations. I can see a few future usages :) Jiangjie (Becket) Qin On Wed, Aug 12, 2015 at 3:05 PM, Gwen Shapira g...@confluent.io wrote: Hi Team Kafka, Ewen just added stability annotations to Apache Kafka (KAFKA-2429). In the same PR, we marked the new Consumer API as unstable

Re: NEW: API Stability annotations!

2015-08-12 Thread Ismael Juma
Hi Gwen, Nice to see this. There is no deprecation cycle for breakages? Ismael On Wed, Aug 12, 2015 at 11:05 PM, Gwen Shapira g...@confluent.io wrote: Hi Team Kafka, Ewen just added stability annotations to Apache Kafka (KAFKA-2429). In the same PR, we marked the new Consumer API as