Metadata
Every plugin has a metadata.json file at its root. The file describes the plugin and controls how it appears in the catalog.
The core fields (name, displayName, description, category, author, and icon) are set when you export from the UI. The remaining fields (notably links, keywords, and any adjustments to base.config) must be added or edited manually in the JSON after export.
Example
{
"name": "my-plugin",
"displayName": "My Plugin",
"version": "1.0.0",
"schemaVersion": "2.0",
"category": "SquaredUp Internal",
"type": "cloud",
"author": {
"type": "community",
"name": "your-github-username"
},
"base": {
"plugin": "WebAPI",
"majorVersion": "1",
"config": {}
},
"links": [
{ "category": "documentation", "url": "https://github.com/squaredup/plugins/blob/main/plugins/MyPlugin/v1/docs/README.md", "label": "Help adding this plugin" },
{ "category": "source", "url": "https://github.com/squaredup/plugins/tree/main/plugins/MyPlugin/v1", "label": "Repository" }
],
"keywords": ["monitoring", "alerts", "myservice"]
}