docs(schema): Add documentation for license application

This commit is contained in:
ieQu1 2022-04-05 10:32:24 +02:00
parent 251192f84c
commit 43aa2ea481
1 changed files with 9 additions and 2 deletions

View File

@ -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, #{