manifest-schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "id": "https://ktor.io/manifest.yaml.json",
  "properties": {
    "name": {
      "description": "The name of your plugin",
      "type": "string",
      "maxLength": 80,
      "minLength": 1
    },
    "description": {
      "description": "A one-line description of the plugin",
      "type": "string"
    },
    "vcsLink": {
      "description": "A URL pointing to the plugin repository",
      "type": "string"
    },
    "license": {
      "description": "A reference to software license used by the plugin",
      "type": "string",
      "maxLength": 50
    },
    "category": {
      "description": "Logical grouping for the plugin where it will be configured",
      "type": "string",
      "maxLength": 24,
      "enum": [
        "Administration",
        "Databases",
        "Frameworks",
        "HTTP",
        "Monitoring",
        "Routing",
        "Security",
        "Serialization",
        "Sockets",
        "Templating"
      ]
    },
    "prerequisites": {
      "description": "Plugin IDs that are also required along with this",
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "installation": {
      "description": "Mapping of installation snippets to be included in the generated project",
      "type": "object",
      "properties": {
        "default": {
          "description": "In category's install file",
          "type": "string"
        },
        "inside_app": {
          "description": "In Application.module() { ... } extension",
          "type": "string"
        },
        "outside_app": {
          "description": "After Application.module() { ... } extension",
          "type": "string"
        },
        "in_routing": {
          "description": "In a file, separate from Application.kt",
          "type": "string"
        },
        "serialization_config": {
          "description": "Serialization config inside install(ContentNegotiation) {...} block",
          "type": "string"
        },
        "call_logging_config": {
          "description": "CallLogging config inside install(CallLogging) {...} block",
          "type": "string"
        },
        "test_function": {
          "description": "In ApplicationTest.kt as a separate function",
          "type": "string"
        },
        "application_conf": {
          "description": "In application.conf file",
          "type": "string"
        },
        "application_yaml": {
          "description": "In application.yaml file",
          "type": "string"
        },
        "client": {
          "description": "In the installation of the HttpClient, in the client module",
          "type": "string"
        },
        "web": {
          "description": "In the main function of the web module, executed in the browser",
          "type": "string"
        },
        "outside_web": {
          "description": "Outside the main function of the web module",
          "type": "string"
        }
      }
    },
    "sources": {
      "description": "List of custom source file paths, with keywords in parentheses",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "([^ ]+\\.[a-z0-9]{1,5}) *(\\(([^)]+)\\))?"
      }
    },
    "resources": {
      "description": "List of custom source file paths, with keywords in parentheses",
      "type": "array",
      "items": {
        "type": "string",
        "pattern": "([^ ]+\\.[a-z0-9]{1,5}) *(\\(([^)]+)\\))?"
      }
    },
    "documentation": {
      "description": "Markdown string or file reference to populate the plugin details. Must include a 'Usage' header.",
      "type": "string"
    },
    "gradle": {
      "description": "Define custom gradle script injections required for your plugin.",
      "type": "object",
      "properties": {
        "disabled": {
          "description": "Indicates this plugin cannot be used with Gradle",
          "type": "boolean"
        },
        "repositories": {
          "description": "A list of repositories that will be included in the generated build script.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": {
                "type": "string"
              }
            }
          }
        },
        "plugins": {
          "description": "A list of gradle plugins that will be included in the generated build script.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "version": {
                "type": "string"
              }
            }
          }
        }
      }
    },
    "amper": {
      "description": "Settings for amper builds.",
      "properties": {
        "disabled": {
          "description": "Indicates this plugin cannot be used with Amper",
          "type": "boolean"
        }
      }
    },
    "maven": {
      "description": "Define custom maven script injections required for your plugin.",
      "type": "object",
      "properties": {
        "disabled": {
          "description": "Indicates this plugin cannot be used with Maven",
          "type": "boolean"
        },
        "repositories": {
          "description": "A list of repositories that will be included in the generated build script.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "url": {
                "type": "string"
              }
            }
          }
        },
        "plugins": {
          "description": "A list of gradle plugins that will be included in the generated build script.",
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "group": {
                "type": "string"
              },
              "artifact": {
                "type": "string"
              },
              "version": {
                "type": "string"
              },
              "extra": {
                "type": "string"
              }
            }
          }
        }
      }
    }
  },
  "required": ["name", "description", "vcsLink", "license", "category"],
  "additionalProperties": false,
  "title": "YAML schema for Ktor plugin manifests",
  "type": "object"
}