PP-4862 Fix API specs for paymentId, providerId

- paymentId, providerId are currently generated as-is as @JsonPropery/@ApiModelProperty doesn't name the fields explicitly.
alphagov · Feb 26, 2019 · 4ae5f8a · 4ae5f8a
1 parent 062a60b
commit 4ae5f8a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/src/main/java/uk/gov/pay/api/model/CreatePaymentResult.java b/src/main/java/uk/gov/pay/api/model/CreatePaymentResult.java
@@ -35,7 +35,7 @@ public class CreatePaymentResult {
     private SupportedLanguage language;
 
     @JsonProperty
-    @ApiModelProperty(example = "hu20sqlact5260q2nanm0q8u93")
+    @ApiModelProperty(name = "payment_id", example = "hu20sqlact5260q2nanm0q8u93")
     private String paymentId;
 
     @JsonProperty
@@ -65,6 +65,6 @@ public class CreatePaymentResult {
     private PaymentLinks links;
 
     @JsonProperty
-    @ApiModelProperty(example = "null")
+    @ApiModelProperty(name = "provider_id", example = "null")
     private String providerId;
 }
diff --git a/swagger/swagger.json b/swagger/swagger.json
@@ -743,7 +743,7 @@
           "example" : "en",
           "enum" : [ "ENGLISH", "WELSH" ]
         },
-        "paymentId" : {
+        "payment_id" : {
           "type" : "string",
           "example" : "hu20sqlact5260q2nanm0q8u93"
         },
@@ -765,6 +765,10 @@
         "_links" : {
           "$ref" : "#/definitions/PaymentLinks"
         },
+        "provider_id" : {
+          "type" : "string",
+          "example" : "null"
+        },
         "refund_summary" : {
           "$ref" : "#/definitions/RefundSummary"
         },
@@ -878,6 +882,7 @@
         },
         "provider_id" : {
           "type" : "string",
+          "example" : "reference-from-payment-gateway",
           "readOnly" : true
         },
         "_links" : {
@@ -987,6 +992,7 @@
         },
         "provider_id" : {
           "type" : "string",
+          "example" : "reference-from-payment-gateway",
           "readOnly" : true
         },
         "_links" : {