chore(example): use maxLength and maximum value (#879)

Better demonstrate the capabilities of the swagger Schema annotation
springwolf · Aug 16, 2024 · 0600e69 · 0600e69
1 parent 8d299ef
commit 0600e69
Show file tree

Hide file tree

Showing 23 changed files with 44 additions and 16 deletions.
diff --git a/...amqp-example/src/main/java/io/github/springwolf/examples/amqp/dtos/AnotherPayloadDto.java b/...amqp-example/src/main/java/io/github/springwolf/examples/amqp/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...amqp-example/src/main/java/io/github/springwolf/examples/amqp/dtos/ExamplePayloadDto.java b/...amqp-example/src/main/java/io/github/springwolf/examples/amqp/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-amqp-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-amqp-example/src/test/resources/asyncapi.json
@@ -148,6 +148,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -188,6 +189,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]

diff --git a/...ample/src/main/java/io/github/springwolf/examples/cloudstream/dtos/AnotherPayloadDto.java b/...ample/src/main/java/io/github/springwolf/examples/cloudstream/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...ample/src/main/java/io/github/springwolf/examples/cloudstream/dtos/ExamplePayloadDto.java b/...ample/src/main/java/io/github/springwolf/examples/cloudstream/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/.../src/main/java/io/github/springwolf/examples/cloudstream/dtos/GooglePubSubPayloadDto.java b/.../src/main/java/io/github/springwolf/examples/cloudstream/dtos/GooglePubSubPayloadDto.java
@@ -16,6 +16,6 @@ public class GooglePubSubPayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 }
diff --git a/springwolf-examples/springwolf-cloud-stream-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-cloud-stream-example/src/test/resources/asyncapi.json
@@ -97,6 +97,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -137,6 +138,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]
@@ -170,6 +172,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]

diff --git a/...f-jms-example/src/main/java/io/github/springwolf/examples/jms/dtos/AnotherPayloadDto.java b/...f-jms-example/src/main/java/io/github/springwolf/examples/jms/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...f-jms-example/src/main/java/io/github/springwolf/examples/jms/dtos/ExamplePayloadDto.java b/...f-jms-example/src/main/java/io/github/springwolf/examples/jms/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-jms-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-jms-example/src/test/resources/asyncapi.json
@@ -64,6 +64,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -104,6 +105,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]

diff --git a/...fka-example/src/main/java/io/github/springwolf/examples/kafka/dtos/AnotherPayloadDto.java b/...fka-example/src/main/java/io/github/springwolf/examples/kafka/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...fka-example/src/main/java/io/github/springwolf/examples/kafka/dtos/ExamplePayloadDto.java b/...fka-example/src/main/java/io/github/springwolf/examples/kafka/dtos/ExamplePayloadDto.java
@@ -38,7 +38,7 @@ public class ExamplePayloadDto {
             requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.json
@@ -910,6 +910,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -948,6 +949,7 @@
                 "someLong": {
                   "description": "Some long field",
                   "format": "int64",
+                  "minimum": 0,
                   "type": "integer"
                 },
                 "someString": {
@@ -964,6 +966,7 @@
             },
             "foo": {
               "description": "Foo field",
+              "maxLength": 100,
               "type": "string"
             }
           },
@@ -994,6 +997,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]
@@ -1034,6 +1038,7 @@
             "someLong": {
               "description": "Some long field",
               "format": "int64",
+              "minimum": 0,
               "type": "integer"
             },
             "someString": {
@@ -1106,6 +1111,7 @@
                   "someLong": {
                     "description": "Some long field",
                     "format": "int64",
+                    "minimum": 0,
                     "type": "integer"
                   },
                   "someString": {
@@ -1968,4 +1974,4 @@
       ]
     }
   }
-}
+}
diff --git a/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.yaml b/springwolf-examples/springwolf-kafka-example/src/test/resources/asyncapi.yaml
@@ -611,6 +611,7 @@ components:
         foo:
           type: string
           description: Foo field
+          maxLength: 100
           examples:
             - bar
       description: Another payload model
@@ -641,6 +642,7 @@ components:
               someLong:
                 description: Some long field
                 format: int64
+                minimum: 0
                 type: integer
               someString:
                 description: |
@@ -664,6 +666,7 @@ components:
             type: object
           foo:
             description: Foo field
+            maxLength: 100
             type: string
         required:
           - example
@@ -686,6 +689,7 @@ components:
           type: integer
           description: Some long field
           format: int64
+          minimum: 0
           examples:
             - 5
         someString:
@@ -731,6 +735,7 @@ components:
           someLong:
             description: Some long field
             format: int64
+            minimum: 0
             type: integer
           someString:
             description: |
@@ -796,6 +801,7 @@ components:
                 someLong:
                   description: Some long field
                   format: int64
+                  minimum: 0
                   type: integer
                 someString:
                   description: |

diff --git a/...f-sns-example/src/main/java/io/github/springwolf/examples/sns/dtos/AnotherPayloadDto.java b/...f-sns-example/src/main/java/io/github/springwolf/examples/sns/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...f-sns-example/src/main/java/io/github/springwolf/examples/sns/dtos/ExamplePayloadDto.java b/...f-sns-example/src/main/java/io/github/springwolf/examples/sns/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-sns-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-sns-example/src/test/resources/asyncapi.json
@@ -64,6 +64,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -102,6 +103,7 @@
                 "someLong": {
                   "description": "Some long field",
                   "format": "int64",
+                  "minimum": 0,
                   "type": "integer"
                 },
                 "someString": {
@@ -118,6 +120,7 @@
             },
             "foo": {
               "description": "Foo field",
+              "maxLength": 100,
               "type": "string"
             }
           },
@@ -148,6 +151,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]
@@ -188,6 +192,7 @@
             "someLong": {
               "description": "Some long field",
               "format": "int64",
+              "minimum": 0,
               "type": "integer"
             },
             "someString": {

diff --git a/...f-sqs-example/src/main/java/io/github/springwolf/examples/sqs/dtos/AnotherPayloadDto.java b/...f-sqs-example/src/main/java/io/github/springwolf/examples/sqs/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...f-sqs-example/src/main/java/io/github/springwolf/examples/sqs/dtos/ExamplePayloadDto.java b/...f-sqs-example/src/main/java/io/github/springwolf/examples/sqs/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-sqs-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-sqs-example/src/test/resources/asyncapi.json
@@ -72,6 +72,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -112,6 +113,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]

diff --git a/...ample/src/main/java/io/github/springwolf/examples/stomp/stomp/dtos/AnotherPayloadDto.java b/...ample/src/main/java/io/github/springwolf/examples/stomp/stomp/dtos/AnotherPayloadDto.java
@@ -15,7 +15,7 @@
 @NoArgsConstructor
 public class AnotherPayloadDto {
 
-    @Schema(description = "Foo field", example = "bar", requiredMode = NOT_REQUIRED)
+    @Schema(description = "Foo field", example = "bar", maxLength = 100, requiredMode = NOT_REQUIRED)
     private String foo;
 
     @Schema(description = "Example field", requiredMode = REQUIRED)

diff --git a/...ample/src/main/java/io/github/springwolf/examples/stomp/stomp/dtos/ExamplePayloadDto.java b/...ample/src/main/java/io/github/springwolf/examples/stomp/stomp/dtos/ExamplePayloadDto.java
@@ -16,7 +16,7 @@ public class ExamplePayloadDto {
     @Schema(description = "Some string field", example = "some string value", requiredMode = REQUIRED)
     private String someString;
 
-    @Schema(description = "Some long field", example = "5")
+    @Schema(description = "Some long field", example = "5", minimum = "0")
     private long someLong;
 
     @Schema(description = "Some enum field", example = "FOO2", requiredMode = REQUIRED)

diff --git a/springwolf-examples/springwolf-stomp-example/src/test/resources/asyncapi.json b/springwolf-examples/springwolf-stomp-example/src/test/resources/asyncapi.json
@@ -113,6 +113,7 @@
           "foo": {
             "type": "string",
             "description": "Foo field",
+            "maxLength": 100,
             "examples": [
               "bar"
             ]
@@ -153,6 +154,7 @@
             "type": "integer",
             "description": "Some long field",
             "format": "int64",
+            "minimum": 0,
             "examples": [
               5
             ]