From 1a82e3e5752bef4da02b86e2936be59860be5491 Mon Sep 17 00:00:00 2001 From: Ben Schumacher Date: Fri, 31 Jan 2020 21:36:14 +0100 Subject: [PATCH] Add documentation for number field for plugins (#13800) * Add example for release_notes_url * Add number field --- model/manifest.go | 6 ++++++ model/manifest_test.go | 8 ++++++++ 2 files changed, 14 insertions(+) diff --git a/model/manifest.go b/model/manifest.go index e693c19996..d6f7e09b34 100644 --- a/model/manifest.go +++ b/model/manifest.go @@ -34,6 +34,7 @@ const ( Radio Text LongText + Number Username Custom ) @@ -62,6 +63,8 @@ type PluginSetting struct { // // "longtext" will result in a multi line string that can be typed in manually. // + // "number" will result in in integer setting that can be typed in manually. + // // "username" will result in a text setting that will autocomplete to a username. // // "custom" will result in a custom defined setting and will load the custom component registered for the Web App System Console. @@ -108,6 +111,7 @@ type PluginSettingsSchema struct { // "description": "This is my plugin", // "homepage_url": "https://example.com", // "support_url": "https://example.com/support", +// "release_notes_url": "https://example.com/releases/v0.0.1", // "icon_path": "assets/logo.svg", // "version": "0.1.0", // "min_server_version": "5.6.0", @@ -414,6 +418,8 @@ func convertTypeToPluginSettingType(t string) (PluginSettingType, error) { return Radio, nil case "text": return Text, nil + case "number": + return Number, nil case "longtext": return LongText, nil case "username": diff --git a/model/manifest_test.go b/model/manifest_test.go index adb51bd9ec..e86179a01e 100644 --- a/model/manifest_test.go +++ b/model/manifest_test.go @@ -131,6 +131,14 @@ func TestSettingIsValid(t *testing.T) { Value: "value", }, }}, false}, + { + "Valid number setting", + &PluginSetting{ + Type: "number", + Default: 10, + }, + false, + }, } for _, tc := range testCases {