From d50cb87e5444c07696998ce4dd65bf1b03fa27e2 Mon Sep 17 00:00:00 2001 From: ilkerkocatepe Date: Sat, 5 Oct 2024 11:31:37 +0300 Subject: [PATCH] [#434] Update generated documentation Signed-off-by: ilkerkocatepe --- .../openapi.json-generate-apidoc.sha256 | 2 +- documentation/book/api/index.adoc | 107 ++++++++++++++++++ 2 files changed, 108 insertions(+), 1 deletion(-) diff --git a/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256 b/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256 index ec32758c..8af8177f 100644 --- a/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256 +++ b/documentation/book/api/.openapi-generator/openapi.json-generate-apidoc.sha256 @@ -1 +1 @@ -e4a70d99cdac5e8dddb45ce30c39817fa9402463074478e0fd3a05d6a7f849d5 \ No newline at end of file +88546893f4a6b52b04e3729153f4faea9356730c8facc0930093aa956530d184 \ No newline at end of file diff --git a/documentation/book/api/index.adoc b/documentation/book/api/index.adoc index 8f053f1c..609d4ccd 100644 --- a/documentation/book/api/index.adoc +++ b/documentation/book/api/index.adoc @@ -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 + + +<> + + +===== Content Type + +* application/vnd.kafka.v2+json + +===== Responses + +.HTTP Response Codes +[cols="2,3,1"] +|=== +| Code | Message | Datatype + + +| 200 +| Topic metadata +| <> + + +| 404 +| The specified topic was not found. +| <> + +|=== + +===== 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