Prosoft Git

killbill-uncached

jaxrs: more Swagger documentation Signed-off-by: Pierre-Alexandre …

10/17/2014 10:45:51 AM
Pierre-Alexandre Meyer

Pierre-Alexandre Meyer

Commit: 3ca3754

Tree: f81e6fb

Parents: 34dd46c

Changes

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java 1(+1 -0)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java 3(+2 -1)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java 2(+2 -0)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java 4(+2 -2)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java 2(+1 -1)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java 4(+4 -0)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java 3(+2 -1)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java 2(+2 -0)

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java 2(+2 -0)

jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java 2(+1 -1)

Details

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java 1(+1 -0) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java
index fe33420..5d91029 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/AccountEmailJson.java
@@ -29,6 +29,7 @@ public class AccountEmailJson extends JsonBase {
 
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String accountId;
+    @ApiModelProperty(required = true)
     private final String email;
 
     @JsonCreator

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java 3(+2 -1) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java
index b9484f6..5819a22 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CreditJson.java
@@ -32,12 +32,13 @@ import com.wordnik.swagger.annotations.ApiModelProperty;
 
 public class CreditJson extends JsonBase {
 
+    @ApiModelProperty(required = true)
     private final BigDecimal creditAmount;
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String invoiceId;
     private final String invoiceNumber;
     private final LocalDate effectiveDate;
-    @ApiModelProperty(dataType = "java.util.UUID")
+    @ApiModelProperty(dataType = "java.util.UUID", required = true)
     private final String accountId;
 
     @JsonCreator

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java 2(+2 -0) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java
index aed0fc9..9013d28 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/CustomFieldJson.java
@@ -35,7 +35,9 @@ public class CustomFieldJson extends JsonBase {
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String objectId;
     private final ObjectType objectType;
+    @ApiModelProperty(required = true)
     private final String name;
+    @ApiModelProperty(required = true)
     private final String value;
 
     @JsonCreator

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java 4(+2 -2) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java
index aabbd91..a476a22 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/InvoiceItemJson.java
@@ -35,13 +35,13 @@ import com.wordnik.swagger.annotations.ApiModelProperty;
 
 public class InvoiceItemJson extends JsonBase {
 
-    @ApiModelProperty(dataType = "java.util.UUID")
+    @ApiModelProperty(dataType = "java.util.UUID", required = true)
     private final String invoiceItemId;
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String invoiceId;
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String linkedInvoiceItemId;
-    @ApiModelProperty(dataType = "java.util.UUID")
+    @ApiModelProperty(dataType = "java.util.UUID", required = true)
     private final String accountId;
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String bundleId;

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java 2(+1 -1) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java
index 28489f2..82a40dd 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/PaymentTransactionJson.java
@@ -36,7 +36,7 @@ public class PaymentTransactionJson extends JsonBase {
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String transactionId;
     private final String transactionExternalKey;
-    @ApiModelProperty(dataType = "java.util.UUID")
+    @ApiModelProperty(value = "Associated payment id, required when notifying state transitions", dataType = "java.util.UUID")
     private final String paymentId;
     private final String paymentExternalKey;
     @ApiModelProperty(dataType = "org.killbill.billing.payment.api.TransactionType")

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java 4(+4 -0) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java
index 1c623a7..4296784 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionJson.java
@@ -45,9 +45,13 @@ public class SubscriptionJson extends JsonBase {
     private final String subscriptionId;
     private final String externalKey;
     private final LocalDate startDate;
+    @ApiModelProperty(required = true)
     private final String productName;
+    @ApiModelProperty(dataType = "org.killbill.billing.catalog.api.ProductCategory", required = true)
     private final String productCategory;
+    @ApiModelProperty(dataType = "org.killbill.billing.catalog.api.BillingPeriod", required = true)
     private final String billingPeriod;
+    @ApiModelProperty(required = true)
     private final String priceList;
     private final LocalDate cancelledDate;
     private final LocalDate chargedThroughDate;

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java 3(+2 -1) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java
index b5d4570..9e961a6 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/SubscriptionUsageRecordJson.java
@@ -34,8 +34,9 @@ import com.wordnik.swagger.annotations.ApiModelProperty;
 
 public class SubscriptionUsageRecordJson {
 
-    @ApiModelProperty(dataType = "java.util.UUID")
+    @ApiModelProperty(dataType = "java.util.UUID", required = true)
     private final String subscriptionId;
+    @ApiModelProperty(required = true)
     private final List<UnitUsageRecordJson> unitUsageRecords;
 
     @JsonCreator

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java 2(+2 -0) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java
index 0570780..fedac1c 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TagDefinitionJson.java
@@ -36,7 +36,9 @@ public class TagDefinitionJson extends JsonBase {
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String id;
     private final Boolean isControlTag;
+    @ApiModelProperty(required = true)
     private final String name;
+    @ApiModelProperty(required = true)
     private final String description;
     private final List<String> applicableObjectTypes;

jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java 2(+2 -0) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java
index f8c3a69..76fe844 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/json/TenantJson.java
@@ -28,7 +28,9 @@ public class TenantJson extends JsonBase {
     @ApiModelProperty(dataType = "java.util.UUID")
     private final String tenantId;
     private final String externalKey;
+    @ApiModelProperty(required = true)
     private final String apiKey;
+    @ApiModelProperty(required = true)
     private final String apiSecret;
 
     @JsonCreator

jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java 2(+1 -1) 

diff --git a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java
index f18eb15..9399f63 100644
--- a/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java
+++ b/jaxrs/src/main/java/org/killbill/billing/jaxrs/resources/InvoiceResource.java
@@ -345,7 +345,7 @@ public class InvoiceResource extends JaxRsResourceBase {
     @Produces(APPLICATION_JSON)
     @Consumes(APPLICATION_JSON)
     @Path("/" + CHARGES + "/{accountId:" + UUID_PATTERN + "}")
-    @ApiOperation(value = "Create external charge(s)",response = InvoiceItemJson.class, responseContainer = "List")
+    @ApiOperation(value = "Create external charge(s)", response = InvoiceItemJson.class, responseContainer = "List")
     @ApiResponses(value = {@ApiResponse(code = 400, message = "Invalid account id supplied"),
                            @ApiResponse(code = 404, message = "Account not found")})
     public Response createExternalCharges(final Iterable<InvoiceItemJson> externalChargesJson,

Bonobo Git Server (6.3.0.632) © 2015 Jakub Chodounský · Official Page · Github