Skip to content

Commit 51c1e0c

Browse files
committed
[strimzi#434] docs: edits after review & changelog
Signed-off-by: ilkerkocatepe <[email protected]>
1 parent faeb691 commit 51c1e0c

File tree

6 files changed

+10
-16
lines changed

6 files changed

+10
-16
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
## 0.31.0
44

55
* Dependency updates (Vert.x 4.5.10)
6+
* Added support for creating a new topic via endpoint.
67

78
## 0.30.0
89

Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
444170efeb26c6a819d27e54c5571469b44678895d9090c6c09d0de6318bcf6d
1+
cf88d8909114896517ba4027596382126bca594d55dd9a924330232407e603b2

documentation/book/api/index.adoc

+2-5
Original file line numberDiff line numberDiff line change
@@ -2298,7 +2298,7 @@ endif::internal-generation[]
22982298

22992299
===== Description
23002300

2301-
Creates a topic with given name, partitions count and replication factor.
2301+
Creates a topic with given name, partitions count, and replication factor.
23022302

23032303

23042304
// 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.
23152315
|Name| Description| Required| Default| Pattern
23162316

23172317
| NewTopic
2318-
| Creates a topic with given name, partitions count and replication factor. <<NewTopic>>
2318+
| Creates a topic with given name, partitions count, and replication factor. <<NewTopic>>
23192319
| X
23202320
|
23212321
|
@@ -2333,9 +2333,6 @@ Creates a topic with given name, partitions count and replication factor.
23332333

23342334
-
23352335

2336-
===== Content Type
2337-
2338-
* application/vnd.kafka.v2+json
23392336

23402337
===== Responses
23412338

src/main/java/io/strimzi/kafka/bridge/http/HttpAdminBridgeEndpoint.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ public void doGetTopic(RoutingContext routingContext) {
180180
}
181181

182182
/**
183-
* Create a topic with described name, partitions count and replication factor in the body of the HTTP request
183+
* Create a topic with described name, partitions count, and replication factor in the body of the HTTP request
184184
*
185185
* @param routingContext the routing context
186186
*/

src/main/resources/openapi.json

+3-6
Original file line numberDiff line numberDiff line change
@@ -758,10 +758,10 @@
758758
"tags": [
759759
"Topics"
760760
],
761-
"description": "Creates a topic with given name, partitions count and replication factor.",
761+
"description": "Creates a topic with given name, partitions count, and replication factor.",
762762
"operationId": "createTopic",
763763
"requestBody": {
764-
"description": "Creates a topic with given name, partitions count and replication factor.",
764+
"description": "Creates a topic with given name, partitions count, and replication factor.",
765765
"content": {
766766
"application/vnd.kafka.json.v2+json": {
767767
"schema": {
@@ -773,10 +773,7 @@
773773
},
774774
"responses": {
775775
"201": {
776-
"description": "Created",
777-
"content": {
778-
"application/vnd.kafka.v2+json": {}
779-
}
776+
"description": "Created"
780777
}
781778
}
782779
}

src/main/resources/openapiv2.json

+2-3
Original file line numberDiff line numberDiff line change
@@ -691,7 +691,7 @@
691691
"tags": [
692692
"Topics"
693693
],
694-
"description": "Creates a topic with given name, partitions count and replication factor.",
694+
"description": "Creates a topic with given name, partitions count, and replication factor.",
695695
"operationId": "createTopic",
696696
"consumes": [
697697
"application/vnd.kafka.v2+json"
@@ -711,8 +711,7 @@
711711
],
712712
"responses": {
713713
"201": {
714-
"description": "Created",
715-
"schema": {}
714+
"description": "Created"
716715
}
717716
}
718717
}

0 commit comments

Comments
 (0)