[strimzi#434] fix: after review - partitions and replication_factor parameters set optional

ilkerkocatepe · ilkerkocatepe · commit 4fa81ca37b3e · 2024-11-19T19:22:41.000+03:00
Signed-off-by: ilkerkocatepe &lt;kocatepeilker@gmail.com&gt;
diff --git a/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256 b/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256
@@ -1 +1 @@
-88546893f4a6b52b04e3729153f4faea9356730c8facc0930093aa956530d184
+bf9a3ec3619b7fe86b6473ec93bb17c589dff7935eacd41636ea071274110d55
diff --git a/documentation/book/api/index.adoc b/documentation/book/api/index.adoc
@@ -2314,7 +2314,7 @@ Creates a topic with given topic name.
 |Name| Description| Required| Default| Pattern
 
 | topicname
-| Name of the topic to send records to or retrieve metadata from. 
+| Name of the topic will be created. 
 | X
 | null
 | 
@@ -2331,14 +2331,14 @@ Creates a topic with given topic name.
 |Name| Description| Required| Default| Pattern
 
 | partitions
-| Number of partitions for the topic. 
-| X
+| Number of partitions for the topic. (Optional) 
+| -
 | null
 | 
 
 | replication_factor
-| Replication factor for the topic. 
-| X
+| Replication factor for the topic. (Optional) 
+| -
 | null
 | 
 
@@ -2369,7 +2369,7 @@ Creates a topic with given topic name.
 
 
 | 404
-| The specified topic was not found.
+| The path was not found.
 |  <<Error>>
 
 |===
@@ -2645,7 +2645,7 @@ Retrieves the metadata about a given topic.
 
 
 | 404
-| The specified topic was not found.
+| The path topic was not found.
 |  <<Error>>
 
 |===
diff --git a/src/main/java/io/strimzi/kafka/bridge/KafkaBridgeAdmin.java b/src/main/java/io/strimzi/kafka/bridge/KafkaBridgeAdmin.java
@@ -17,11 +17,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
-import java.util.Collections;
-import java.util.List;
-import java.util.Map;
-import java.util.Properties;
-import java.util.Set;
+import java.util.*;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 
@@ -94,7 +90,7 @@ public CompletionStage<Set<String>> listTopics() {
      * @param replicationFactor replication factor
      * @return a CompletionStage Void
      */
-    public CompletionStage<Void> createTopic(String topicName, int partitions, short replicationFactor) {
+    public CompletionStage<Void> createTopic(String topicName, Optional<Integer> partitions, Optional<Short> replicationFactor) {
         LOGGER.trace("Create topic thread {}", Thread.currentThread());
         LOGGER.info("Create topic {}, partitions {}, replicationFactor {}", topicName, partitions, replicationFactor);
         CompletableFuture<Void> promise = new CompletableFuture<>();
diff --git a/src/main/java/io/strimzi/kafka/bridge/http/HttpAdminBridgeEndpoint.java b/src/main/java/io/strimzi/kafka/bridge/http/HttpAdminBridgeEndpoint.java
@@ -28,11 +28,7 @@
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 
-import java.util.Collection;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
 import java.util.concurrent.CompletableFuture;
 import java.util.concurrent.CompletionStage;
 
@@ -184,8 +180,10 @@ public void doGetTopic(RoutingContext routingContext) {
      */
     public void doCreateTopic(RoutingContext routingContext) {
         String topicName = routingContext.pathParam("topicname");
-        int partitions = Integer.parseInt(routingContext.queryParams().get("partitions"));
-        short replicationFactor = Short.parseShort(routingContext.queryParams().get("replication_factor"));
+        Optional<Integer> partitions = Optional.ofNullable(routingContext.queryParams().get("partitions"))
+                .map(Integer::valueOf);
+        Optional<Short> replicationFactor = Optional.ofNullable(routingContext.queryParams().get("replication_factor"))
+                .map(Short::valueOf);
 
         this.kafkaBridgeAdmin.createTopic(topicName, partitions, replicationFactor)
                 .whenComplete(((topic, exception) -> {
diff --git a/src/main/resources/openapi.json b/src/main/resources/openapi.json
@@ -615,7 +615,7 @@
                         }
                     },
                     "404": {
-                        "description": "The specified topic was not found.",
+                        "description": "The path topic was not found.",
                         "content": {
                             "application/vnd.kafka.v2+json": {
                                 "schema": {
@@ -772,7 +772,7 @@
                         }
                     },
                     "404": {
-                        "description": "The specified topic was not found.",
+                        "description": "The path was not found.",
                         "content": {
                             "application/vnd.kafka.v2+json": {
                                 "schema": {
@@ -782,7 +782,7 @@
                                     "response": {
                                         "value": {
                                             "error_code": 404,
-                                            "message": "The specified topic was not found."
+                                            "message": "The path was not found."
                                         }
                                     }
                                 }
@@ -795,7 +795,7 @@
                 {
                     "name": "topicname",
                     "in": "path",
-                    "description": "Name of the topic to send records to or retrieve metadata from.",
+                    "description": "Name of the topic will be created.",
                     "required": true,
                     "schema": {
                         "type": "string"
@@ -804,17 +804,17 @@
                 {
                     "name": "partitions",
                     "in": "query",
-                    "description": "Number of partitions for the topic.",
-                    "required": true,
+                    "description": "Number of partitions for the topic. (Optional)",
+                    "required": false,
                     "schema": {
                         "type": "integer"
                     }
                 },
                 {
                     "name": "replication_factor",
                     "in": "query",
-                    "description": "Replication factor for the topic.",
-                    "required": true,
+                    "description": "Replication factor for the topic. (Optional)",
+                    "required": false,
                     "schema": {
                         "type": "integer"
                     }
diff --git a/src/main/resources/openapiv2.json b/src/main/resources/openapiv2.json
@@ -701,15 +701,15 @@
             }
           },
           "404": {
-            "description": "The specified topic was not found.",
+            "description": "The path was not found.",
             "schema": {
               "$ref": "#/definitions/Error"
             },
             "examples": {
               "response": {
                 "value": {
                   "error_code": 404,
-                  "message": "The specified topic was not found."
+                  "message": "The path was not found."
                 }
               }
             }
@@ -720,7 +720,7 @@
         {
           "name": "topicname",
           "in": "path",
-          "description": "Name of the topic to send records to or retrieve metadata from.",
+          "description": "Name of the topic will be created.",
           "required": true,
           "schema": {
             "type": "string"
@@ -729,17 +729,17 @@
         {
           "name": "partitions",
           "in": "query",
-          "description": "Number of partitions for the topic.",
-          "required": true,
+          "description": "Number of partitions for the topic. (Optional)",
+          "required": false,
           "schema": {
             "type": "integer"
           }
         },
         {
           "name": "replication_factor",
           "in": "query",
-          "description": "Replication factor for the topic.",
-          "required": true,
+          "description": "Replication factor for the topic. (Optional)",
+          "required": false,
           "schema": {
             "type": "integer"
           }
diff --git a/src/test/java/io/strimzi/kafka/bridge/http/AdminClientIT.java b/src/test/java/io/strimzi/kafka/bridge/http/AdminClientIT.java
@@ -218,6 +218,7 @@ void setupTopic(VertxTestContext context, String topic, int partitions, int coun
 
     @Test
     void createTopicTest(VertxTestContext context) {
+        // create topic test with 1 partition and 1 replication factor
         baseService()
                 .postRequest("/admin/topics/" + topic)
                 .addQueryParam("partitions", "1")
@@ -231,5 +232,18 @@ void createTopicTest(VertxTestContext context) {
                     });
                     context.completeNow();
                 });
+
+        // create topic test without partitions and replication factor
+        baseService()
+                .postRequest("/admin/topics/" + topic)
+                .as(BodyCodec.jsonArray())
+                .send(ar -> {
+                    context.verify(() -> {
+                        assertThat(ar.succeeded(), is(true));
+                        HttpResponse<JsonArray> response = ar.result();
+                        assertThat(response.statusCode(), is(HttpResponseStatus.OK.code()));
+                    });
+                    context.completeNow();
+                });
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-88546893f4a6b52b04e3729153f4faea9356730c8facc0930093aa956530d184`
	`1`	`+bf9a3ec3619b7fe86b6473ec93bb17c589dff7935eacd41636ea071274110d55`
Original file line number	Diff line number	Diff line change
`@@ -615,7 +615,7 @@`
`615`	`615`	`}`
`616`	`616`	`},`
`617`	`617`	`"404": {`
`618`		`- "description": "The specified topic was not found.",`
	`618`	`+ "description": "The path topic was not found.",`
`619`	`619`	`"content": {`
`620`	`620`	`"application/vnd.kafka.v2+json": {`
`621`	`621`	`"schema": {`
`@@ -772,7 +772,7 @@`
`772`	`772`	`}`
`773`	`773`	`},`
`774`	`774`	`"404": {`
`775`		`- "description": "The specified topic was not found.",`
	`775`	`+ "description": "The path was not found.",`
`776`	`776`	`"content": {`
`777`	`777`	`"application/vnd.kafka.v2+json": {`
`778`	`778`	`"schema": {`
`@@ -782,7 +782,7 @@`
`782`	`782`	`"response": {`
`783`	`783`	`"value": {`
`784`	`784`	`"error_code": 404,`
`785`		`- "message": "The specified topic was not found."`
	`785`	`+ "message": "The path was not found."`
`786`	`786`	`}`
`787`	`787`	`}`
`788`	`788`	`}`
`@@ -795,7 +795,7 @@`
`795`	`795`	`{`
`796`	`796`	`"name": "topicname",`
`797`	`797`	`"in": "path",`
`798`		`- "description": "Name of the topic to send records to or retrieve metadata from.",`
	`798`	`+ "description": "Name of the topic will be created.",`
`799`	`799`	`"required": true,`
`800`	`800`	`"schema": {`
`801`	`801`	`"type": "string"`
`@@ -804,17 +804,17 @@`
`804`	`804`	`{`
`805`	`805`	`"name": "partitions",`
`806`	`806`	`"in": "query",`
`807`		`- "description": "Number of partitions for the topic.",`
`808`		`- "required": true,`
	`807`	`+ "description": "Number of partitions for the topic. (Optional)",`
	`808`	`+ "required": false,`
`809`	`809`	`"schema": {`
`810`	`810`	`"type": "integer"`
`811`	`811`	`}`
`812`	`812`	`},`
`813`	`813`	`{`
`814`	`814`	`"name": "replication_factor",`
`815`	`815`	`"in": "query",`
`816`		`- "description": "Replication factor for the topic.",`
`817`		`- "required": true,`
	`816`	`+ "description": "Replication factor for the topic. (Optional)",`
	`817`	`+ "required": false,`
`818`	`818`	`"schema": {`
`819`	`819`	`"type": "integer"`
`820`	`820`	`}`
Original file line number	Diff line number	Diff line change
`@@ -701,15 +701,15 @@`
`701`	`701`	`}`
`702`	`702`	`},`
`703`	`703`	`"404": {`
`704`		`- "description": "The specified topic was not found.",`
	`704`	`+ "description": "The path was not found.",`
`705`	`705`	`"schema": {`
`706`	`706`	`"$ref": "#/definitions/Error"`
`707`	`707`	`},`
`708`	`708`	`"examples": {`
`709`	`709`	`"response": {`
`710`	`710`	`"value": {`
`711`	`711`	`"error_code": 404,`
`712`		`- "message": "The specified topic was not found."`
	`712`	`+ "message": "The path was not found."`
`713`	`713`	`}`
`714`	`714`	`}`
`715`	`715`	`}`
`@@ -720,7 +720,7 @@`
`720`	`720`	`{`
`721`	`721`	`"name": "topicname",`
`722`	`722`	`"in": "path",`
`723`		`- "description": "Name of the topic to send records to or retrieve metadata from.",`
	`723`	`+ "description": "Name of the topic will be created.",`
`724`	`724`	`"required": true,`
`725`	`725`	`"schema": {`
`726`	`726`	`"type": "string"`
`@@ -729,17 +729,17 @@`
`729`	`729`	`{`
`730`	`730`	`"name": "partitions",`
`731`	`731`	`"in": "query",`
`732`		`- "description": "Number of partitions for the topic.",`
`733`		`- "required": true,`
	`732`	`+ "description": "Number of partitions for the topic. (Optional)",`
	`733`	`+ "required": false,`
`734`	`734`	`"schema": {`
`735`	`735`	`"type": "integer"`
`736`	`736`	`}`
`737`	`737`	`},`
`738`	`738`	`{`
`739`	`739`	`"name": "replication_factor",`
`740`	`740`	`"in": "query",`
`741`		`- "description": "Replication factor for the topic.",`
`742`		`- "required": true,`
	`741`	`+ "description": "Replication factor for the topic. (Optional)",`
	`742`	`+ "required": false,`
`743`	`743`	`"schema": {`
`744`	`744`	`"type": "integer"`
`745`	`745`	`}`