Update Kafka Bridge documentation (Commit )

Signed-off-by: Strimzi CI <[email protected]>
strimzi · Jan 11, 2025 · aa980ed · aa980ed
1 parent 2a7f2cf
commit aa980ed
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 21 deletions.
diff --git a/docs/bridge/in-development/bridge.html b/docs/bridge/in-development/bridge.html
@@ -226,7 +226,7 @@ <h3 id="overview-open-api-spec-kafka-bridge-bridge"><a class="link" href="#overv
 The download files are available from the <a href="https://github.com/strimzi/strimzi-kafka-bridge/releases" target="_blank" rel="noopener">GitHub release page</a>.</p>
 </div>
 <div class="paragraph">
-<p>You can also use the <a href="#openapi"><code>GET /openapi</code> method</a> to retrieve the OpenAPI v2 specification in JSON format.</p>
+<p>You can also use the <a href="#openapi"><code>GET /openapi</code> method</a> to retrieve the OpenAPI v3 specification in JSON format.</p>
 </div>
 <div class="ulist _additional-resources">
 <div class="title">Additional resources</div>
@@ -4046,7 +4046,7 @@ <h5 id="openapi"><a class="link" href="#openapi">openapi</a></h5>
 <div class="sect5">
 <h6 id="description_15"><a class="link" href="#description_15">Description</a></h6>
 <div class="paragraph">
-<p>Retrieves the OpenAPI v2 specification in JSON format.</p>
+<p>Retrieves the OpenAPI v3 specification in JSON format.</p>
 </div>
 </div>
 <div class="sect5">
@@ -4088,7 +4088,7 @@ <h6 id="responses_15"><a class="link" href="#responses_15">Responses</a></h6>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 specification in JSON format retrieved successfully.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v3 specification in JSON format retrieved successfully.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#String">[String]</a></p></td>
 </tr>
 </tbody>
@@ -4107,7 +4107,7 @@ <h5 id="openapiv2"><a class="link" href="#openapiv2">openapiv2</a></h5>
 <div class="sect5">
 <h6 id="description_16"><a class="link" href="#description_16">Description</a></h6>
 <div class="paragraph">
-<p>Retrieves the OpenAPI v2 specification in JSON format.</p>
+<p>OpenAPI v2 Swagger not supported.</p>
 </div>
 </div>
 <div class="sect5">
@@ -4117,15 +4117,15 @@ <h6 id="parameters_16"><a class="link" href="#parameters_16">Parameters</a></h6>
 <div class="sect5">
 <h6 id="return_type_16"><a class="link" href="#return_type_16">Return Type</a></h6>
 <div class="paragraph">
-<p><a href="#String">[String]</a></p>
+<p>-</p>
 </div>
 </div>
 <div class="sect5">
 <h6 id="content_type_15"><a class="link" href="#content_type_15">Content Type</a></h6>
 <div class="ulist">
 <ul>
 <li>
-<p>application/json</p>
+<p>application/vnd.kafka.v2+json</p>
 </li>
 </ul>
 </div>
@@ -4148,9 +4148,9 @@ <h6 id="responses_16"><a class="link" href="#responses_16">Responses</a></h6>
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 specification in JSON format retrieved successfully.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#String">[String]</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">410</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 Swagger not supported.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#Error"><em>Error</em> Error</a></p></td>
 </tr>
 </tbody>
 </table>
@@ -7516,7 +7516,7 @@ <h4 id="Topics"><a class="link" href="#Topics">4.3.26. <em>Topics</em> Topics</a
 </tbody>
 </table>
 <div class="paragraph">
-<p><em>Revised on 2024-12-22 06:54:08 UTC</em></p>
+<p><em>Revised on 2025-01-11 15:27:03 UTC</em></p>
 </div>
 </div>
 </div>

diff --git a/docs/bridge/in-development/full/bridge.html b/docs/bridge/in-development/full/bridge.html
@@ -668,7 +668,7 @@ <h3 id="overview-open-api-spec-kafka-bridge-bridge"><a class="link" href="#overv
 The download files are available from the <a href="https://github.com/strimzi/strimzi-kafka-bridge/releases" target="_blank" rel="noopener">GitHub release page</a>.</p>
 </div>
 <div class="paragraph">
-<p>You can also use the <a href="#openapi"><code>GET /openapi</code> method</a> to retrieve the OpenAPI v2 specification in JSON format.</p>
+<p>You can also use the <a href="#openapi"><code>GET /openapi</code> method</a> to retrieve the OpenAPI v3 specification in JSON format.</p>
 </div>
 <div class="ulist _additional-resources">
 <div class="title">Additional resources</div>
@@ -4488,7 +4488,7 @@ <h5 id="openapi"><a class="link" href="#openapi">openapi</a></h5>
 <div class="sect5">
 <h6 id="description_15"><a class="link" href="#description_15">Description</a></h6>
 <div class="paragraph">
-<p>Retrieves the OpenAPI v2 specification in JSON format.</p>
+<p>Retrieves the OpenAPI v3 specification in JSON format.</p>
 </div>
 </div>
 <div class="sect5">
@@ -4530,7 +4530,7 @@ <h6 id="responses_15"><a class="link" href="#responses_15">Responses</a></h6>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 specification in JSON format retrieved successfully.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v3 specification in JSON format retrieved successfully.</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#String">[String]</a></p></td>
 </tr>
 </tbody>
@@ -4549,7 +4549,7 @@ <h5 id="openapiv2"><a class="link" href="#openapiv2">openapiv2</a></h5>
 <div class="sect5">
 <h6 id="description_16"><a class="link" href="#description_16">Description</a></h6>
 <div class="paragraph">
-<p>Retrieves the OpenAPI v2 specification in JSON format.</p>
+<p>OpenAPI v2 Swagger not supported.</p>
 </div>
 </div>
 <div class="sect5">
@@ -4559,15 +4559,15 @@ <h6 id="parameters_16"><a class="link" href="#parameters_16">Parameters</a></h6>
 <div class="sect5">
 <h6 id="return_type_16"><a class="link" href="#return_type_16">Return Type</a></h6>
 <div class="paragraph">
-<p><a href="#String">[String]</a></p>
+<p>-</p>
 </div>
 </div>
 <div class="sect5">
 <h6 id="content_type_15"><a class="link" href="#content_type_15">Content Type</a></h6>
 <div class="ulist">
 <ul>
 <li>
-<p>application/json</p>
+<p>application/vnd.kafka.v2+json</p>
 </li>
 </ul>
 </div>
@@ -4590,9 +4590,9 @@ <h6 id="responses_16"><a class="link" href="#responses_16">Responses</a></h6>
 </thead>
 <tbody>
 <tr>
-<td class="tableblock halign-left valign-top"><p class="tableblock">200</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 specification in JSON format retrieved successfully.</p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#String">[String]</a></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">410</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">OpenAPI v2 Swagger not supported.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><a href="#Error"><em>Error</em> Error</a></p></td>
 </tr>
 </tbody>
 </table>
@@ -7958,7 +7958,7 @@ <h4 id="Topics"><a class="link" href="#Topics">4.3.26. <em>Topics</em> Topics</a
 </tbody>
 </table>
 <div class="paragraph">
-<p><em>Revised on 2024-12-22 06:54:08 UTC</em></p>
+<p><em>Revised on 2025-01-11 15:27:02 UTC</em></p>
 </div>
 </div>
 </div>
@@ -7967,7 +7967,7 @@ <h4 id="Topics"><a class="link" href="#Topics">4.3.26. <em>Topics</em> Topics</a
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-22 06:53:38 UTC
+Last updated 2025-01-11 15:26:32 UTC
 </div>
 </div>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.18.3/highlight.min.js"></script>