Skip to content

Commit

Permalink
[strimzi#434] Update generated documentation
Browse files Browse the repository at this point in the history
Signed-off-by: ilkerkocatepe <[email protected]>
  • Loading branch information
ilkerkocatepe committed Oct 5, 2024
1 parent 4fdb8ce commit cc80b1d
Show file tree
Hide file tree
Showing 2 changed files with 108 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -1 +1 @@
e4a70d99cdac5e8dddb45ce30c39817fa9402463074478e0fd3a05d6a7f849d5
88546893f4a6b52b04e3729153f4faea9356730c8facc0930093aa956530d184
107 changes: 107 additions & 0 deletions documentation/book/api/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2289,6 +2289,113 @@ endif::internal-generation[]
=== Topics


[.createTopic]
==== createTopic

`POST /admin/topics/{topicname}`



===== Description

Creates a topic with given topic name.


// markup not found, no include::{specDir}admin/topics/\{topicname\}/POST/spec.adoc[opts=optional]



===== Parameters


[cols="2,3,1,1,1"]
.Path Parameters
|===
|Name| Description| Required| Default| Pattern

| topicname
| Name of the topic to send records to or retrieve metadata from.
| X
| null
|

|===





[cols="2,3,1,1,1"]
.Query Parameters
|===
|Name| Description| Required| Default| Pattern

| partitions
| Number of partitions for the topic.
| X
| null
|

| replication_factor
| Replication factor for the topic.
| X
| null
|

|===


===== Return Type


<<TopicMetadata>>


===== Content Type

* application/vnd.kafka.v2+json

===== Responses

.HTTP Response Codes
[cols="2,3,1"]
|===
| Code | Message | Datatype


| 200
| Topic metadata
| <<TopicMetadata>>


| 404
| The specified topic was not found.
| <<Error>>

|===

===== Samples


// markup not found, no include::{snippetDir}admin/topics/\{topicname\}/POST/http-request.adoc[opts=optional]


// markup not found, no include::{snippetDir}admin/topics/\{topicname\}/POST/http-response.adoc[opts=optional]



// file not found, no * wiremock data link :admin/topics/{topicname}/POST/POST.json[]


ifdef::internal-generation[]
===== Implementation

// markup not found, no include::{specDir}admin/topics/\{topicname\}/POST/implementation.adoc[opts=optional]


endif::internal-generation[]


[.getOffsets]
==== getOffsets

Expand Down

0 comments on commit cc80b1d

Please sign in to comment.