Update JSON schemas for all plugins (#1328)

- Update JSON schemas for all plugins - Add password format for credentials - Ensure `log` is exposed everywhere - Ensure `additionalProperties` are enabled for plugins with more complex data - Unify JSON schema definition across all plugins
kubeshop · Dec 6, 2023 · b920662 · b920662
1 parent aec0dd9
commit b920662
Show file tree

Hide file tree

Showing 37 changed files with 1,047 additions and 676 deletions.
diff --git a/cmd/executor/echo/config_schema.json b/cmd/executor/echo/config_schema.json
@@ -0,0 +1,14 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Echo",
+  "description": "Echo is an example Botkube executor plugin used during e2e tests. It's not meant for production usage.",
+  "type": "object",
+  "properties": {
+    "changeResponseToUpperCase": {
+      "description": "When changeResponseToUpperCase is true, the echoed string will be in upper case",
+      "type": "boolean",
+      "default": false
+    }
+  },
+  "required": []
+}
diff --git a/cmd/executor/echo/main.go b/cmd/executor/echo/main.go
@@ -2,20 +2,25 @@ package main
 
 import (
 	"context"
+	_ "embed"
 	"errors"
 	"fmt"
 	"strings"
 
-	"github.com/MakeNowJust/heredoc"
 	"github.com/hashicorp/go-plugin"
 
 	"github.com/kubeshop/botkube/pkg/api"
 	"github.com/kubeshop/botkube/pkg/api/executor"
 	"github.com/kubeshop/botkube/pkg/pluginx"
 )
 
-// version is set via ldflags by GoReleaser.
-var version = "dev"
+var (
+	// version is set via ldflags by GoReleaser.
+	version = "dev"
+
+	//go:embed config_schema.json
+	configJSONSchema string
+)
 
 const (
 	pluginName  = "echo"
@@ -37,7 +42,9 @@ func (*EchoExecutor) Metadata(context.Context) (api.MetadataOutput, error) {
 	return api.MetadataOutput{
 		Version:     version,
 		Description: description,
-		JSONSchema:  jsonSchema(),
+		JSONSchema: api.JSONSchema{
+			Value: configJSONSchema,
+		},
 	}, nil
 }
 
@@ -79,21 +86,3 @@ func main() {
 		},
 	})
 }
-
-func jsonSchema() api.JSONSchema {
-	return api.JSONSchema{
-		Value: heredoc.Docf(`{
-			"$schema": "http://json-schema.org/draft-07/schema#",
-			"title": "botkube/echo",
-			"description": "%s",
-			"type": "object",
-			"properties": {
-				"changeResponseToUpperCase": {
-					"description": "When changeResponseToUpperCase is true, the echoed string will be in upper case",
-					"type": "boolean"
-				}
-			},
-			"required": []
-		}`, description),
-	}
-}
diff --git a/cmd/executor/exec/main.go b/cmd/executor/exec/main.go
@@ -55,7 +55,9 @@ func (*XExecutor) Metadata(context.Context) (api.MetadataOutput, error) {
 		Version:      version,
 		Description:  "Install and run CLIs directly from chat window without hassle. All magic included.",
 		Dependencies: x.GetPluginDependencies(),
-		JSONSchema:   jsonSchema(),
+		JSONSchema: api.JSONSchema{
+			Value: heredoc.Docf(x.ConfigJSONSchemaFmt, getDefaultTemplateSource()),
+		},
 	}, nil
 }
 
@@ -205,43 +207,6 @@ func main() {
 	})
 }
 
-// jsonSchema returns JSON schema for the executor.
-func jsonSchema() api.JSONSchema {
-	return api.JSONSchema{
-		Value: heredoc.Docf(`{
-		  "$schema": "http://json-schema.org/draft-07/schema#",
-		  "title": "exec",
-		  "description": "Install and run CLIs directly from the chat window without hassle. All magic included.",
-		  "type": "object",
-		  "properties": {
-			"templates": {
-			  "type": "array",
-			  "title": "List of templates",
-			  "description": "An array of templates that define how to convert the command output into an interactive message.",
-			  "items": {
-				"type": "object",
-				"properties": {
-				  "ref": {
-					"title": "Link to templates source",
-					"description": "It uses the go-getter library, which supports multiple URL formats (such as HTTP, Git repositories, or S3) and is able to unpack archives. For more details, see the documentation at https://github.com/hashicorp/go-getter.",
-					"type": "string",
-					"default": "%s"
-				  }
-				},
-				"required": [
-				  "ref"
-				],
-				"additionalProperties": false
-			  }
-			}
-		  },
-		  "required": [
-			"templates"
-		  ]
-		}`, getDefaultTemplateSource()),
-	}
-}
-
 func getDefaultTemplateSource() string {
 	ver := version
 	if ver == "dev" {

diff --git a/cmd/executor/gh/config_schema.json b/cmd/executor/gh/config_schema.json
@@ -0,0 +1,102 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "GH",
+  "description": "GH creates an issue on GitHub for a related Kubernetes resource.",
+  "type": "object",
+  "additionalProperties": false,
+  "uiSchema": {
+    "github": {
+      "issueTemplate": {
+        "ui:widget": "textarea"
+      },
+      "token": {
+        "ui:widget": "password"
+      }
+    }
+  },
+  "properties": {
+    "github": {
+      "description": "GitHub-related configuration",
+      "title": "GitHub configuration",
+      "type": "object",
+      "properties": {
+        "token": {
+          "description": "GitHub Personal Access Token",
+          "title": "GitHub Token",
+          "type": "string",
+          "minLength": 3,
+          "default": ""
+        },
+        "issueTemplate": {
+          "description": "Issue template to use. If not specified, the default one will be used.",
+          "title": "Issue Template",
+          "type": "string",
+          "default": ""
+        },
+        "repository": {
+          "type": "string",
+          "title": "Repository",
+          "description": "GitHub repository to create issues in. Must be in the format of 'owner/repo'.",
+          "minLength": 3,
+          "default": ""
+        }
+      },
+      "required": [
+        "token",
+        "repository"
+      ]
+    },
+    "log": {
+      "title": "Logging",
+      "description": "Logging configuration for the plugin.",
+      "type": "object",
+      "properties": {
+        "level": {
+          "title": "Log Level",
+          "description": "Define log level for the plugin. Ensure that Botkube has plugin logging enabled for standard output.",
+          "type": "string",
+          "default": "info",
+          "oneOf": [
+            {
+              "const": "panic",
+              "title": "Panic"
+            },
+            {
+              "const": "fatal",
+              "title": "Fatal"
+            },
+            {
+              "const": "error",
+              "title": "Error"
+            },
+            {
+              "const": "warn",
+              "title": "Warning"
+            },
+            {
+              "const": "info",
+              "title": "Info"
+            },
+            {
+              "const": "debug",
+              "title": "Debug"
+            },
+            {
+              "const": "trace",
+              "title": "Trace"
+            }
+          ]
+        },
+        "disableColors": {
+          "type": "boolean",
+          "default": false,
+          "description": "If enabled, disables color logging output.",
+          "title": "Disable Colors"
+        }
+      }
+    }
+  },
+  "required": [
+    "github"
+  ]
+}
diff --git a/cmd/executor/gh/main.go b/cmd/executor/gh/main.go
@@ -3,12 +3,12 @@ package main
 import (
 	"bytes"
 	"context"
+	_ "embed"
 	"fmt"
 	"text/template"
 
 	"github.com/hashicorp/go-plugin"
 
-	"github.com/kubeshop/botkube/internal/cli/heredoc"
 	"github.com/kubeshop/botkube/internal/loggerx"
 	"github.com/kubeshop/botkube/pkg/api"
 	"github.com/kubeshop/botkube/pkg/api/executor"
@@ -24,8 +24,13 @@ const (
 	description      = "GH creates an issue on GitHub for a related Kubernetes resource."
 )
 
-// version is set via ldflags by GoReleaser.
-var version = "dev"
+var (
+	// version is set via ldflags by GoReleaser.
+	version = "dev"
+
+	//go:embed config_schema.json
+	configJSONSchema string
+)
 
 // Config holds the GitHub executor configuration.
 type Config struct {
@@ -57,10 +62,13 @@ type GHExecutor struct{}
 // Metadata returns details about the GitHub plugin.
 func (*GHExecutor) Metadata(context.Context) (api.MetadataOutput, error) {
 	return api.MetadataOutput{
-		Version:      version,
-		Description:  description,
-		Dependencies: depsDownloadLinks,
-		JSONSchema:   jsonSchema(),
+		Version:          version,
+		Description:      description,
+		Dependencies:     depsDownloadLinks,
+		DocumentationURL: "https://botkube.io/blog/build-a-github-issues-reporter-for-failing-kubernetes-apps-with-botkube-plugins",
+		JSONSchema: api.JSONSchema{
+			Value: configJSONSchema,
+		},
 	}, nil
 }
 
@@ -239,105 +247,3 @@ func renderIssueBody(bodyTpl string, data IssueDetails) (string, error) {
 
 	return body.String(), nil
 }
-
-func jsonSchema() api.JSONSchema {
-	return api.JSONSchema{
-		Value: heredoc.Docf(`{
-		  "$schema": "http://json-schema.org/draft-07/schema#",
-		  "title": "botkube/gh",
-		  "description": "%s",
-		  "type": "object",
-		  "additionalProperties": false,
-		  "uiSchema": {
-			"github": {
-			  "issueTemplate": {
-				"ui:widget": "textarea"
-			  }
-			}
-		  },
-		  "properties": {
-			"github": {
-			  "description": "GitHub-related configuration",
-			  "title": "GitHub configuration",
-			  "type": "object",
-			  "properties": {
-				"token": {
-				  "description": "GitHub Personal Access Token",
-				  "title": "GitHub Token",
-				  "type": "string",
-				  "minLength": 1
-				},
-				"issueTemplate": {
-				  "description": "Issue template to use. If not specified, the default one will be used.",
-				  "title": "Issue Template",
-				  "type": "string",
-				  "default": ""
-				},
-				"repository": {
-				  "type": "string",
-				  "title": "Repository",
-				  "description": "GitHub repository to create issues in. Must be in the format of 'owner/repo'.",
-				  "minLength": 1
-				}
-			  },
-			  "required": [
-				"token",
-				"repository"
-			  ]
-			},
-			"log": {
-			  "title": "Logging",
-			  "description": "Logging configuration for the plugin.",
-			  "type": "object",
-			  "properties": {
-				"level": {
-				  "title": "Log Level",
-				  "description": "Define log level for the plugin. Ensure that Botkube has plugin logging enabled for standard output.",
-				  "type": "string",
-				  "default": "info",
-				  "oneOf": [
-					{
-					  "const": "panic",
-					  "title": "Panic"
-					},
-					{
-					  "const": "fatal",
-					  "title": "Fatal"
-					},
-					{
-					  "const": "error",
-					  "title": "Error"
-					},
-					{
-					  "const": "warn",
-					  "title": "Warning"
-					},
-					{
-					  "const": "info",
-					  "title": "Info"
-					},
-					{
-					  "const": "debug",
-					  "title": "Debug"
-					},
-					{
-					  "const": "trace",
-					  "title": "Trace"
-					}
-				  ]
-				},
-				"disableColors": {
-				  "type": "boolean",
-				  "default": false,
-				  "description": "If enabled, disables color logging output.",
-				  "title": "Disable Colors"
-				}
-			  }
-			}
-		  },
-		  "required": [
-			"github"
-		  ]
-		}`, description),
-	}
-}
diff --git a/cmd/executor/thread-mate/main.go b/cmd/executor/thread-mate/main.go
@@ -37,7 +37,7 @@ func (*ThreadMateExecutor) Metadata(context.Context) (api.MetadataOutput, error)
 		Version:     version,
 		Description: "Streamlines managing assignment for incidents or user support",
 		JSONSchema: api.JSONSchema{
-			Value: thmate.JSONSchema,
+			Value: thmate.ConfigJSONSchema,
 		},
 	}, nil
 }