Paper paper-plugin.yml

Paper Plugins YAML

paper-plugin.yml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your paper-plugin.yml and it validates in your browser — nothing is uploaded.

Validate a paper-plugin.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`name`required	`string`	—
`main`required	`string`	—
`bootstrapper`	`string`	—
`loader`	`string`	—
`provides`	`array`	Satisfies dependency requirements as this plugin. When resolving dependencies, if a plugin requires a plugin in this list, this plugin will satisfy it.
`has-open-classloader`	`boolean`	Whether the plugin should have its classloader public to other paper plugins
`version`required	`string`	The version of the plugin
`description`	`string`	The description of the plugin
`authors`	`array<string>`	Main authors of the plugin
`contributors`	`array<string>`	Other contributors to the plugin
`website`	`string`	Plugin website
`prefix`	`string`	Log prefix for this plugin. Defaults to the plugin name
`load`	`enum`	When to load this plugin. Defaults to POSTWORLD. one of: `"STARTUP", "POSTWORLD"`
`default-perm`	`enum`	— one of: `"true", true, "false", false, "op", "not op"`
`permissions`	`any`	Permissions for this plugin
`api-version`required	`string`	The API version of the plugin
`dependencies`	`object`	Plugin dependencies.
`dependencies.bootstrap`	`object`	—
`dependencies.server`	`object`	—

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
Has 3 place(s) where keywords sit beside $ref. Under draft-07 those keywords are silently ignored by every conforming validator — first at #/properties/main.
25 properties, 92% carrying a description, max nesting depth 10.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$ref`	JSON Schema Core, draft 2020-12	§8.2.3.1 — Direct References with "$ref"
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`oneOf`	JSON Schema Core, draft 2020-12	§10.2.1.3 — "oneOf"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"
`uniqueItems`	JSON Schema Validation, draft 2020-12	§6.4.3 — "uniqueItems"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas