Documented expected compatibility between releases for the SOAP API

mantisbt · Dec 6, 2011 · f58911e · f58911e
1 parent bbde4d4
commit f58911e
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/docbook/developers/en/integrators.sgml b/docbook/developers/en/integrators.sgml
@@ -41,6 +41,18 @@
 			Eclipse Orbit</ulink>
 		</sect2>
 	</sect1>
+
+        <sect1 id="integrators.compatibility">
+                <title>Compatibility between releases</title>
+
+                <para>The SOAP API signature will change between minor releases, typically to add new functionality or to extend existing features.
+                </para>
+                <para>Some of these changes might require a refresh of the client libraries generated, for instance Apache Axis 1 SOAP stubs must be
+                regenerated if a complex type receives a new property. Such changes will be announced before the release of the new MantisBT version
+                on the <ulink url="http://lists.sourceforge.net/mailman/listinfo/mantisbt-soap-dev"> mantisbt-soap-dev mailing list</ulink> . 
+                Typically there will be two weeks time to integrate the new SOAP stubs.</para>
+
+        </sect1>
 
 	<sect1 id="integrators.support">
 		<title>Support</title>