[strimzi#434] docs: edits after review & changelog

Signed-off-by: ilkerkocatepe <[email protected]>
ilkerkocatepe · Nov 19, 2024 · e591f0d · e591f0d
1 parent 11c8a7e
commit e591f0d
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 16 deletions.
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 @@
-444170efeb26c6a819d27e54c5571469b44678895d9090c6c09d0de6318bcf6d
+cf88d8909114896517ba4027596382126bca594d55dd9a924330232407e603b2
diff --git a/documentation/book/api/index.adoc b/documentation/book/api/index.adoc
@@ -2298,7 +2298,7 @@ endif::internal-generation[]
 
 ===== Description
 
-Creates a topic with given name, partitions count and replication factor.
+Creates a topic with given name, partitions count, and replication factor.
 
 
 // markup not found, no include::{specDir}admin/topics/POST/spec.adoc[opts=optional]
@@ -2315,7 +2315,7 @@ Creates a topic with given name, partitions count and replication factor.
 |Name| Description| Required| Default| Pattern
 
 | NewTopic
-| Creates a topic with given name, partitions count and replication factor. <<NewTopic>>
+| Creates a topic with given name, partitions count, and replication factor. <<NewTopic>>
 | X
 | 
 | 
@@ -2333,9 +2333,6 @@ Creates a topic with given name, partitions count and replication factor.
 
 -
 
-===== Content Type
-
-* application/vnd.kafka.v2+json
 
 ===== Responses
 

diff --git a/src/main/java/io/strimzi/kafka/bridge/http/HttpAdminBridgeEndpoint.java b/src/main/java/io/strimzi/kafka/bridge/http/HttpAdminBridgeEndpoint.java
@@ -180,7 +180,7 @@ public void doGetTopic(RoutingContext routingContext) {
     }
 
     /**
-     * Create a topic with described name, partitions count and replication factor in the body of the HTTP request
+     * Create a topic with described name, partitions count, and replication factor in the body of the HTTP request
      *
      * @param routingContext the routing context
      */

diff --git a/src/main/resources/openapi.json b/src/main/resources/openapi.json
@@ -758,10 +758,10 @@
                 "tags": [
                     "Topics"
                 ],
-                "description": "Creates a topic with given name, partitions count and replication factor.",
+                "description": "Creates a topic with given name, partitions count, and replication factor.",
                 "operationId": "createTopic",
                 "requestBody": {
-                    "description": "Creates a topic with given name, partitions count and replication factor.",
+                    "description": "Creates a topic with given name, partitions count, and replication factor.",
                     "content": {
                         "application/vnd.kafka.json.v2+json": {
                             "schema": {
@@ -773,10 +773,7 @@
                 },
                 "responses": {
                     "201": {
-                        "description": "Created",
-                        "content": {
-                            "application/vnd.kafka.v2+json": {}
-                        }
+                        "description": "Created"
                     }
                 }
             }

diff --git a/src/main/resources/openapiv2.json b/src/main/resources/openapiv2.json
@@ -691,7 +691,7 @@
         "tags": [
           "Topics"
         ],
-        "description": "Creates a topic with given name, partitions count and replication factor.",
+        "description": "Creates a topic with given name, partitions count, and replication factor.",
         "operationId": "createTopic",
         "consumes": [
           "application/vnd.kafka.v2+json"
@@ -711,8 +711,7 @@
         ],
         "responses": {
           "201": {
-            "description": "Created",
-            "schema": {}
+            "description": "Created"
           }
         }
       }
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		444170efeb26c6a819d27e54c5571469b44678895d9090c6c09d0de6318bcf6d
		cf88d8909114896517ba4027596382126bca594d55dd9a924330232407e603b2
-Original file line number
+Diff line change
@@ Expand Up / @@ -180,7 +180,7 @@ public void doGetTopic(RoutingContext routingContext) { @@
         }
         /**
-         * Create a topic with described name, partitions count and replication factor in the body of the HTTP request
+         * Create a topic with described name, partitions count, and replication factor in the body of the HTTP request
          *
          * @param routingContext the routing context
          */
@@ Expand Down @@