Skip to content

Commit cc80b1d

Browse files
committed
[strimzi#434] Update generated documentation
Signed-off-by: ilkerkocatepe <[email protected]>
1 parent 4fdb8ce commit cc80b1d

File tree

2 files changed

+108
-1
lines changed

2 files changed

+108
-1
lines changed
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
e4a70d99cdac5e8dddb45ce30c39817fa9402463074478e0fd3a05d6a7f849d5
1+
88546893f4a6b52b04e3729153f4faea9356730c8facc0930093aa956530d184

documentation/book/api/index.adoc

+107
Original file line numberDiff line numberDiff line change
@@ -2289,6 +2289,113 @@ endif::internal-generation[]
22892289
=== Topics
22902290

22912291

2292+
[.createTopic]
2293+
==== createTopic
2294+
2295+
`POST /admin/topics/{topicname}`
2296+
2297+
2298+
2299+
===== Description
2300+
2301+
Creates a topic with given topic name.
2302+
2303+
2304+
// markup not found, no include::{specDir}admin/topics/\{topicname\}/POST/spec.adoc[opts=optional]
2305+
2306+
2307+
2308+
===== Parameters
2309+
2310+
2311+
[cols="2,3,1,1,1"]
2312+
.Path Parameters
2313+
|===
2314+
|Name| Description| Required| Default| Pattern
2315+
2316+
| topicname
2317+
| Name of the topic to send records to or retrieve metadata from.
2318+
| X
2319+
| null
2320+
|
2321+
2322+
|===
2323+
2324+
2325+
2326+
2327+
2328+
[cols="2,3,1,1,1"]
2329+
.Query Parameters
2330+
|===
2331+
|Name| Description| Required| Default| Pattern
2332+
2333+
| partitions
2334+
| Number of partitions for the topic.
2335+
| X
2336+
| null
2337+
|
2338+
2339+
| replication_factor
2340+
| Replication factor for the topic.
2341+
| X
2342+
| null
2343+
|
2344+
2345+
|===
2346+
2347+
2348+
===== Return Type
2349+
2350+
2351+
<<TopicMetadata>>
2352+
2353+
2354+
===== Content Type
2355+
2356+
* application/vnd.kafka.v2+json
2357+
2358+
===== Responses
2359+
2360+
.HTTP Response Codes
2361+
[cols="2,3,1"]
2362+
|===
2363+
| Code | Message | Datatype
2364+
2365+
2366+
| 200
2367+
| Topic metadata
2368+
| <<TopicMetadata>>
2369+
2370+
2371+
| 404
2372+
| The specified topic was not found.
2373+
| <<Error>>
2374+
2375+
|===
2376+
2377+
===== Samples
2378+
2379+
2380+
// markup not found, no include::{snippetDir}admin/topics/\{topicname\}/POST/http-request.adoc[opts=optional]
2381+
2382+
2383+
// markup not found, no include::{snippetDir}admin/topics/\{topicname\}/POST/http-response.adoc[opts=optional]
2384+
2385+
2386+
2387+
// file not found, no * wiremock data link :admin/topics/{topicname}/POST/POST.json[]
2388+
2389+
2390+
ifdef::internal-generation[]
2391+
===== Implementation
2392+
2393+
// markup not found, no include::{specDir}admin/topics/\{topicname\}/POST/implementation.adoc[opts=optional]
2394+
2395+
2396+
endif::internal-generation[]
2397+
2398+
22922399
[.getOffsets]
22932400
==== getOffsets
22942401

0 commit comments

Comments
 (0)