From 319530ddf29d0ea3039f04cc521f82920d655d2b Mon Sep 17 00:00:00 2001
From: zmstone <zmstone@gmail.com>
Date: Wed, 31 Jul 2024 08:46:15 +0200
Subject: [PATCH] chore(gssapi): refine schema doc

---
 .../src/emqx_authn_gssapi_schema.erl           |  4 ++--
 rel/i18n/emqx_authn_gssapi_schema.hocon        | 18 ++++++++++++++++++
 rel/i18n/emqx_bridge_kafka.hocon               |  2 +-
 3 files changed, 21 insertions(+), 3 deletions(-)
 create mode 100644 rel/i18n/emqx_authn_gssapi_schema.hocon

diff --git a/apps/emqx_auth_gssapi/src/emqx_authn_gssapi_schema.erl b/apps/emqx_auth_gssapi/src/emqx_authn_gssapi_schema.erl
index 267c75676..f0b72a3ec 100644
--- a/apps/emqx_auth_gssapi/src/emqx_authn_gssapi_schema.erl
+++ b/apps/emqx_auth_gssapi/src/emqx_authn_gssapi_schema.erl
@@ -42,12 +42,12 @@ fields(gssapi) ->
             {principal,
                 ?HOCON(binary(), #{
                     required => true,
-                    desc => ?DESC(emqx_bridge_kafka, auth_kerberos_principal)
+                    desc => ?DESC(principal)
                 })},
             {keytab_file,
                 ?HOCON(binary(), #{
                     required => true,
-                    desc => ?DESC(emqx_bridge_kafka, auth_kerberos_keytab_file)
+                    desc => ?DESC(keytab_file)
                 })}
         ].
 
diff --git a/rel/i18n/emqx_authn_gssapi_schema.hocon b/rel/i18n/emqx_authn_gssapi_schema.hocon
new file mode 100644
index 000000000..02c3cc847
--- /dev/null
+++ b/rel/i18n/emqx_authn_gssapi_schema.hocon
@@ -0,0 +1,18 @@
+emqx_authn_gssapi_schema {
+
+principal {
+    label: "Kerberos Principal"
+    desc: """~
+        SASL GSSAPI authentication Kerberos principal.
+        For example <code>mqtt/node1.example.com@MY_REALM.EXAMPLE.COM</code>.
+        NOTE: The realm in use has to be configured in /etc/krb5.conf in EMQX nodes.~"""
+}
+
+keytab_file {
+    label: "keytab file"
+    desc: """~
+        SASL GSSAPI authentication Kerberos keytab file path.
+        NOTE: This file has to be placed in EMQX nodes.~"""
+}
+
+}
diff --git a/rel/i18n/emqx_bridge_kafka.hocon b/rel/i18n/emqx_bridge_kafka.hocon
index f63e6f3eb..6f02b64b7 100644
--- a/rel/i18n/emqx_bridge_kafka.hocon
+++ b/rel/i18n/emqx_bridge_kafka.hocon
@@ -147,7 +147,7 @@ consumer_mqtt_opts.label:
 """MQTT publish"""
 
 auth_kerberos_principal.desc:
-"""SASL GSSAPI authentication Kerberos principal. For example <code>client_name@MY.KERBEROS.REALM.MYDOMAIN.COM</code>, NOTE: The realm in use has to be configured in /etc/krb5.conf in EMQX nodes."""
+"""SASL GSSAPI authentication Kerberos principal. For example <code>kafka/node1.example.com@EXAMPLE.COM</code>, NOTE: The realm in use has to be configured in /etc/krb5.conf in EMQX nodes."""
 
 auth_kerberos_principal.label:
 """Kerberos Principal"""