[FAB-15883] Removed swagger annotations

- added contact, info and license annotation files
- added .vscode folder to .gitignore
- fixed some typos

Signed-off-by: heatherlp <[email protected]>
Change-Id: I45bcff4a3b8cd98b65a3f3766cfbb9d4712e7902

Author: heatherlp

.gitignore

@@ -36,4 +36,5 @@ nbdist/
 .nb-gradle/
 
 local-config.yaml
-gradle.properties
+gradle.properties
+.vscode/

fabric-chaincode-shim/build.gradle

@@ -19,8 +19,8 @@ tasks.withType(org.gradle.api.tasks.testing.Test) {
 dependencies {
     compile project(':fabric-chaincode-protos')
     compile 'io.netty:netty-tcnative-boringssl-static:2.0.7.Final'
-    compile 'org.bouncycastle:bcpkix-jdk15on:1.59'
-    compile 'org.bouncycastle:bcprov-jdk15on:1.59'
+    compile 'org.bouncycastle:bcpkix-jdk15on:1.60'
+    compile 'org.bouncycastle:bcprov-jdk15on:1.60'
     compile 'org.reflections:reflections:0.9.11'
     implementation 'com.github.everit-org.json-schema:org.everit.json.schema:1.11.1'
     compile 'io.swagger.core.v3:swagger-annotations:2.0.0'

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Contact.java

@@ -0,0 +1,30 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.hyperledger.fabric.contract.annotation;
+
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Class level annotation that identifies this class as being a contact. Can
+ * be populated with email, name and url fields.
+ *
+ */
+@Retention(RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Contact {
+
+    String email() default "";
+
+    String name() default "";
+
+    String url() default "";
+
+}

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Contract.java

@@ -12,31 +12,24 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
-import io.swagger.v3.oas.annotations.info.Info;
+import org.hyperledger.fabric.contract.annotation.Info;
 
 /**
  * Class level annotation that identifies this class as being a contract. Can
  * supply information and an alternative name for the contract rather than the
  * classname
- * <p>
- * The Info object can be supplied to provide additional information about the
- * contract; the format of this uses the OpenAPI v3 specification of info
- * {@link io.swagger.v3.oas.annotations.info.Info}
- *
  */
 @Retention(RUNTIME)
 @Target(ElementType.TYPE)
 public @interface Contract {
 
     /**
      * The Info object can be supplied to provide additional information about the
-     * contract; the format of this uses the  OpenAPI v3 Info format
+     * contract, including title, description, version and license
      *
-     *
-     * @return OpenAPI v3 specification of info
-     *         {@link io.swagger.v3.oas.annotations.info.Info}
+     * @return Info object
      */
-    Info info();
+    Info info() default @Info();
 
     /**
      * Normally the name of the class is used to refer to the contract (name without package).

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Info.java

@@ -0,0 +1,51 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.hyperledger.fabric.contract.annotation;
+
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+import org.hyperledger.fabric.contract.annotation.License;
+import org.hyperledger.fabric.contract.annotation.Contact;
+
+/**
+ * Class level annotation that identifies this class as being an info object. Can
+ * supply additional information about the contract, including title, description,
+ * version, license and contact information.
+ *
+ */
+@Retention(RUNTIME)
+@Target(ElementType.TYPE)
+public @interface Info {
+
+    String title() default "";
+
+    String description() default "";
+
+    String version() default "";
+
+    String termsOfService() default "";
+
+    /**
+     * License object that can be populated to include name and url.
+     *
+     * @return License object
+     *
+     */
+    License license() default @License();
+
+    /**
+     * Contact object that can be populated with email, name and url fields.
+     *
+     * @return Contact object
+     *
+     */
+    Contact contact() default @Contact();
+
+}

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/License.java

@@ -0,0 +1,28 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package org.hyperledger.fabric.contract.annotation;
+
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Class level annotation that identifies this class as being a license object. Can
+ * be populated to include name and url.
+ *
+ */
+@Retention(RUNTIME)
+@Target(ElementType.TYPE)
+public @interface License {
+
+    String name() default "";
+
+    String url() default "";
+
+}

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Property.java

@@ -13,7 +13,7 @@
 
 /**
  * Field and parameter level annotation defining a property of the class
- * (identified by {@link DataType}) Can also be used on the paratemers of
+ * (identified by {@link DataType}) Can also be used on the parameters of
  * transaction functions
  * <p>
  * Example of using this annotation
@@ -26,7 +26,7 @@
  *
  * // How friendly is this on a scale of 1-5, 1 being formal, 5 being familar
  * &#64;Property(schema = { "minimum", "1", "maximum", "5" })
- * private int friendlyness = 1;
+ * private int friendliness = 1;
  *
  * </pre>
  */

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/annotation/Transaction.java

@@ -16,16 +16,16 @@
  * Method level annotation indicating the method to be a callable transaction
  * function.
  * <p>
- * These funcitons are called in client SDKs by the combination of <pre> [contractname]:[transactioname] </pre>
- * Unless specified other wise, the contract name is the class name (without package) and the transactio
+ * These functions are called in client SDKs by the combination of <pre> [contractname]:[transactioname] </pre>
+ * Unless specified otherwise, the contract name is the class name (without package) and the transaction
  * name is the method name.
  */
 @Retention(RUNTIME)
 @Target(METHOD)
 public @interface Transaction {
     /**
      * TRUE indicates that this function is intended to be called with the 'submit'
-     * semantics.
+     * semantics
      *
      * FALSE indicates that this is intended to be called with the evaluate
      * semantics

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/metadata/MetadataBuilder.java

@@ -31,7 +31,7 @@
 import org.json.JSONObject;
 import org.json.JSONTokener;
 
-import io.swagger.v3.oas.annotations.info.Info;
+import org.hyperledger.fabric.contract.annotation.Info;
 
 /**
  * Builder to assist in production of the metadata

fabric-chaincode-shim/src/main/java/org/hyperledger/fabric/contract/routing/impl/ContractDefinitionImpl.java

@@ -39,7 +39,7 @@ public class ContractDefinitionImpl implements ContractDefinition {
     public ContractDefinitionImpl(Class<? extends ContractInterface> cl) {
 
         Contract annotation = cl.getAnnotation(Contract.class);
-        logger.debug(() -> "Class Contract Annodation: " + annotation);
+        logger.debug(() -> "Class Contract Annotation: " + annotation);
 
         String annotationName = annotation.name();
 
@@ -58,7 +58,7 @@ public ContractDefinitionImpl(Class<? extends ContractInterface> cl) {
             unknownTx = new TxFunctionImpl(m, this);
             unknownTx.setUnknownTx(true);
         } catch (NoSuchMethodException | SecurityException e) {
-            ContractRuntimeException cre = new ContractRuntimeException("Failure to find unknownTranction method", e);
+            ContractRuntimeException cre = new ContractRuntimeException("Failure to find unknownTransaction method", e);
             logger.severe(() -> logger.formatError(cre));
             throw cre;
         }