Add method description in service constructors (#1113)

* modify mustache templates and generate checkout * indenting * indeting #2 * use api_single classname in mustache
Adyen · Aug 21, 2023 · 7cc02ee · 7cc02ee
1 parent 1effec2
commit 7cc02ee
Show file tree

Hide file tree

Showing 9 changed files with 98 additions and 0 deletions.
diff --git a/src/main/java/com/adyen/service/checkout/ClassicCheckoutSdkApi.java b/src/main/java/com/adyen/service/checkout/ClassicCheckoutSdkApi.java
@@ -33,11 +33,21 @@ public class ClassicCheckoutSdkApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Classic Checkout SDK constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public ClassicCheckoutSdkApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Classic Checkout SDK constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public ClassicCheckoutSdkApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/ModificationsApi.java b/src/main/java/com/adyen/service/checkout/ModificationsApi.java
@@ -41,11 +41,21 @@ public class ModificationsApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Modifications constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public ModificationsApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Modifications constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public ModificationsApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/OrdersApi.java b/src/main/java/com/adyen/service/checkout/OrdersApi.java
@@ -35,11 +35,21 @@ public class OrdersApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Orders constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public OrdersApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Orders constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public OrdersApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java b/src/main/java/com/adyen/service/checkout/PaymentLinksApi.java
@@ -32,11 +32,21 @@ public class PaymentLinksApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Payment links constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public PaymentLinksApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Payment links constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public PaymentLinksApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/PaymentsApi.java b/src/main/java/com/adyen/service/checkout/PaymentsApi.java
@@ -42,11 +42,21 @@ public class PaymentsApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Payments constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public PaymentsApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Payments constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public PaymentsApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/RecurringApi.java b/src/main/java/com/adyen/service/checkout/RecurringApi.java
@@ -30,11 +30,21 @@ public class RecurringApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Recurring constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public RecurringApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Recurring constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public RecurringApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/src/main/java/com/adyen/service/checkout/UtilityApi.java b/src/main/java/com/adyen/service/checkout/UtilityApi.java
@@ -33,11 +33,21 @@ public class UtilityApi extends Service {
 
     protected String baseURL;
 
+    /**
+    * Utility constructor in {@link com.adyen.service.checkout package}.
+    * @param client {@link Client } (required)
+    */
     public UtilityApi(Client client) {
         super(client);
         this.baseURL = createBaseURL("https://checkout-test.adyen.com/v70");
     }
 
+    /**
+    * Utility constructor in {@link com.adyen.service.checkout package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public UtilityApi(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/templates/libraries/jersey3/api.mustache b/templates/libraries/jersey3/api.mustache
@@ -21,11 +21,21 @@ public class {{classname}} extends Service {
 
     protected String baseURL;
 
+    /**
+    * {{#operation}}{{#-first}}{{vendorExtensions.x-groupName}}{{/-first}}{{/operation}} constructor in {@link {{{package}}} package}.
+    * @param client {@link Client } (required)
+    */
     public {{classname}}(Client client) {
         super(client);
         this.baseURL = createBaseURL("{{{basePath}}}");
     }
 
+    /**
+    * {{#operation}}{{#-first}}{{vendorExtensions.x-groupName}}{{/-first}}{{/operation}} constructor in {@link {{{package}}} package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client } (required)
+    * @param baseURL {@link String } (required)
+    */
     public {{classname}}(Client client, String baseURL) {
         super(client);
         this.baseURL = baseURL;

diff --git a/templates/libraries/jersey3/api_single.mustache b/templates/libraries/jersey3/api_single.mustache
@@ -16,12 +16,30 @@ import java.util.Map;
 
 {{#operations}}
 public class {{smallServiceName}} extends Service {
+
+    public static final String API_VERSION = "{{{version}}}";
+
     protected String baseURL;
 
+    /**
+    * {{#operation}}{{#-first}}{{vendorExtensions.x-groupName}}{{/-first}}{{/operation}} constructor in {@link {{{package}}} package}.
+    * @param client {@link Client }  (required)
+    */
     public {{smallServiceName}}(Client client) {
         super(client);
         this.baseURL = createBaseURL("{{{basePath}}}");
     }
+
+    /**
+    * {{#operation}}{{#-first}}{{vendorExtensions.x-groupName}}{{/-first}}{{/operation}} constructor in {@link {{{package}}} package}.
+    * Please use this constructor only if you would like to pass along your own url for routing or testing purposes. The latest API version is defined in this class as a constant.
+    * @param client {@link Client }  (required)
+    * @param baseURL {@link String }  (required)
+    */
+    public {{smallServiceName}}(Client client, String baseURL) {
+        super(client);
+        this.baseURL = baseURL;
+    }
 {{#operation}}
 
 {{>api_summary_overload}}