Brock Noland created HIVE-9362:
----------------------------------

             Summary: Document API Gurantees
                 Key: HIVE-9362
                 URL: https://issues.apache.org/jira/browse/HIVE-9362
             Project: Hive
          Issue Type: Task
            Reporter: Brock Noland
            Priority: Blocker
             Fix For: 1.0.0


This is an uber JIRA to document our API compatibility guarantees. Similar to 
Hadoop I believe we should have 
[InterfaceAudience|https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceAudience.java]
 and 
[InterfaceStability|https://github.com/apache/hadoop/blob/trunk/hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/InterfaceStability.java]
 which I believe originally came from Sun.

This project would be an effort by the Hive community including other projects 
which depend on HIve API's to document which API's they use. Although all API's 
that they use may not be considered {{Stable}} or even {{Evolving}} we'll at 
least have any idea of who were are breaking when a change is made.

Beyond the Java API there is the Thrift API. Many projects directly use the 
Thrift binding since we don't provide an API in say Python. As such I'd suggest 
we consider the Thrift API to be {{Public}} and {{Stable}}.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to