MM-13852 Migrate example manifest to JSON (#10197)

* Migrate example manifest to JSON

* Changes as requested
Этот коммит содержится в:
Hanzei
2019-01-29 16:55:58 +01:00
коммит произвёл Christopher Speller
родитель 58ef6853f1
Коммит 8e44f38499

Просмотреть файл

@@ -84,20 +84,40 @@ type PluginSettingsSchema struct {
// file should be named plugin.json or plugin.yaml and placed in the top of your // file should be named plugin.json or plugin.yaml and placed in the top of your
// plugin bundle. // plugin bundle.
// //
// Example plugin.yaml: // Example plugin.json:
// //
// id: com.mycompany.myplugin //
// name: My Plugin // {
// description: This is my plugin. It does stuff. // "id": "com.mycompany.myplugin",
// server: // "name": "My Plugin",
// executable: myplugin // "description": "This is my plugin",
// settings_schema: // "version": "0.1.0",
// settings: // "min_server_version": "5.6.0",
// - key: enable_extra_thing // "server": {
// type: bool // "executables": {
// display_name: Enable Extra Thing // "linux-amd64": "server/dist/plugin-linux-amd64",
// help_text: When true, an extra thing will be enabled! // "darwin-amd64": "server/dist/plugin-darwin-amd64",
// default: false // "windows-amd64": "server/dist/plugin-windows-amd64.exe"
// }
// },
// "webapp": {
// "bundle_path": "webapp/dist/main.js"
// },
// "settings_schema": {
// "header": "Some header text",
// "footer": "Some footer text",
// "settings": [{
// "key": "someKey",
// "display_name": "Enable Extra Feature",
// "type": "bool",
// "help_text": "When true, an extra feature will be enabled!",
// "default": "false"
// }]
// },
// "props": {
// "someKey": "someData"
// }
// }
type Manifest struct { type Manifest struct {
// The id is a globally unique identifier that represents your plugin. Ids must be at least // The id is a globally unique identifier that represents your plugin. Ids must be at least
// 3 characters, at most 190 characters and must match ^[a-zA-Z0-9-_\.]+$. // 3 characters, at most 190 characters and must match ^[a-zA-Z0-9-_\.]+$.