From 9c3eda7c6fa471e2b0eeffd1ea4905b0ba6a74fd Mon Sep 17 00:00:00 2001
From: Nir Gazit <nir.gzt@gmail.com>
Date: Tue, 19 Jan 2021 21:49:27 +0200
Subject: [PATCH] Added docs to config.d.ts

---
 plugins/kafka-backend/config.d.ts | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/plugins/kafka-backend/config.d.ts b/plugins/kafka-backend/config.d.ts
index 0eeeb42197..c1c415c502 100644
--- a/plugins/kafka-backend/config.d.ts
+++ b/plugins/kafka-backend/config.d.ts
@@ -15,8 +15,21 @@
  */
 export interface Config {
   kafka?: {
+    /**
+     * Client ID used to Backstage uses to identify when connecting to the Kafka cluster.
+     */
     clientId: string;
+    /**
+     * List of brokers in the Kafka cluster to connect to.
+     */
     brokers: string[];
+
+    /**
+     * Optional SSL connection parameters to connect to the cluster. Passed directly to Node tls.connect.
+     * See https://nodejs.org/dist/latest-v8.x/docs/api/tls.html#tls_tls_createsecurecontext_options
+     *
+     * @visibility secret
+     */
     ssl?: {
       ca: string[];
       key: string;