From 43aa2ea48174089a051c37d1d13250bd34db6131 Mon Sep 17 00:00:00 2001 From: ieQu1 <99872536+ieQu1@users.noreply.github.com> Date: Tue, 5 Apr 2022 10:32:24 +0200 Subject: [PATCH] docs(schema): Add documentation for license application --- lib-ee/emqx_license/src/emqx_license_schema.erl | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/lib-ee/emqx_license/src/emqx_license_schema.erl b/lib-ee/emqx_license/src/emqx_license_schema.erl index 8b280f55e..d6517ab88 100644 --- a/lib-ee/emqx_license/src/emqx_license_schema.erl +++ b/lib-ee/emqx_license/src/emqx_license_schema.erl @@ -12,7 +12,7 @@ -behaviour(hocon_schema). --export([roots/0, fields/1, validations/0]). +-export([roots/0, fields/1, validations/0, desc/1]). roots() -> [ @@ -40,7 +40,7 @@ fields(key_license) -> type => string(), %% so it's not logged sensitive => true, - desc => "Configure the license as a string" + desc => "License string" }} | common_fields() ]; @@ -53,6 +53,13 @@ fields(file_license) -> | common_fields() ]. +desc(key_license) -> + "License provisioned as a string."; +desc(file_license) -> + "License provisioned as a file."; +desc(_) -> + undefined. + common_fields() -> [ {connection_low_watermark, #{