Document deprecation as of Fabric v2.5 (#157)

bestbeforetoday · web-flow · commit 21132f40b6d0 · 2023-04-19T14:11:41.000+01:00
Signed-off-by: Mark S. Lewis &lt;mark_lewis@uk.ibm.com&gt;
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 # Hyperledger Fabric Gateway SDK for Java <a href="https://github.com/hyperledger/fabric-gateway-java/actions/workflows/schedule.yml"><img src="https://github.com/hyperledger/fabric-gateway-java/actions/workflows/schedule.yml/badge.svg" alt="Build status" style="float: right"></a>
 
-> **Note:** When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
+> **Note:** This API is deprecated as of Fabric v2.5. When developing applications for Hyperledger Fabric v2.4 and later, you should use the [Fabric Gateway client API](https://hyperledger.github.io/fabric-gateway/).
 
 The Fabric Gateway SDK allows applications to interact with a Fabric blockchain network.  It provides a simple API to submit transactions to a ledger or query the contents of a ledger with minimal code.
 
diff --git a/pom.xml b/pom.xml
@@ -11,7 +11,7 @@
     <packaging>jar</packaging>
 
     <name>fabric-gateway-java</name>
-    <description>Simple API for interacting with Hyperledger Fabric blockchain networks</description>
+    <description>Simple API for interacting with Hyperledger Fabric blockchain networks. Deprecated as of Fabric v2.5, replaced by org.hyperledger.fabric:fabric-gateway.</description>
     <url>https://hyperledger.github.io/fabric-gateway-java/</url>
 
     <licenses>
diff --git a/src/main/java/org/hyperledger/fabric/gateway/package-info.java b/src/main/java/org/hyperledger/fabric/gateway/package-info.java
@@ -12,6 +12,8 @@
  * <a href="https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing Applications</a>
  * chapter of the Fabric documentation.</p>
  *
+ *
  * @see <a href="https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing Fabric Applications</a>
+ * @deprecated As of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.
  */
 package org.hyperledger.fabric.gateway;
diff --git a/src/main/java/org/hyperledger/fabric/gateway/spi/package-info.java b/src/main/java/org/hyperledger/fabric/gateway/spi/package-info.java
@@ -8,6 +8,6 @@
  * <p>This package provides the set of interfaces that enable a Java developer to
  * extend the set of built in handlers for controlling gateway strategies.
  *
- *
+ * @deprecated As of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.
  */
 package org.hyperledger.fabric.gateway.spi;
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
@@ -4,8 +4,9 @@
     <title>API Overview</title>
   </head>
   <body>
+    <p><strong>Note:</strong> this API is deprecated as of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.</p>
 	<p>
-	The Fabric Gateway SDK allows applications to interact with a Fabric blockchain network. 
+	The Fabric Gateway SDK allows applications to interact with a Fabric blockchain network.
 	It provides a simple API to submit transactions to a ledger or query the contents of a ledger with minimal code.
 	 The Gateway SDK implements the Fabric programming model as described in the
 	 <a href="https://hyperledger-fabric.readthedocs.io/en/latest/developapps/developing_applications.html">Developing Applications</a>

Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,8 @@`
`12`	`12`	`* <a href="https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing Applications</a>`
`13`	`13`	`* chapter of the Fabric documentation.</p>`
`14`	`14`	`*`
	`15`	`+ *`
`15`	`16`	`* @see <a href="https://hyperledger-fabric.readthedocs.io/en/release-1.4/developapps/developing_applications.html">Developing Fabric Applications</a>`
	`17`	`+ * @deprecated As of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.`
`16`	`18`	`*/`
`17`	`19`	`package org.hyperledger.fabric.gateway;`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,6 @@`
`8`	`8`	`* <p>This package provides the set of interfaces that enable a Java developer to`
`9`	`9`	`* extend the set of built in handlers for controlling gateway strategies.`
`10`	`10`	`*`
`11`		`- *`
	`11`	`+ * @deprecated As of Fabric v2.5, replaced by the <a href="https://hyperledger.github.io/fabric-gateway/">Fabric Gateway client API</a>.`
`12`	`12`	`*/`
`13`	`13`	`package org.hyperledger.fabric.gateway.spi;`