Updates Core API to 1.0.0-rc3

cycorp · Aug 15, 2015 · fa52470 · fa52470
1 parent e230ee9
commit fa52470
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 29 deletions.
diff --git a/BaseClient/pom.xml b/BaseClient/pom.xml
@@ -5,12 +5,12 @@
   <parent>
     <groupId>com.cyc</groupId>
     <artifactId>cyc-core-parent</artifactId>
-    <version>1.0.0-rc3-SNAPSHOT</version>
+    <version>1.0.0-rc3</version>
   </parent>
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-base-client</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>Base Client</name>

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,26 +4,33 @@ Cyc Core API Suite CHANGELOG
 For more information, view the [README](README.md) bundled with this release or visit the
 [Cyc Developer Center](http://dev.cyc.com/api/core/). 
 
+**Important note about _backwards-compatibility:_** It is expected that more release candidates will
+follow. Until the final 1.0.0 release, it is expected that future release candidates will break
+backwards compatibility.
+
 1.0.0-rc3 - 2015-08-14
 ----------------------
 
 The third release candidate of Cycorp's new Java API suite. 1.0.0-rc3 is _not backwards-compatible_
 with earlier releases. Note that _ResearchCyc 4.0q_ and _EnterpriseCyc 1.7-preview_ require 
 [server code patching](server-patching.md) for compatibility with the 1.0.0-rc3 release.
 
-#### New: Support for upcoming OpenCyc
+#### New: Support for upcoming OpenCyc release
 
 Adds support for the planned upcoming release of **OpenCyc 5.0-preview**. Note that the OpenCyc 
-server will not have support for some advanced features; see the 
-[README's Requirements section](README.md#requirements) for details. There are no plans to support
-previous versions of OpenCyc.
+server will not have support for advanced features such as QuerySearch or ProofViewJustification. 
+Classes and methods which are not supported by OpenCyc will reflect this in their javadoc 
+description and in their signature by declaring that they throw a 
+`com.cyc.session.exception.OpenCycUnsupportedServerException`.
+
+There are no plans to support previous versions of OpenCyc.
 
 #### Improved: Core API Specification
 
-* _Query API_ interfaces moved into CoreAPISpec.
+* _Query API_ interfaces moved into CoreAPISpec Maven module.
 * Adds the QueryFactory (`com.cyc.query.QueryFactory`) to facilitate query construction.
-* Compatibility with Cyc servers is now better-documented via the `UnsupportedCycOperationException`
-  and `OpenCycUnsupportedFeatureException` exceptions.
+* Compatibility with different Cyc server editions and versions is now better-documented via the 
+  `UnsupportedCycOperationException` and `OpenCycUnsupportedFeatureException` exceptions.
 
 #### Other changes
 

diff --git a/CoreAPISpec/pom.xml b/CoreAPISpec/pom.xml
@@ -10,7 +10,7 @@
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-core-api</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>Core API Specification</name>

diff --git a/CoreAPISuite/pom.xml b/CoreAPISuite/pom.xml
@@ -4,12 +4,12 @@
   <parent>
     <groupId>com.cyc</groupId>
     <artifactId>cyc-core-parent</artifactId>
-    <version>1.0.0-rc3-SNAPSHOT</version>
+    <version>1.0.0-rc3</version>
   </parent>
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-core-suite</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>Core API Suite Bundle</name>

diff --git a/KBAPI/pom.xml b/KBAPI/pom.xml
@@ -4,12 +4,12 @@
   <parent>
     <groupId>com.cyc</groupId>
     <artifactId>cyc-core-parent</artifactId>
-    <version>1.0.0-rc3-SNAPSHOT</version>
+    <version>1.0.0-rc3</version>
   </parent>
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-kb</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>KB API Implementation</name>

diff --git a/QueryAPI/pom.xml b/QueryAPI/pom.xml
@@ -5,12 +5,12 @@
   <parent>
     <groupId>com.cyc</groupId>
     <artifactId>cyc-core-parent</artifactId>
-    <version>1.0.0-rc3-SNAPSHOT</version>
+    <version>1.0.0-rc3</version>
   </parent>
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-query</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>Query API Implementation</name>

diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 Cyc Core API Suite
 ==================
 
-**Latest release:** [1.0.0-rc2](https://github.com/cycorp/CycCoreAPI/releases)
+**Latest release:** [1.0.0-rc3](https://github.com/cycorp/CycCoreAPI/releases)
 
-**Current snapshot version:** 1.0.0-rc3-SNAPSHOT  
+**Current snapshot version:** 1.0.0-rc4-SNAPSHOT  
 **License:** [Apache 2.0](LICENSE)  
 **Changes:** See the [CHANGELOG](CHANGELOG.md)  
 **Documentation:** [Cyc Developer Center](http://dev.cyc.com/api/core/)  
@@ -41,7 +41,7 @@ Requirements
 * [Apache Maven](http://maven.apache.org/) version `3.2` or higher to build the sources. If you are
   new to Maven, you may wish to view the [quick start](http://maven.apache.org/run-maven/index.html).
 
-The APIs may be used without Maven via the `cyc-core-suite-1.0.0-rc2-jar-with-dependencies.jar`.
+The APIs may be used without Maven via the `cyc-core-suite-1.0.0-rc3-jar-with-dependencies.jar`.
 See [Standalone Bundle](#standalone-bundle), below.
 
 ### Cyc Server
@@ -63,7 +63,7 @@ For inquiries about obtaining a suitable version of Cyc, please visit the
 
 ### Server Code Patching
 
-As of version 1.0.0-rc2, the Core API Suite requires SubL code patches which are not present in
+As of version 1.0.0-rc3, the Core API Suite requires SubL code patches which are not present in
 _ResearchCyc 4.0q_ or _EnterpriseCyc 1.7-preview_. These patches can be applied manually, or they
 can be automatically applied by the API bundle itself.
 
@@ -80,7 +80,7 @@ To use the Cyc Core APIs in a Maven project, add the following dependency to you
     <dependency>
       <groupId>com.cyc</groupId>
       <artifactId>cyc-core-suite</artifactId>
-      <version>1.0.0-rc2</version>
+      <version>1.0.0-rc3</version>
     </dependency>
 
 The Core APIs use the [SLF4J](http://www.slf4j.org/) logging API. This does not come with a logging
@@ -103,26 +103,26 @@ implementation, but instead allows you to specify your own. For example, to use
 If you're not using Apache Maven, or can't allow Maven to retrieve dependencies from the Internet,
 you may download this release in a standalone bundle containing:
 
-* A compiled `cyc-core-suite-1.0.0-rc2-jar-with-dependencies.jar`
+* A compiled `cyc-core-suite-1.0.0-rc3-jar-with-dependencies.jar`
 * A `CoreAPITests` project containing the source code for all of the unit tests from the Core API
   Suite, and the dependencies necessary to run them. This project may be run in Maven or as a native
   Eclipse project.
 * The CycCoreAPI source code (requires Maven to compile)
 * The CoreAPIUseCases source code (requires Maven to compile)
 
 The bundle is available from the
-[releases page](https://github.com/cycorp/CycCoreAPI/releases/tag/v1.0.0-rc2) as a tar or zip file:
+[releases page](https://github.com/cycorp/CycCoreAPI/releases/tag/v1.0.0-rc3) as a tar or zip file:
 
-* cyc-core-suite-standalone-1.0.0-rc2.tar.gz
-* cyc-core-suite-standalone-1.0.0-rc2.zip
+* cyc-core-suite-standalone-1.0.0-rc3.tar.gz
+* cyc-core-suite-standalone-1.0.0-rc3.zip
 
 To use a standalone jar in a Maven project, use the "jar-with-dependencies" classifier when 
 specifying the dependency:
 
     <dependency>
       <groupId>com.cyc</groupId>
       <artifactId>cyc-core-suite</artifactId>
-      <version>1.0.0-rc2</version>
+      <version>1.0.0-rc3</version>
       <classifier>jar-with-dependencies</classifier>
     </dependency>
 

diff --git a/SessionAPI/pom.xml b/SessionAPI/pom.xml
@@ -5,12 +5,12 @@
   <parent>
     <groupId>com.cyc</groupId>
     <artifactId>cyc-core-parent</artifactId>
-    <version>1.0.0-rc3-SNAPSHOT</version>
+    <version>1.0.0-rc3</version>
   </parent>
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-session</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>jar</packaging>
 
   <name>Session API Implementation</name>

diff --git a/pom.xml b/pom.xml
@@ -4,7 +4,7 @@
 
   <groupId>com.cyc</groupId>
   <artifactId>cyc-core-parent</artifactId>
-  <version>1.0.0-rc3-SNAPSHOT</version>
+  <version>1.0.0-rc3</version>
   <packaging>pom</packaging>
 
   <name>Core API Parent</name>